Players

Top players

Player leaderboard for a region.

get/{region}/players/top

Request

  • Base URL: https://unicum.gg/api
  • URL: https://unicum.gg/api/{region}/players/top
  • Auth: none required

Path parameters

region'eu' | 'na' | 'asia' required

Game server region.

Query parameters

period'24h' | '7d' | '30d' | 'overall'

Leaderboard time window.

Example:overall
limitinteger

Maximum number of rows to return. Out-of-range values are clamped.

metric'wn7' | 'wn8' | 'wnx'

Rating metric the leaderboard is ranked by.

langstring

Two-letter language code. When set, the leaderboard is filtered to players whose clan history infers this language, over the requested period like the unfiltered board.

languagestring

Deprecated alias of lang, accepted while callers move. lang wins when both are given. Renamed because language elsewhere in this API asks for the language the ANSWER is written in, and this one selects which rows are in it.

strict'true' | 'false'

With lang: only count clans that declare exactly this one language.

languages'true' | 'false'

Return the lifetime by-language board (each row carries its inferred languages) without filtering to one language. The recent periods always carry them.

Response

Successful response

computed_atstring nullable required

Changes

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