chessdotcom.endpoints.player_tournaments¶
List of tournaments the player is registered, is attending or has attended in the past.
API doc: https://www.chess.com/news/view/published-data-api#pubapi-endpoint-player-tournaments
- chessdotcom.endpoints.player_tournaments.get_player_tournaments(username: str, tts=0, **request_options) GetPlayerTournamentsResponse¶
- Parameters:
username – username of the player.
tts – the time the client will wait before making the first request.
- Returns:
GetPlayerTournamentsResponseobject containing a list of tournaments the player is registered, is attending or has attended in the past.
- class chessdotcom.endpoints.player_tournaments.GetPlayerTournamentsResponse(json, text, tournaments)¶
- Variables:
json – The JSON response from the API.
text – The text response from the API.
tournaments –
Tournaments: contains finished, in-progress, and registered tournaments.
- class chessdotcom.endpoints.player_tournaments.Tournaments(finished: list, in_progress: list, registered: list)¶
- Variables:
finished – List of
FinishedTournamentobjects.in_progress – List of
InProgressTournamentobjects.registered – List of
RegisteredTournamentobjects.
- class chessdotcom.endpoints.player_tournaments.FinishedTournament(url: str | None, id: str | None, wins: int | None, losses: int | None, draws: int | None, placement: int | None, status: str | None, total_players: int | None, time_class: str | None, type: str | None)¶
Represents a finished tournament.
- Variables:
url – The URL of the tournament.
id – The unique identifier of the tournament.
wins – The number of wins by the player in the tournament.
losses – The number of losses by the player in the tournament.
draws – The number of draws by the player in the tournament.
placement – The final placement of the player in the tournament.
status – The status of the tournament.
total_players – The total number of players in the tournament.
time_class – The time control class of the tournament (e.g., blitz, bullet, rapid).
type – The type of the tournament.
- class chessdotcom.endpoints.player_tournaments.InProgressTournament(url: str | None, id: str | None, status: str | None)¶
Represents an in-progress tournament.
- Variables:
url – The URL of the tournament.
id – The unique identifier of the tournament.
status – The current status of the tournament.
- class chessdotcom.endpoints.player_tournaments.RegisteredTournament(url: str | None, id: str | None, status: str | None)¶
Represents a registered tournament.
- Variables:
url – The URL of the tournament.
id – The unique identifier of the tournament.
status – The current status of the tournament.