Rankings#

ranking(self, mode, type, *, country=None, cursor=None, filter_=RankingFilter.ALL, spotlight=None, variant=None)#

Get current rankings for the specified game mode. Can specify type to get different types of rankings (performance, score, country, etc).

Parameters:

  • mode (GameMode | str) – The mode to get rankings for.

  • type (RankingType | str) – The type of ranking to get.

  • country (str | None) – Filter ranking by 2 letter country code. Only available for RankingType.PERFORMANCE.

  • cursor (Cursor | None) – Cursor for pagination.

  • filter – Filter ranking by specified filter.

  • spotlight (int | None) – The id of the spotlight to return rankings for. Ranking for latest spotlight will be returned if not specified. Only available for RankingType.SPOTLIGHT.

  • variant (str | None) – Filter ranking by game mode variant. Either 4k or 7k for mania. Only available for RankingType.PERFORMANCE.

  • filter_ (RankingFilter | str) –

Return type:

Rankings

Notes

Implements the Get Ranking endpoint.