leaderboards

Get leaderboard entries

<Note> This endpoint is cached for <Badge intent="warning" minimal>10 minutes</Badge> in the <Badge intent="warning" minimal>USER</Badge> cache source. See [Caching](/welcome#caching). <Indent></Indent> This endpoint belongs to the <Badge intent="warning" minimal>LEADERBOARDS</Badge> rate-limit bucket. See [Throttling and Rate Limits](/welcome#throttling-and-rate-limits). </Note>

Leaderboards update every 10 minutes for online players. Players who go offline between update intervals are flagged to update on the next interval.

Use resultLimit with an integer below 1000 to limit the response size. The default limit is 100.

Character-based leaderboards can include characterUuid and characterType, such as profession or gamemode leaderboards.

metadata contains variable keys depending on the leaderboard type. Some gamemode leaderboards also include top-level characterData, which has the same structure as player character data.

Some entries also include optional rank presentation fields such as rank, supportRank, shortenedRank, legacyRankColour, and rankBadge.

Guild season leaderboard types are dynamic and use the guildSeason... format returned by GET /leaderboards/types, such as guildSeason32.

Raid leaderboards include a score and gambits used. Completion starts at 200, then adds +10, +20, or +30 for each gambit.

previousRanking is stored daily depending on player activity. Subtracting previousRanking from the current ranking gives the player's leaderboard progression.

get/leaderboards/{lb_type}

Path parameters

lb_typestring required

Leaderboard identifier such as playerContent.

Query parameters

resultLimitinteger

Defaults to 100.

Response

Leaderboard entries keyed by ranking position.

object required

Changes

No recorded changes to this endpoint across all 1 revision of this API.