FunPayAPI

https://funpayapi.readthedocs.io/ru/latest
Admin
FunPayAPI is an unofficial implementation of a layer between the FunPay API and a client, providing...
Tokens:53,333
Snippets:320
Trust Score:8.3
Update:2 days ago
Show doc for...
Tokens:
Raw
### Account.method

Source: https://funpayapi.readthedocs.io/ru/latest/account.html

Отправляет запрос к FunPay, добавляя в заголовки user_agent и куки. Позволяет выполнять GET и POST запросы к API FunPay.

```APIDOC
## Account.method

### Description
Отправляет запрос к FunPay. Добавляет в заголовки запроса user_agent и куки.

### Method
POST или GET (определяется параметром request_method)

### Parameters
#### Request Parameters
- **request_method** (str) - Required - Метод запроса: 'post' или 'get'.
- **api_method** (str) - Required - Метод API или полная ссылка.
- **headers** (dict) - Required - Заголовки запроса.
- **payload** (Any) - Required - Полезная нагрузка.
- **exclude_phpsessid** (bool) - Optional - Исключить ли PHPSESSID из добавляемых куки? По умолчанию False.
- **raise_not_200** (bool) - Optional - Возбуждать ли исключение, если статус код ответа != 200? По умолчанию False.

### Response
#### Success Response
- **Response** (requests.Response) - Объект ответа.

#### Response Example
```
<Response [200]>
```
```

--------------------------------

### Клонирование Git репозитория и установка

Source: https://funpayapi.readthedocs.io/ru/latest/install.html

Клонирует репозиторий FunPayAPI с GitHub, переходит в каталог и устанавливает пакет с помощью setup.py.

```bash
$ git clone https://github.com/woopertail/FunPayAPI.git
$ cd FunPayAPI
$ python setup.py install
```

--------------------------------

### get_raise_modal

Source: https://funpayapi.readthedocs.io/ru/latest/account.html

Sends a request to get the modal form for raising lots of a category (game). Note: If the account has only one subcategory related to the passed category, FunPay will raise the lots of that subcategory without sending the modal form.

```APIDOC
## get_raise_modal

### Description
Sends a request to get the modal form for raising lots of a category (game).

### Method
get_raise_modal

### Signature
get_raise_modal(category_id: int) -> dict

### Parameters
- **category_id** (int) - Required - ID of the category (game).

### Returns
- **dict** - FunPay response.
```

--------------------------------

### Прямая установка через pip из Git

Source: https://funpayapi.readthedocs.io/ru/latest/install.html

Устанавливает FunPayAPI напрямую из Git-репозитория с помощью pip.

```bash
$ pip install git+https://github.com/woopertail/FunPayAPI.git
```

--------------------------------

### SubCategory.__init__(id_, name, type_, category)

Source: https://funpayapi.readthedocs.io/ru/latest/types.html

Constructor for the SubCategory class.

```APIDOC
## SubCategory.__init__(id_, name, type_, category)

### Description
Initializes a new SubCategory instance.

### Method
__init__

### Parameters
- **id_** (int) - Required - The subcategory ID.
- **name** (str) - Required - The subcategory name.
- **type_** (SubCategoryTypes) - Required - The subcategory type.
- **category** (Category) - Required - The parent category.

### Returns
None
```

--------------------------------

### InitialOrderEvent

Source: https://funpayapi.readthedocs.io/ru/latest/events.html

Класс события, возникающий при обнаружении заказа при первом запросе Runner'а. Содержит тег Runner'а и объект заказа.

```APIDOC
## InitialOrderEvent

### Description
Класс события: обнаружен заказ при первом запросе Runner’а.

### Constructor Parameters
- **runner_tag** (str) - Тег Runner’а.
- **order_obj** (OrderShortcut) - Объект обнаруженного заказа.

### Attributes
- **order_** (OrderShortcut) - Объект обнаруженного заказа.
```

--------------------------------

### Runner.listen

Source: https://funpayapi.readthedocs.io/ru/latest/runner.html

Бесконечно отправляет запросы для получения новых событий FunPay. Возвращает генератор событий.

