API Reference#

The following section outlines the API of pyspapi.

Version Info#

There are two main ways to query version information.

pyspapi.version_info#

A named tuple that is similar to py:sys.version_info.

Just like py:sys.version_info the valid values for releaselevel are „alpha“, „beta“, „candidate“ and „final“.

pyspapi.__version__#

A string representation of the version.

pyspapi#

SPAPI#

class pyspapi.SPAPI(card_id: str, token: str)#

class SPAPI

check_users_access(user_ids: List[int]) List[bool]#

Проверка наличия проходки у списка пользователей Discord. Не более 10

Параметры

user_ids – Список(List[int]) содержащий ID пользователей в Discord.

Результат

Список(List[bool]) в том же порядке, который был задан.True - проходка имеется, иначе False.

get_user(user_id: int) Optional[SPUserProfile]#

Получение информации об игроке SP

Параметры

user_id – ID пользователя в Discord.

Результат

Class SPUserProfile.

get_users(user_ids: List[int]) List[str]#

Получение никнеймов игроков в майнкрафте. Не более 10

Параметры

user_ids – List[int] ID пользователей в Discord.

Результат

List[str] который содержит майнкрафт никнеймы игроков в том же порядке, который был задан, None если пользователь не найден или нет проходки.

payment(amount: int, redirect_url: str, webhook_url: str, data: str) Optional[str]#

Создание ссылки для оплаты.

Параметры
  • amount – Стоимость покупки в АРах.

  • redirect_url – URL страницы, на которую попадет пользователь после оплаты.

  • webhook_url – URL, куда наш сервер направит запрос, чтобы оповестить ваш сервер об успешной оплате.

  • data – Строка до 100 символов, сюда можно поместить любые полезные данных.

Результат

Ссылку на страницу оплаты, на которую стоит перенаправить пользователя.

transaction(receiver: int, amount: int, comment: str) Optional[str]#

Перевод АР на карту.

Параметры
  • receiver – Номер карты получателя.

  • amount – Количество АР для перевода.

  • comment – Комментарий для перевода.

Результат

True если перевод успешен, иначе False.

webhook_verify(data: str, header) bool#

Проверяет достоверность webhook’а.

Параметры
  • data – data из webhook.

  • header – header X-Body-Hash из webhook.

Результат

True если header из webhook’а достоверен, иначе False

MojangAPI#

class pyspapi.MojangAPI#

class MojangAPI

classmethod get_name_history(uuid: str) List[Dict[str, Any]]#

История никнеймов в Minecraft.

Параметры

uuid – UUID игрока Minecraft.

Результат

List[Dict[str, Any]] который содержит name и changed_to_at

classmethod get_profile(uuid: str) Optional[MojangUserProfile]#

Профиль игрока Minecraft.

Параметры

uuid – UUID игрока Minecraft.

Результат

Class MojangUserProfile

classmethod get_username(uuid: str) Optional[str]#

Получить никнейм игрока.

Параметры

uuid – UUID игрока Minecraft.

Результат

Optional[str] в виде никнейма игрока Minecraft.

classmethod get_uuid(username: str) Optional[str]#

Получить UUID игрока Minecraft.

Параметры

username – str никнейм игрока Minecraft.

Результат

Optional[str] UUID игрока Minecraft.

classmethod get_uuids(names: List[str]) Dict[str, str]#

Получить UUID’s игроков Minecraft.

Параметры

names – List[str] Список с никнеймами игроков Minecraft.

Результат

Dict[str, str] UUID игрока Minecraft.