X-API-Key header. Get your key from the Developer Dashboard.
The index covers players linked through SkyTools rather than all of Hypixel. Use
GET /v1/leaderboard/search to check whether a player is indexed.GET /v1/leaderboard/rankings
Ranked player leaderboard for a single category and game mode. Cache: 2 minutesQuery parameters
Example
Response
Errors
GET /v1/leaderboard/guilds
Ranked guild leaderboard. Cache: 2 minutesQuery parameters
Example
Response
Errors
GET /v1/leaderboard/player/:uuid
Returns a single indexed player’s stats and rankings, one entry per profile. Cache: 5 minutesPath parameters
Example
Response
Errors
GET /v1/leaderboard/search
Search the player index by username prefix. Handy for autocomplete and resolving whether a player is tracked. Cache: 1 minuteQuery parameters
Example
Response
Errors
GET /v1/leaderboard/stats
Index-wide statistics plus the list of available categories and guild sort options. Cache: 5 minutesExample
Response
GET /v1/leaderboard/categories
Returns every available leaderboard category, grouped by type. Use these keys as thecategory parameter for /rankings.
Cache: 1 hour
