Users¶
- Client.get_status(users, with_game_ids=False)¶
Get real-time status of one or more users
- Parameters
users (list[str]) – Users to query their real-time status
with_game_ids (Optional[bool]) – Flag to include the ID of games being played, if any, for each player
- Returns
A list with dictionaries containing the real-time status of one or more users
- Return type
list
- Client.get_data(user)¶
Get public data of an individual user
- Parameters
user (str) – User to query their public data
- Returns
A dictionary with the public data of the user
- Return type
dict
- Client.get_rating_history(user)¶
Get rating history of an individual user
- Parameters
user (str) – User to query their public data
- Returns
A list with dictionaries containing the rating history of the user
- Return type
list
- Client.get_stats(user, perf_type)¶
Get performance statistics of an individual user
- Parameters
user (str) – User to query their performance statistics
perf_type (str) – Type of speed or variant to query
- Returns
A dictionary with the performance statistics of the user
- Return type
dict
- Client.get_activity(user)¶
Get the activity feed of an individual user
- Parameters
user (str) – User to query their activity feed
- Returns
A list with dictionaries containing the activity feed of the user
- Return type
list
- Client.get_live_streamers()¶
Get the current live streamers
- Returns
A list with dictionaries containing the current live streamers
- Return type
list
- Client.get_crosstable(user1, user2, matchup=False)¶
Get the crosstable of two users
- Parameters
user1 (str) – First user to compare with second user
user2 (str) – Second user to compare with first user
matchup (Optional[bool]) – Flag to get current match data, if the two users are currently playing
- Returns
A dictionary with the crosstable (total number of games and current score of the two users)
- Return type
dict