Leaderboards

Get the API key owner's player rank

Changed on

Returns the API key owner's own rank in the global player leaderboard (the principal is ranked, so there is no identifier path param, unlike the team and organization rank endpoints). Sort with sortBy (wins, winRate, or experience; default wins). rank is null when the owner has no completed matches, has a private profile, is currently banned, or ranks beyond the bounded best-effort scan window (about 2000 entries). gameSlug is not supported and returns 400. Requires users.profile:read.

get/leaderboards/players/me/rank

Request

  • Base URL
    https://teambattles.gg/api/v1
  • URL
    https://teambattles.gg/api/v1/leaderboards/players/me/rank
  • Auth
    HTTP bearer

Query parameters

sortBy'wins' | 'winRate' | 'experience'

Supported leaderboard sort field.

Response

Player rank.

idstring required

Resolved entity ID.

rankinteger nullable required
sortBy'wins' | 'winRate' | 'experience' required

Supported leaderboard sort field.

gameSlugstring nullable
timestampstring required

Changes