chessdotcom.endpoints.club_details¶
Get additional details about a club.
API doc: https://www.chess.com/news/view/published-data-api#pubapi-endpoint-club-profile
- chessdotcom.endpoints.club_details.get_club_details(url_id: str, tts=0, **request_options) GetClubDetailsResponse¶
- 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:
GetClubDetailsResponseobject containing additional details about a club.
- class chessdotcom.endpoints.club_details.GetClubDetailsResponse(json, text, club)¶
- Variables:
club – Holds the
ClubDetailsobject.json – The JSON response from the API.
text – The raw text response from the API.
- class chessdotcom.endpoints.club_details.ClubDetails(name: str | None, url: str | None, icon: str | None, country: str | None, id: str | None, club_id: int | None, average_daily_rating: int | None, members_count: int | None, created: int | None, last_activity: int | None, admin: list | None, visibility: str | None, join_request: str | None, description: str | None)¶
- Variables:
name – Club’s name.
url – URL for the club’s web page on www.chess.com.
icon – URL for the club’s icon.
country – Country’s name.
id – The URL of the club’s profile.
club_id – The club’s ID.
average_daily_rating – The club’s average daily rating.
members_count – The number of members in the club.
created – The time the club was created.
last_activity – The time of the club’s last activity.
admin – List of club admins.
visibility – The club’s visibility setting.
join_request – The club’s join request setting.
description – The club’s description.
last_activity_datetime – The last activity as a datetime object.
created_datetime – The created timestamp as a datetime object.