chessdotcom.endpoints.streamers¶
Information about Chess.com streamers.
API doc: https://www.chess.com/news/view/published-data-api#pubapi-streamers
- chessdotcom.endpoints.streamers.get_streamers(tts=0, **request_options) GetStreamersResponse¶
- Parameters:
tts – the time the client will wait before making the first request.
- Returns:
GetStreamersResponseobject containing information about Chess.com streamers.
- class chessdotcom.endpoints.streamers.GetStreamersResponse(json, text, streamers)¶
- Variables:
json – The JSON response from the API.
text – The raw text response from the API.
streamers – List of streamers. Holds a list of
Streamerobjects.
- class chessdotcom.endpoints.streamers.Streamer(username: str | None, avatar: str | None, twitch_url: str | None, url: str | None, is_live: bool | None, is_community_streamer: bool | None, platforms: List[Platform])¶
- Variables:
username – Streamer’s username.
avatar – Streamer’s avatar.
twitch_url – Streamer’s Twitch URL.
url – Streamer’s URL.
is_live – Whether the streamer is currently live.
is_community_streamer – Whether the streamer is a community streamer.
platforms – List of platforms the streamer is on. Holds a list of
Platformobjects.
- class chessdotcom.endpoints.streamers.Platform(type: str | None, stream_url: str | None, channel_url: str | None, is_live: bool | None, is_main_live_platform: bool | None)¶
- Variables:
type – Platform type.
stream_url – Platform’s stream URL.
channel_url – Platform’s channel URL.
is_live – Whether the platform is currently live.
is_main_live_platform – Whether the platform is the main live platform.