```APIDOC
## Runner.listen

### Description
Бесконечно отправляет запросы для получения новых событий FunPay. Возвращает генератор событий.

### Method
listen

### Signature
listen(requests_delay: int | float = 6.0, ignore_exceptions: bool = True) -> Generator[InitialChatEvent | ChatsListChangedEvent | LastChatMessageChangedEvent | NewMessageEvent | InitialOrderEvent | OrdersListChangedEvent | NewOrderEvent | OrderStatusChangedEvent]

### Parameters
- **requests_delay** (int | float) - Optional - Задержка между запросами (в секундах).
- **ignore_exceptions** (bool) - Optional - Игнорировать ошибки?

### Returns
Генератор событий FunPay.

### Return Type
Generator of InitialChatEvent, ChatsListChangedEvent, LastChatMessageChangedEvent, NewMessageEvent, InitialOrderEvent, OrdersListChangedEvent, NewOrderEvent, OrderStatusChangedEvent
```

--------------------------------

### Установка через pipenv

Source: https://funpayapi.readthedocs.io/ru/latest/install.html

Устанавливает FunPayAPI с помощью pipenv, менеджера пакетов для виртуальных окружений Python.

```bash
$ pipenv install FunPayAPI
```

--------------------------------

### upload_image

Source: https://funpayapi.readthedocs.io/ru/latest/account.html

Выгружает изображение на сервер FunPay для дальнейшей отправки в качестве сообщения. Для отправки изображения в чат рекомендуется использовать метод send_image().

```APIDOC
## upload_image

### Description
Выгружает изображение на сервер FunPay для дальнейшей отправки в качестве сообщения. Для отправки изображения в чат рекомендуется использовать метод send_image().

### Method
SDK Method

### Endpoint
FunPayAPI.account.Account.upload_image

### Parameters
#### Path Parameters
- **image** (str | bytes) - Required - Путь до изображения или представление изображения в виде байтов.

### Response
#### Success Response
- **int** - ID изображения на серверах FunPay.

#### Response Example
123456
```

--------------------------------

### FunPayAPI.updater.runner.Runner

Source: https://funpayapi.readthedocs.io/ru/latest/runner.html

Class for receiving new FunPay events. Initialize with an Account instance and optional flags to disable message or order requests.

```APIDOC
## FunPayAPI.updater.runner.Runner

### Description
Класс для получения новых событий FunPay.

### Constructor
`Runner(account: Account, disable_message_requests: bool = False, disabled_order_requests: bool = False)`

### Parameters
- **account** (Account) - Required - Экземпляр аккаунта (должен быть инициализирован с помощью метода `Account.get()`).
- **disable_message_requests** (bool) - Optional - Отключить ли запросы для получения истории чатов? Если True, `listen()` не будет возвращать события `NewMessageEvent`. Из событий, связанных с чатами, будут возвращаться только: `InitialChatEvent`, `ChatsListChangedEvent`, `LastChatMessageChangedEvent`.
- **disabled_order_requests** (bool) - Optional - Отключить ли запросы для получения списка заказов? Если True, `listen()` не будет возвращать события `InitialOrderEvent`, `NewOrderEvent`, `OrderStatusChangedEvent`. Из событий, связанных с заказами, будет возвращаться только `OrdersListChangedEvent`.

### Attributes
- **make_msg_requests_** (bool) - Делать ли доп. запросы для получения всех новых сообщений изменившихся чатов?
- **make_order_requests_** (bool) - Делать ли доп запросы для получения все новых / изменившихся заказов?
- **saved_orders_** (dict[str, types.OrderShortcut]) - Сохраненные состояния заказов ({ID заказа: экземпляр types.OrderShortcut}).
```

--------------------------------

### Установка через pip

Source: https://funpayapi.readthedocs.io/ru/latest/install.html

Устанавливает FunPayAPI с помощью менеджера пакетов pip. Рекомендуемый способ установки.

```bash
$ pip install FunPayAPI
```

--------------------------------

### raise_lots

Source: https://funpayapi.readthedocs.io/ru/latest/account.html

Поднимает все лоты всех подкатегорий переданной категории (игры). Возвращает True при успешном выполнении.

```APIDOC
## raise_lots

### Description
Поднимает все лоты всех подкатегорий переданной категории (игры).

### Method
raise_lots

### Parameters
- **category_id** (int) - Required - ID категории (игры).
- **subcategories** (list of int or FunPayAPI.types.SubCategory) - Optional - Список подкатегорий, которые необходимо поднять. Если не указаны, поднимутся все подкатегории переданной категории.
- **exclude** (list of int) - Optional - ID подкатегорий, которые не нужно поднимать.

### Returns
- **bool** - True при успешном выполнении.
```

