Client#

WotBlitz client module.

class onewot.impl.client.WOTBClient(application_id: str, language: Optional[data_binding.Language] = 'ru', access_token: Optional[str] = None)[source]#

WotBlitz API client. This is the class, you will want to create WotBlitz client.

Parameters

application_id (builtins.str) – Application ID of WotBlitz API applications.
language (Optional[onewot.data_binding.Language]) – Localization for WotBlitz API.
access_token (Optional[str]) – Access token to fetch private entity payload. Read more https://developers.wargaming.net/documentation/guide/principles/#access_token

Example

import os

import onewot

client = onewot.WOTBClient(os.environ["APPLICATION_ID"], language=onewot.Language.ENGLISH)

fetch_clan(clan: Union[str, snowflakes.Snowflake]) → clans.Clan[source]#

Fetch clan by name or identificator.

Parameters: clan (Union[builtins.str snowflakes.Snowflake]) – A clan to fetch.
Returns: Clan object.
Return type: clans.Clan

fetch_clan_member(member: Union[str, snowflakes.Snowflake]) → users.ClanMember[source]#

Fetch clan member by name or identificator.

Parameters: member (Union[builtins.str, snowflakes.Snowflake]) – A clan member to fetch.
Returns: Clan member object
Return type: users.ClanMember

fetch_tank(tank: snowflakes.Snowflake) → tanks.Tank[source]#

Fetch tank by identificator.

Parameters: tank (sowflakes.Snowflake) – Tank to fetch.
Returns: Deserialized tank object.
Return type: tanks.Tank

fetch_tournament(tournament: Union[str, snowflakes.Snowflake]) → tournaments.Tournament[source]#

Fetch tournament by name or identificator.

Parameters: tournament (Union[builtins.str, snowflakes.Snowflake]) – Tournament to fetch.
Returns: Deserialized tournament object.
Return type: tournaments.Tournament

fetch_tournaments(tournament_name: Optional[str] = None, page_number: Optional[int] = None, limit: Optional[int] = None) → Optional[tuple[tournaments.Tournament]][source]#

Fetch upcoming, finished and running tournaments.

Parameters

tournament_name (Optional[builtins.str]) – Tournament to fetch. Defaults to builtins.None.
page_number (Optional[builtins.int]) – Page for search. Defaults to builtins.None.
limit (Optional[builtins.int]) – Tournament search limit. Maximum value is 100. Defaults to builtins.None.

Returns

List of tournaments.

Return type

builtins.tuple[tournaments.Tournament]

fetch_user(user: Union[str, snowflakes.Snowflake]) → users.User[source]#

Fetch a user by name or identificator.

Parameters: user (Union[builtins.str, snowflakes.Snowflake]) – A user to fetch.
Returns: User object.
Return type: users.User

fetch_users_by_id(user_ids: Iterable[snowflakes.Snowflake]) → tuple[users.User][source]#

Fetch users by their identificators.

Parameters: user_ids (Iterable[snowflakes.Snowflakes]) – An iterable object of user IDs.
Returns: A tuple of user objects.
Return type: builtins.tuple[users.User]