menu_bookDocumentation
Leaderboard Web API: Public REST Endpoint with Aggregation and Filtering
The s&box leaderboard Web API is publicly accessible for querying player rankings based on stats.
Endpoint
https://services.facepunch.com/sbox/package/leaderboard/{packageident}/?stat={statname}Parameters
- stat — stat name to base the leaderboard on (doesn't need formal registration)
- count (default 10) — number of results to return
- offset (default 0) — start position; negative values start from the bottom
- aggregation (default sum) — how to aggregate: sum, max, min, avg, last
- sort (default desc) — desc (highest first) or asc (lowest first)
- datefilter (default none) — time period: none, year, month, week, day
- date (default now) — specific date for datefilter period
- centersteamid — center results on a SteamId
- country — limit to country code, or auto for current user
- friends (default false) — limit to logged-in user's friends
- include[] — list of SteamIds to always show (e.g., current player)
Response Example
JSON
{
"Stat": "zombies_killed",
"TotalEntries": 2588,
"Entries": [
{ "Rank": 1, "Value": 645806, "SteamId": 76561198043785940, "DisplayName": "puxorb" }
]
}
Was this helpful?