Resource BattleRankingResource

BattleRankingResource (client.battle_ranking)

Endpoints: • battleRanking.getRanking

.get()

Get battle rankings.

Args: data_type: What to rank by — damage, points, or money. type: Entity type — user, country, or mu. side: Which side — attacker or defender. battle_id: Optional filter by battle. round_id: Optional filter by round. war_id: Optional filter by war.

Signature

await client.battleranking.get(data_type: 'BattleRankingDataType | str', type: 'BattleRankingEntityType | str', side: 'BattleRankingSide | str', *, battle_id: 'str | None' = None, round_id: 'str | None' = None, war_id: 'str | None' = None) -> 'list[BattleRankingEntry]'

Parameters

Name	Type	Default
data_type	BattleRankingDataType | str	*Required*
type	BattleRankingEntityType | str	*Required*
side	BattleRankingSide | str	*Required*
battle_id	str | None	None
round_id	str | None	None
war_id	str | None	None

Return Models

BattleRankingEntry

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
rank	integer \| null	❌
user	string \| null	❌
entityType	string \| null	❌
name	string \| null	❌
country	string \| null	❌
value	number \| null	❌
side	string \| null	❌

---

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

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

---