Resource RankingResource

RankingResource (client.ranking)

Endpoints: • ranking.getRanking

.get()

Get a ranking leaderboard.

Args: ranking_type: One of 25 ranking types (country, user, or MU). Use the RankingType enum for tab-completion.

Example: entries = await client.ranking.get(RankingType.USER_WEALTH) for e in entries: print(e.rank, e.name, e.value)

Signature

await client.ranking.get(ranking_type: 'RankingType | str') -> 'list[RankingEntry]'

Parameters

Name	Type	Default
ranking_type	RankingType | str	*Required*

Return Models

RankingEntry

Field	Type	Required	Description
_id	string	Optional
__v	integer	Optional
rank	integer	Optional	The rank.
user	string	Optional	The user.
name	string	Optional	The official name of the country.
country	string	Optional
value	number	Optional	The value.
tier	string	Optional	The tier.
mu	string	Optional	The UUID of the Military Unit this user belongs to.
image	string	Optional	The image.

---

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

await client.ranking.invalidate_cache() -> 'None'

---