Аккаунт#
- class playerokapi.account.Account(*args, **kwargs)#
Класс, описывающий данные и методы Playerok аккаунта.
- param token:
Токен аккаунта.
- type token:
str or None
- param ddg5:
Cookie для обхода защиты DDoS-Guard (полное название: __ddg5_).
Примечание: эта Cookie «умирает» каждый раз, когда:
меняется IP
меняется User-Agent / TLS fingerprint
сервер обновил ключи/алгоритм
Чтобы API работал, эта Cookie должна быть взята из Cookie-данных аккаунта, токен которого вы указали, и запросы должны идти с того же IP-адреса, под которым Вы авторизовывались на Playerok.
- Если она недействительна, при запросах будет вызываться исключение BotCheckDetectedException.
- type ddg5:
str
- param cookies:
Куки-данные авторизованного аккаунта. Можно указывать вместо параметров token, ddg5.
- type cookies:
str or dict[str, str] or None
- param user_agent:
Юзер-агент браузера.
- type user_agent:
str or None
- param proxy:
IPV4 прокси в формате: user:pass@ip:port или ip:port, _опционально_.
- type proxy:
str or None
- param requests_timeout:
Таймаут ожидания ответов на запросы.
- type requests_timeout:
int
- token#
Токен сессии аккаунта.
- ddg5#
Cookie для обхода защиты DDoS-Guard.
- cookies#
Куки-данные авторизованного аккаунта.
- user_agent#
Юзер-агент браузера.
- requests_timeout#
Таймаут ожидания ответов на запросы.
- proxy#
Прокси.
- base_url#
Базовый URL для всех запросов.
- unread_chats_counter: int | None#
Количество непрочитанных чатов.
_Заполняется при первом использовании get()_
- is_blocked_for: str | None#
Причина блокировки аккаунта.
_Заполняется при первом использовании get()_
- last_item_created_at: str | None#
Дата создания последнего предмета.
_Заполняется при первом использовании get()_
- has_frozen_balance: bool | None#
Заморожен ли баланс аккаунта.
_Заполняется при первом использовании get()_
- has_confirmed_phone_number: bool | None#
Подтверждён ли номер телефона.
_Заполняется при первом использовании get()_
- can_publish_items: bool | None#
Может ли продавать предметы.
_Заполняется при первом использовании get()_
- profile: AccountProfile | None#
Профиль аккаунта (не путать с профилем пользователя).
_Заполняется при первом использовании get()_
- request(method: Literal['get', 'post'], url: str, headers: dict[str, str], payload: dict[str, str] | None = None, files: dict | None = None, pass_304: bool = True) Response#
Отправляет запрос на сервер playerok.com.
- Параметры:
method (str) – Метод запроса: post, get.
url (str) – URL запроса.
headers (dict[str, str]) – Заголовки запроса.
payload (dict[str, str] or None) – Payload запроса.
files (dict or None) – Файлы запроса.
- Результат:
Ответа запроса requests.
- Тип результата:
requests.Response
- get() Account#
Получает/обновляет данные об аккаунте.
- Результат:
Объект аккаунта с обновлёнными данными.
- Тип результата:
playerokapi.account.Account
- get_user(id: str | None = None, username: str | None = None) UserProfile#
Получает профиль пользователя.
Можно получить по любому из двух параметров:
- Параметры:
id (str or None) – ID пользователя, _опционально_.
username (str or None) – Никнейм пользователя, _опционально_.
- Результат:
Объект профиля пользователя.
- Тип результата:
playerokapi.types.UserProfile
- get_deals(statuses: list[ItemDealStatuses] | None = None, direction: ItemDealDirections | None = None, count: int = 24, after_cursor: str = None) ItemDealList#
Получает сделки аккаунта.
- Параметры:
statuses (list[playerokapi.enums.ItemDealsStatuses] or None) – Статусы, сделки которых нужно получать, _опционально_.
direction (playerokapi.enums.ItemDealsDirections or None) – Направление сделок, _опционально_.
count (int) – Кол-во сделок, которые нужно получить (не более 24 за один запрос).
after_cursor (str) – Курсор, с которого будет идти парсинг (если нету - ищет с самого начала страницы), _опционально_.
- Результат:
Страница сделок.
- Тип результата:
playerokapi.types.ItemDealList
- get_deal(deal_id: str) ItemDeal#
Получает сделку.
- Параметры:
deal_id (str) – ID сделки.
- Результат:
Объект сделки.
- Тип результата:
playerokapi.types.ItemDeal
- update_deal(deal_id: str, new_status: ItemDealStatuses) ItemDeal#
Обновляет статус сделки (используется, чтобы подтвердить, оформить возврат и т.д).
- Параметры:
deal_id (str) – ID сделки.
new_status (playerokapi.enums.ItemDealStatuses) – Новый статус сделки.
- Результат:
Объект обновлённой сделки.
- Тип результата:
playerokapi.types.ItemDeal
- get_games(name: str | None = None, type: GameTypes | None = None, count: int = 24, after_cursor: str = None) GameList#
Получает все игры или/и приложения.
- Параметры:
name (name or None) – Название игры (необязательно полное), _опционально_.
type (playerokapi.enums.GameTypes or None) – Тип игр, которые нужно получать. По умолчанию не указано, значит будут все сразу, _опционально_.
count (int) – Кол-во игр, которые нужно получить (не более 24 за один запрос).
after_cursor (str) – Курсор, с которого будет идти парсинг (если нету - ищет с самого начала страницы), _опционально_.
- Результат:
Страница игр.
- Тип результата:
playerokapi.types.GameList
- get_game(id: str | None = None, slug: str | None = None) Game#
Получает игру/приложение.
Можно получить по любому из двух параметров:
- Параметры:
id (str or None) – ID игры/приложения, _опционально_.
slug (str or None) – Имя страницы игры/приложения, _опционально_.
- Результат:
Объект игры.
- Тип результата:
playerokapi.types.Game
- get_game_category(id: str | None = None, game_id: str | None = None, slug: str | None = None) GameCategory#
Получает категорию игры/приложения.
Можно получить параметру id или по связке параметров game_id и slug
- Параметры:
id (str or None) – ID категории, _опционально_.
game_id (str or None) – ID игры категории (лучше указывать в связке со slug, чтобы находить точную категорию), _опционально_.
slug (str or None) – Имя страницы категории, _опционально_.
- Результат:
Объект категории игры.
- Тип результата:
playerokapi.types.GameCategory
- get_game_category_agreements(game_category_id: str, user_id: str | None = None, count: int = 24, after_cursor: str | None = None) GameCategoryAgreementList#
Получает соглашения пользователя на продажу предметов в категории (если пользователь уже принял эти соглашения - список будет пуст).
- Параметры:
game_category_id (str) – ID категории игры.
user_id (str or None) – ID пользователя, чьи соглашения нужно получить. Если не указан, будет получать по ID вашего аккаунта, _опционально_.
count (int) – Кол-во соглашений, которые нужно получить (не более 24 за один запрос).
after_cursor (str or None) – Курсор, с которого будет идти парсинг (если нету - ищет с самого начала страницы), _опционально_.
- Результат:
Страница соглашений.
- Тип результата:
playerokapi.types.GameCategoryAgreementList
- get_game_category_obtaining_types(game_category_id: str, count: int = 24, after_cursor: str | None = None) GameCategoryObtainingTypeList#
Получает типы (способы) получения предмета в категории.
- Параметры:
game_category_id (str) – ID категории игры.
count (int) – Кол-во соглашений, которые нужно получить (не более 24 за один запрос).
after_cursor (str or None) – Курсор, с которого будет идти парсинг (если нету - ищет с самого начала страницы), _опционально_.
- Результат:
Страница соглашений.
- Тип результата:
playerokapi.types.GameCategoryAgreementList
- get_game_category_instructions(game_category_id: str, obtaining_type_id: str, count: int = 24, type: GameCategoryInstructionTypes | None = None, after_cursor: str | None = None) GameCategoryInstructionList#
Получает инструкции по продаже/покупке в категории.
- Параметры:
game_category_id (str) – ID категории игры.
obtaining_type_id (str) – ID типа (способа) получения предмета.
count (int) – Кол-во инструкций, которые нужно получить (не более 24 за один запрос).
type (enums.GameCategoryInstructionTypes or None) – Тип инструкции: для продавца или для покупателя, _опционально_.
after_cursor (str or None) – Курсор, с которого будет идти парсинг (если нету - ищет с самого начала страницы), _опционально_.
- Результат:
Страница инструкий.
- Тип результата:
playerokapi.types.GameCategoryInstructionList
- get_game_category_data_fields(game_category_id: str, obtaining_type_id: str, count: int = 24, type: GameCategoryDataFieldTypes | None = None, after_cursor: str | None = None) GameCategoryDataFieldList#
Получает поля с данными категории (которые отправляются после покупки).
- Параметры:
game_category_id (str) – ID категории игры.
obtaining_type_id (str) – ID типа (способа) получения предмета.
count (int) – Кол-во инструкций, которые нужно получить (не более 24 за один запрос).
type (enums.GameCategoryDataFieldTypes or None) – Тип полей с данными, _опционально_.
after_cursor (str or None) – Курсор, с которого будет идти парсинг (если нету - ищет с самого начала страницы), _опционально_.
- Результат:
Страница полей с данными.
- Тип результата:
playerokapi.types.GameCategoryDataFieldList
- get_chats(count: int = 24, type: ChatTypes | None = None, status: ChatStatuses | None = None, after_cursor: str | None = None) ChatList#
Получает все чаты аккаунта.
- Параметры:
count (int) – Кол-во чатов, которые нужно получить (не более 24 за один запрос).
type (playerokapi.enums.ChatTypes or None) – Тип чатов, которые нужно получать. По умолчанию не указано, значит будут все сразу, _опционально_.
status (playerokapi.enums.ChatStatuses or None) – Статус чатов, которые нужно получать. По умолчанию не указано, значит будут любые, _опционально_.
after_cursor (str or None) – Курсор, с которого будет идти парсинг (если нету - ищет с самого начала страницы), _опционально_.
- Результат:
Страница чатов.
- Тип результата:
playerokapi.types.ChatList
- get_chat(chat_id: str) Chat#
Получает чат.
- Параметры:
chat_id (str) – ID чата.
- Результат:
Объект чата.
- Тип результата:
playerokapi.types.Chat
- get_chat_by_username(username: str) Chat | None#
Получает чат по никнейму собеседника.
- Параметры:
username (str) – Никнейм собеседника.
- Результат:
Объект чата.
- Тип результата:
playerokapi.types.Chat or None
- get_chat_messages(chat_id: str, count: int = 24, after_cursor: str | None = None) ChatMessageList#
Получает сообщения чата.
- Параметры:
chat_id (str) – ID чата.
count (int) – Кол-во сообщений, которые нужно получить (не более 24 за один запрос).
after_cursor (str or None) – Курсор, с которого будет идти парсинг (если нету - ищет с самого начала страницы), _опционально_.
- Результат:
Страница сообщений.
- Тип результата:
playerokapi.types.ChatMessageList
- mark_chat_as_read(chat_id: str) Chat#
Помечает чат как прочитанный (все сообщения).
- Параметры:
chat_id (str) – ID чата.
- Результат:
Объект чата с обновлёнными данными.
- Тип результата:
playerokapi.types.Chat
- upload_chat_image_into_temporary_store(photo_file_path: str, chat_id: str) Chat#
Выкладывает изображение чата во временное хранилище (перед отправкой сообщения с изображением).
- Параметры:
chat_id (str) – ID чата.
- Результат:
Объект чата с обновлёнными данными.
- Тип результата:
playerokapi.types.Chat
- send_message(chat_id: str, text: str | None = None, photo_file_paths: list[str] = [], mark_chat_as_read: bool = False) ChatMessage#
Отправляет сообщение в чат.
Можно отправить текстовое сообщение text или фотографии photo_file_paths.
- Параметры:
chat_id (str) – ID чата, в который нужно отправить сообщение.
text (str or None) – Текст сообщения, _опционально_.
photo_file_paths (list of str) – Массив путей к файлам фотографий, _опционально_.
mark_chat_as_read (bool) – Пометить чат, как прочитанный перед отправкой, _опционально_.
- Результат:
Объект отправленного сообщения.
- Тип результата:
playerokapi.types.ChatMessage
- create_item(game_category_id: str, obtaining_type_id: str, name: str, price: int, description: str, options: list[GameCategoryOption], data_fields: list[GameCategoryDataField], attachments: list[str]) types.Item#
Создаёт предмет (после создания помещается в черновик, а не сразу выставляется на продажу).
- Параметры:
game_category_id (str) – ID категории игры, в которой необходимо создать предмет.
obtaining_type_id (str) – ID типа получения предмета.
name (str) – Название предмета.
price (int or str) – Цена предмета.
description (str) – Описание предмета.
options (list[playerokapi.types.GameCategoryOption]) – Массив выбранных опций (аттрибутов) предмета.
data_fields (list[playerokapi.types.GameCategoryDataField]) –
Массив полей с данными предмета.
!!! Должны быть заполнены данные с типом поля ITEM_DATA, то есть те данные, которые указываются при заполнении информации о товаре. Поля с типом OBTAINING_DATA заполнять и передавать не нужно, так как эти данные будет указывать сам покупатель при оформлении предмета.
attachments (list[str]) – Массив файлов-приложений предмета. Указываются пути к файлам.
- Результат:
Объект созданного предмета.
- Тип результата:
playerokapi.types.Item
- update_item(id: str, name: str | None = None, price: int | None = None, description: str | None = None, options: list[GameCategoryOption] | None = None, data_fields: list[GameCategoryDataField] | None = None, remove_attachments: list[str] | None = None, add_attachments: list[str] | None = None) types.Item#
Обновляет предмет аккаунта.
- Параметры:
id (str) – ID предмета.
name (str or None) – Название предмета.
price (int or str or None) – Цена предмета.
description (str or None) – Описание предмета.
options (list[playerokapi.types.GameCategoryOption] or None) – Массив выбранных опций (аттрибутов) предмета.
data_fields (list[playerokapi.types.GameCategoryDataField] or None) –
Массив полей с данными предмета.
!!! Должны быть заполнены данные с типом поля ITEM_DATA, то есть те данные, которые указываются при заполнении информации о товаре. Поля с типом OBTAINING_DATA заполнять и передавать не нужно, так как эти данные будет указывать сам покупатель при оформлении предмета.
remove_attachments (list[str] or None) – Массив ID файлов-приложений предмета, которые нужно удалить.
add_attachments (list[str] or None) – Массив файлов-приложений предмета, которые нужно добавить. Указываются пути к файлам.
- Результат:
Объект обновлённого предмета.
- Тип результата:
playerokapi.types.Item
- remove_item(id: str) bool#
Полностью удаляет предмет вашего аккаунта.
- Параметры:
id (str) – ID предмета.
- publish_item(item_id: str, priority_status_id: str, transaction_provider_id: TransactionProviderIds = TransactionProviderIds.LOCAL) Item#
Выставляет предмет на продажу.
- Параметры:
item_id (str) – ID предмета.
priority_status_id (str) – ID статуса приоритета предмета, под которым его нужно выставить на продажу.
transaction_provider_id (playerokapi.types.TransactionProviderIds) – ID провайдера транзакции.
- Результат:
Объект опубликованного предмета.
- Тип результата:
playerokapi.types.Item
- get_my_items(game_id: str | None = None, category_id: str | None = None, obtaining_type_id: str | None = None, statuses: list[ItemStatuses] = [ItemStatuses.APPROVED], count: int = 24, after_cursor: str | None = None) ItemProfileList#
Получает предметы вашего аккаунта.
- Параметры:
game_id (str or None) – ID игры/приложения, _опционально_.
category_id (str or None) – ID категории игры/приложения, _опционально_.
obtaining_type_id (str or None) – ID типа получения товара, _опционально_.
statuses (list[playerokapi.enums.ItemStatuses]) – Статусы, предметы которых нужно получать.
count (int) – Кол-во предеметов, которые нужно получить (не более 24 за один запрос).
after_cursor (str or None) – Курсор, с которого будет идти парсинг (если нету - ищет с самого начала страницы), _опционально_.
- Результат:
Страница профилей предметов.
- Тип результата:
playerokapi.types.ItemProfileList
- get_items(game_id: str | None = None, category_id: str | None = None, obtaining_type_id: str | None = None, statuses: list[ItemStatuses] = [ItemStatuses.APPROVED], count: int = 24, after_cursor: str | None = None) ItemProfileList#
Получает предметы игры/приложения.
Можно получить по любому из двух параметров: game_id, category_id.
- Параметры:
game_id (str or None) – ID игры/приложения, _опционально_.
category_id (str or None) – ID категории игры/приложения, _опционально_.
obtaining_type_id (str or None) – ID типа получения товара, _опционально_.
statuses (list[playerokapi.enums.ItemStatuses]) – Статусы, предметы которых нужно получать.
count (int) – Кол-во предеметов, которые нужно получить (не более 24 за один запрос).
after_cursor (str or None) – Курсор, с которого будет идти парсинг (если нету - ищет с самого начала страницы), _опционально_.
- Результат:
Страница профилей предметов.
- Тип результата:
playerokapi.types.ItemProfileList
- get_item(id: str | None = None, slug: str | None = None) MyItem | Item | ItemProfile#
Получает предмет (товар).
Можно получить по любому из двух параметров:
- Параметры:
id (str or None) – ID предмета, _опционально_.
slug (str or None) – Имя страницы предмета, _опционально_.
- Результат:
Объект предмета.
- Тип результата:
playerokapi.types.MyItem or playerokapi.types.Item or playerokapi.types.ItemProfile
- get_item_priority_statuses(item_id: str, item_price: int | str) list[ItemPriorityStatus]#
Получает статусы приоритетов для предмета.
- Параметры:
item_id (str) – ID предмета.
item_price (int or str) – Цена предмета.
- Результат:
Массив статусов приоритета предмета.
- Тип результата:
list[playerokapi.types.ItemPriorityStatus]
- increase_item_priority_status(item_id: str, priority_status_id: str, payment_method_id: TransactionPaymentMethodIds | None = None, transaction_provider_id: TransactionProviderIds = TransactionProviderIds.LOCAL) Item#
Повышает статус приоритета предмета.
- Параметры:
item_id (str) – ID предмета.
priority_status_id (int or str) – ID статуса приоритета, на который нужно изменить.
payment_method_id (playerokapi.enums.TransactionPaymentMethodIds or None) – Метод оплаты, _опционально_.
transaction_provider_id (playerokapi.enums.TransactionProviderIds) – ID провайдера транзакции (LOCAL - с баланса кошелька на сайте).
- Результат:
Объект обновлённого предмета.
- Тип результата:
playerokapi.types.Item
- get_transaction_providers(direction: TransactionProviderDirections = TransactionProviderDirections.IN) list[TransactionProvider]#
Получает всех провайдеров транзакций.
- Параметры:
direction (playerokapi.enums.TransactionProviderDirections) – Направление транзакций (пополнение/вывод).
- Результат:
Список провайдеров транзакий.
- Тип результата:
list of playerokapi.types.TransactionProvider
- get_transactions(status: TransactionStatuses | None = None, operation: TransactionOperations | None = None, provider_id: TransactionProviderIds | None = None, min_value: int | None = None, max_value: int | None = None, from_date: datetime | None = None, to_date: datetime | None = None, count: int = 24, after_cursor: str | None = None) TransactionList#
Получает все транзакции аккаунта.
- Параметры:
status (playerokapi.enums.TransactionStatuses or None) – Статус транзакции, _опционально_.
operation (playerokapi.enums.TransactionOperations or None) – Операция транзакции, _опционально_.
provider_id (playerokapi.enums.TransactionProviderIds or None) – ID провайдера транзакции, _опционально_.
min_value (int or None) – Минимальная сумма транзакции, _опционально_.
max_value (int or None) – Максимальная сумма транзакции, _опционально_.
from_date (datetime or None) – Минимальная дата транзакции, _опционально_.
to_date (datetime or None) – Максимальная дата транзакции, _опционально_.
count (int) – Кол-во транзакциий которые нужно получить (не более 24 за один запрос).
after_cursor (str or None) – Курсор, с которого будет идти парсинг (если нету - ищет с самого начала страницы), _опционально_.
- Результат:
Страница транзакций.
- Тип результата:
playerokapi.types.TransactionList
- get_sbp_bank_members() list[SBPBankMember]#
Получает всех членов банка СБП.
- Результат:
Объект провайдера транзакции.
- Тип результата:
list of playerokapi.types.SBPBankMember
- get_verified_cards(count: int = 24, after_cursor: str | None = None, direction: SortDirections = SortDirections.ASC) UserBankCardList#
Получает верифицированные карты аккаунта.
- Параметры:
count (int) – Кол-во банковских карт, которые нужно получить (не более 24 за один запрос).
after_cursor (str or None) – Курсор, с которого будет идти парсинг (если нету - ищет с самого начала страницы), _опционально_.
direction (playerokapi.enums.SortDirections) – Тип сортировки банковских карт.
- Результат:
Страница банковских карт пользователя.
- Тип результата:
playerokapi.types.UserBankCardList
- delete_card(card_id: str) bool#
Удаляет карту из сохранённых в аккаунте.
- Параметры:
card_id (str) – ID банковской карты.
- Результат:
True, если карта удалилась, иначе False
- Тип результата:
bool
- request_withdrawal(provider: TransactionProviderIds, account: str, value: int, payment_method_id: TransactionPaymentMethodIds | None = None, sbp_bank_member_id: str | None = None) Transaction#
Создаёт запрос на вывод средств с баланса аккаунта.
- Параметры:
provider (playerokapi.enums.TransactionProviderIds) – Провайдер транзакции.
account (str) – ID добавленной карты (или номер телефона, если провайдер СБП), на которую нужно совершить вывод.
value (int) – Сумма вывода.
payment_method_id (playerokapi.enums.TransactionPaymentMethodIds or None) – ID платёжного метода, _опционально_.
sbp_bank_member_id (str or None) – ID члена банка СБП (только если указан провайдер СБП), _опционально_.
- Результат:
Объект транзакции вывода.
- Тип результата:
playerokapi.types.Transaction
- remove_transaction(transaction_id: str) Transaction#
Удаляет транзакцию (например, можно отменить вывод).
- Параметры:
transaction_id (str) – ID транзакции.
- Результат:
Объект отменённой транзакции.
- Тип результата:
playerokapi.types.Transaction
- get_message_templates(type: MessageTemplateTypes = MessageTemplateTypes.ACTIVE_DEAL_PROBLEM, count: int = 24, after_cursor: str | None = None) MessageTemplateList#
Получает шаблонные сообщения.
- Параметры:
type (playerokapi.enums.MessageTemplateTypes) – Тип шаблонных сообщений.
count (int) – Кол-во сообщений, которые нужно получить (не более 24 за один запрос).
after_cursor (str or None) – Курсор, с которого будет идти парсинг (если нету - ищет с самого начала страницы), _опционально_.
- Результат:
Страница шаблонных сообщений.
- Тип результата:
playerokapi.types.MessageTemplateList
- report_deal_problem(deal_id: str, description: str, problem_type_id: str) ItemDeal#
Создаёт проблему в сделке.
- Параметры:
deal_id (str) – ID сделки.
description (str) – Описание проблемы.
problem_type_id (str) – ID типа проблемы (шаблонного сообщения в get_message_templates()).
- Результат:
Объект обновлённой сделки.
- Тип результата:
playerokapi.types.ItemDeal
- get_my_reviews(status: ReviewStatuses = ReviewStatuses.APPROVED, comment_required: bool = False, rating: int | None = None, game_id: str | None = None, category_id: str | None = None, min_item_price: int | None = None, max_item_price: int | None = None, sort_direction: SortDirections = SortDirections.DESC, sort_field: str = 'createdAt', count: int = 24, after_cursor: str | None = None) ReviewList#
Получает отзывы вашего аккаунта.
- Параметры:
status (playerokapi.enums.ReviewStatuses) – Тип отзывов, которые нужно получить.
comment_required (bool) – Обязателен ли комментарий в отзыве, _опционально_.
rating (int or None) – Рейтинг отзывов (1-5), _опционально_.
game_id (str or None) – ID игры отзывов, _опционально_.
category_id (str or None) – ID категории отзывов, _опционально_.
min_item_price (bool or None) – Минимальная цена предмета отзыва, _опционально_.
max_item_price (bool or None) – Максимальная цена предмета отзыва, _опционально_.
sort_direction (playerokapi.enums.SortDirections) – Тип сортировки.
sort_field (str) – Поле, по которому будет идти сортировка (по умолчанию createdAt - по дате)
count (int) – Кол-во отзывов, которые нужно получить (не более 24 за один запрос), _опционально_.
after_cursor (str or None) – Курсор, с которого будет идти парсинг (если нету - ищет с самого начала страницы), _опционально_.
- Результат:
Страница отзывов.
- Тип результата:
PlayerokAPI.types.ReviewList