Rooms

multiplayer_scores(self, room_id, playlist_id, *, limit=None, sort=None, cursor_string=None)

Get scores on a playlist item in a room.

Parameters:

  • room_id (int) – The room to get the scores from.

  • playlist_id (int) – The playlist to get the scores from.

  • limit (int | None) – Maximum number of scores to get.

  • sort (MultiplayerScoresSort | str | None) – How to sort the scores.

  • cursor_string (str | None) – Cursor for pagination.

Return type:

MultiplayerScores

Notes

Implements the Get Scores endpoint.

room(self, room_id)

Get a room.

Parameters:

room_id (int | Room) – The room to get.

Return type:

Room

Notes

Implements the Get Room endpoint.

room_leaderboard(self, room_id)

Get the leaderboard of a room.

Parameters:

room_id (int | Room) – The room to get the leaderboard of.

Return type:

RoomLeaderboard

Notes

Implements the Get Room Leaderboard endpoint.

rooms(self, *, limit=None, mode=None, season_id=None, sort=None, type_group=None)

Get the list of current rooms.

Parameters:

  • limit (int | None) – Maximum number of results.

  • mode (RoomSearchMode | str | None) – Mode to filter rooms by. Defaults to all rooms.

  • season_id (int | None) – Season id to return rooms from.

  • sort (str | None) – Sort order. One of “ended” or “created”.

  • type_group (str | None) – “playlists” (default) or “realtime”.

Return type:

List[Room]

Notes

Implements the Get Rooms endpoint.