--------------------------------

### Account.get

Source: https://funpayapi.readthedocs.io/ru/latest/account.html

Получает или обновляет данные об аккаунте. Рекомендуется вызывать каждые 40-60 минут для обновления PHPSESSID.

```APIDOC
## Account.get

### Description
Получает / обновляет данные об аккаунте. Необходимо вызывать каждые 40-60 минут, дабы обновить Account.phpsessid.

### Method
GET (внутренний запрос к FunPay)

### Parameters
#### Request Parameters
- **update_phpsessid** (bool) - Optional - Обновить Account.phpsessid или использовать старый. По умолчанию False.

### Response
#### Success Response
- **Account** (FunPayAPI.account.Account) - Объект аккаунта с обновленными данными.

#### Response Example
```
<FunPayAPI.account.Account object>
```
```

--------------------------------

### Runner.get_updates()

Source: https://funpayapi.readthedocs.io/ru/latest/runner.html

Запрашивает список событий FunPay. Возвращает ответ FunPay в виде словаря.

```APIDOC
## Runner.get_updates()

### Description
Запрашивает список событий FunPay.

### Method
GET

### Endpoint
Не указан (метод класса Python)

### Parameters
Нет

### Response
#### Success Response
- **dict** - ответ FunPay.

#### Response Example
{
  "example": "response body"
}
```

--------------------------------

### Обновление FunPayAPI

Source: https://funpayapi.readthedocs.io/ru/latest/install.html

Обновляет установленный пакет FunPayAPI до последней версии. Рекомендуется выполнять регулярно, так как библиотека находится в стадии разработки.

```bash
$ pip install FunPayAPI --upgrade
```

--------------------------------

### send_image

Source: https://funpayapi.readthedocs.io/ru/latest/account.html

Отправляет изображение в чат FunPay. Доступно только для личных чатов. Принимает ID чата, изображение (ID, путь или байты) и опциональные параметры.

```APIDOC
## send_image

### Description
Отправляет изображение в чат FunPay. Доступно только для личных чатов.

### Method
SDK method

### Endpoint
FunPayAPI.account.Account.send_image

### Parameters
- **chat_id** (int) - Required - ID чата.
- **image** (int or str or bytes) - Required - ID изображения / путь до изображения / изображение в виде байтов. Если передан путь до изображения или представление изображения в виде байтов, сначала оно будет выгружено с помощью метода FunPayAPI.account.Account.upload_image().
- **chat_name** (str or None, optional) - Название чата (никнейм собеседника). Нужен для возвращаемого объекта.
- **add_to_ignore_list** (bool, optional) - Добавлять ли ID отправленного сообщения в игнорируемый список Runner’а?
- **update_last_saved_message** (bool, optional) - Обновлять ли последнее сохраненное сообщение на отправленное в Runner’е?

### Returns
- **Message** - объект отправленного сообщения.

```

--------------------------------

### get_balance

Source: https://funpayapi.readthedocs.io/ru/latest/account.html

Получает информацию о балансе пользователя.

```APIDOC
## get_balance

### Description
Получает информацию о балансе пользователя.

### Method
Python method

### Signature
`get_balance(lot_id: int = 18853876) -> Balance`

### Parameters
- **lot_id** (int) - Optional - ID лота, на котором проверять баланс. По умолчанию 18853876.

### Returns
- **FunPayAPI.types.Balance** - Информация о балансе пользователя.

```

--------------------------------

### LotFields.renew_fields()

Source: https://funpayapi.readthedocs.io/ru/latest/types.html

Обновляет __fields (возвращается в методе get_fields()), основываясь на свойствах экземпляра. Необходимо вызвать перед сохранением лота на FunPay после изменения любого свойства экземпляра.

```APIDOC
## LotFields.renew_fields()

### Description
Обновляет __fields (возвращается в методе FunPayAPI.types.LotFields.get_fields()), основываясь на свойствах экземпляра. Необходимо вызвать перед сохранением лота на FunPay после изменения любого свойства экземпляра.

### Returns
- **LotFields** - экземпляр класса FunPayAPI.types.LotFields с новыми полями лота.

```

--------------------------------

### get_lot_fields

Source: https://funpayapi.readthedocs.io/ru/latest/account.html

Получает все поля лота по его ID.

