Client¶

class mctiers.Client[source]¶

Bases: object

High-level async client for the MCTiers API

__init__(*, proxy_url=None, proxy_auth=None, connector=None, session=None, user_agent=None, max_retries=5, max_ratelimit_timeout=None)[source]¶

Parameters:

proxy_url (str | None)
proxy_auth (BasicAuth | None)
connector (BaseConnector | None)
session (ClientSession | None)
user_agent (str | None)
max_retries (int)
max_ratelimit_timeout (float | None)

Return type:

None

async __aenter__()[source]¶

Return type:: Self

async __aexit__(exc_type, exc_value, traceback)[source]¶

Parameters:

exc_type (Optional[Type[BaseException]])
exc_value (Optional[BaseException])
traceback (Optional[TracebackType])

Return type:

None

async close()[source]¶

Return type:: None

async list_gamemodes()[source]¶

Return type:: Dict[str, Gamemode]

async fetch_overall_rankings(*, count, from_=0)[source]¶

Parameters:

count (int)
from_ (int)

Return type:

List[OverallPlayer]

async fetch_gamemode_rankings(gamemode, *, count, from_=0)[source]¶

Parameters:

gamemode (str)
count (int)
from_ (int)

Return type:

Dict[int, List[GamemodePlayer]]

async fetch_retired_gamemode_rankings(gamemode, *, count, from_=0)[source]¶

Parameters:

gamemode (str)
count (int)
from_ (int)

Return type:

Dict[int, List[GamemodePlayer]]

async fetch_player_profile(uuid, *, tests=False, badges=False)[source]¶

Parameters:

uuid (str)
tests (bool)
badges (bool)

Return type:

Player

async fetch_player_rankings(uuid, *, tests=False, badges=False)[source]¶

Parameters:

uuid (str)
tests (bool)
badges (bool)

Return type:

Dict[str, Ranking]

async fetch_player_profile_by_name(name, *, tests=False, badges=False)[source]¶

Parameters:

name (str)
tests (bool)
badges (bool)

Return type:

Player

async fetch_player_profile_by_discord(discord_id, *, tests=False, badges=False)[source]¶

Parameters:

discord_id (int)
tests (bool)
badges (bool)

Return type:

Player

async fetch_tester_history(uuid, *, gamemode=None, count, from_=0)[source]¶

Parameters:

uuid (str)
gamemode (str | None)
count (int)
from_ (int)

Return type:

List[Test]

async fetch_recent_tests(*, count, gamemode=None)[source]¶

Parameters:

count (int)
gamemode (str | None)

Return type:

List[Test]

async fetch_recent_high_tests(*, count, gamemode=None)[source]¶

Parameters:

count (int)
gamemode (str | None)

Return type:

List[Test]