chessdotcom.endpoints.tournament_details¶
Get details about a daily, live and arena tournament.
API doc: https://www.chess.com/news/view/published-data-api#pubapi-endpoint-tournament-profile
- chessdotcom.endpoints.tournament_details.get_tournament_details(url_id: str, tts=0, **request_options) ChessDotComResponse¶
- Parameters:
url_id – URL for the club’s web page on www.chess.com.
tts – the time the client will wait before making the first request.
- Returns:
GetTournamentDetailsResponseobject containing details about a daily, live and arena tournament.
- class chessdotcom.endpoints.tournament_details.GetTournamentDetailsResponse(json, text, tournament)¶
- Variables:
tournament – Holds the
TournamentDetailsobject.json – The JSON response from the API.
text – The raw text response from the API.
- class chessdotcom.endpoints.tournament_details.TournamentDetails(name: str | None, url: str | None, description: str | None, creator: str | None, status: str | None, finish_time: int | None, settings: TournamentSettings, players: List[TournamentPlayer], rounds: List[str])¶
- Variables:
name – Tournament’s name.
url – URL for the tournament’s web page on www.chess.com.
description – Tournament’s description.
creator – The creator of the tournament.
status – The status of the tournament.
finish_time – The time the tournament finishes.
settings – The tournament settings. Holds
TournamentSettingsobject.players – List of
TournamentPlayerobjects.rounds – List of rounds in the tournament.
finish_datetime – The finish time as a datetime object.
- class chessdotcom.endpoints.tournament_details.TournamentSettings(type: str | None, rules: str | None, is_rated: bool | None, is_official: bool | None, is_invite_only: bool | None, min_rating: int | None, max_rating: int | None, initial_group_size: int | None, user_advance_count: int | None, use_tiebreak: bool | None, allow_vacation: bool | None, winner_places: int | None, registered_user_count: int | None, games_per_opponent: int | None, total_rounds: int | None, concurrent_games_per_opponent: int | None, time_class: str | None, time_control: str | None)¶
- Variables:
type – The type of the tournament.
rules – The rules of the tournament.
is_rated – Whether the tournament is rated.
is_official – Whether the tournament is official.
is_invite_only – Whether the tournament is invite-only.
min_rating – The minimum rating required to join the tournament.
max_rating – The maximum rating required to join the tournament.
initial_group_size – The initial group size of the tournament.
user_advance_count – The user advance count of the tournament.
use_tiebreak – Whether the tournament uses tiebreak.
allow_vacation – Whether the tournament allows vacation.
winner_places – The number of winner places in the tournament.
registered_user_count – The number of registered users in the tournament.
games_per_opponent – The number of games per opponent in the tournament.
total_rounds – The total number of rounds in the tournament.
concurrent_games_per_opponent – The number of concurrent games per opponent.
time_class – The time control class of the tournament.
time_control – The time control of the tournament.
- class chessdotcom.endpoints.tournament_details.TournamentPlayer(username: str | None, status: str | None)¶
- Variables:
username – The username of the player.
status – The status of the player