```APIDOC
## get_lot_fields

### Description
Получает все поля лота.

### Method
GET

### Endpoint
`get_lot_fields(lot_id: int) -> LotFields`

### Parameters
- **lot_id** (int) - Required - ID лота.

### Response
#### Success Response
- **LotFields** - объект с полями лота.

#### Response Example
```json
{
  "lot_fields": {}
}
```
```

--------------------------------

### mark_as_by_bot

Source: https://funpayapi.readthedocs.io/ru/latest/runner.html

Помечает сообщение как отправленное ботом.

```APIDOC
## mark_as_by_bot

### Description
Помечает сообщение как отправленное ботом.

### Method
mark_as_by_bot

### Parameters
#### Path Parameters
- **chat_id** (int) - Required - ID чата.
- **message_id** (int) - Required - ID сообщения.

```

--------------------------------

### get_sells

Source: https://funpayapi.readthedocs.io/ru/latest/account.html

Получает и парсит список заказов со страницы https://funpay.com/orders/trade. Поддерживает фильтрацию по ID заказа, покупателю, статусу, игре, категории, серверу и стороне.

```APIDOC
## get_sells

### Description
Получает и парсит список заказов со страницы https://funpay.com/orders/trade

### Method
SDK Method

### Endpoint
FunPayAPI.account.Account.get_sells

### Parameters
#### start_from (str | None) - Optional
ID заказа, с которого начать список (ID заказа должен быть без "#"!).

#### include_paid (bool) - Optional
Включить ли в список заказы, ожидающие выполнения?

#### include_closed (bool) - Optional
Включить ли в список закрытые заказы?

#### include_refunded (bool) - Optional
Включить ли в список заказы, за которые запрошен возврат средств?

#### exclude_ids (list[str] | None) - Optional
Исключить заказы с ID из списка (ID заказа должен быть без "#"!).

#### id (int | None) - Optional
ID заказа.

#### buyer (str | None) - Optional
Никнейм покупателя.

#### state (Literal['closed', 'paid', 'refunded'] | None) - Optional
Статус заказа.

#### game (int | None) - Optional
ID игры.

#### section (str | None) - Optional
ID категории в формате <тип лота>-<ID категории>. Типы лотов: lot - стандартный лот (например: lot-256), chip - игровая валюта (например: chip-4471).

#### server (int | None) - Optional
ID сервера.

#### side (int | None) - Optional
ID стороны (платформы).

### Returns
tuple[str | None, list[FunPayAPI.types.OrderShortcut]]

```

--------------------------------

### subcategories (property)

Source: https://funpayapi.readthedocs.io/ru/latest/account.html

Возвращает все подкатегории FunPay в виде списка. Подкатегории парсятся при первом выполнении метода Account.get().

```APIDOC
## subcategories (property)

### Description
Возвращает все подкатегории FunPay в виде списка. Подкатегории парсятся при первом выполнении метода Account.get().

### Method
GET

### Endpoint
FunPayAPI.account.Account.subcategories

### Parameters
Нет параметров.

### Response
#### Success Response
- **list[FunPayAPI.types.SubCategory]** - Список всех подкатегорий FunPay.

#### Response Example
[
  {
    "id": 1,
    "name": "Подкатегория 1"
  },
  {
    "id": 2,
    "name": "Подкатегория 2"
  }
]
```

--------------------------------

### InitialChatEvent

Source: https://funpayapi.readthedocs.io/ru/latest/events.html

Event class for when a chat is detected during the Runner's first request.

```APIDOC
## InitialChatEvent

### Description
Event class for when a chat is detected during the Runner's first request.

### Constructor
`InitialChatEvent(runner_tag: str, chat_obj: ChatShortcut)`

### Parameters
- **runner_tag** (str) - Required - Tag of the Runner.
- **chat_obj** (ChatShortcut) - Required - Object of the detected chat.

### Attributes
- **chat** (ChatShortcut) - Object of the detected chat.
```

--------------------------------

### get_order

Source: https://funpayapi.readthedocs.io/ru/latest/account.html

Получает полную информацию о заказе.

```APIDOC
## get_order

### Description
Получает полную информацию о заказе.

### Method
get_order

### Parameters
- **order_id** (str) - Required - ID заказа.

### Returns
- **FunPayAPI.types.Order** - Объект заказа.
```
Tokens:
Raw