A leaderboard API that does more than return the global top 10.
Create boards with best, replace or sum scoring; read top and around-player standings; keep seasons; and move competitive score submission behind a trusted server token when cheating matters.
key: weekly_wins
sort_order: desc
update_strategy: sum
reset_schedule: weekly
reads:
top
player standing
around player Verify the ranking surface in the API contract.
The OpenAPI spec documents board creation, score submission, top rankings, player standing and around-player endpoints. For a competitive board, inspect the credential boundary as carefully as the ranking features.
Live API status
A live check of the hosted API right now. No made-up uptime percentage and no hidden demo environment.
Check current statusPublic API contract
The hosted HTTP surface is documented as OpenAPI. Inspect the wire format before choosing an SDK or writing an adapter.
Open the specMIT client SDKs
The JavaScript, Godot, Unity, and Roblox client SDK source is public. The hosted backend itself remains a managed proprietary service.
Inspect the SDK sourceDocumented exit path
Read what is exportable today and the written commitment for advance notice plus an export window if the hosted service winds down.
Read the exit guaranteeScore validation guide
Player-side score submission is convenient; trusted server-side submission is the safer boundary when scores unlock rewards or status.
Harden score submissionChoose score semantics
best keeps the better result, replace takes the latest value, and sum adds each accepted submission to the player total. Optional min/max bounds apply to the submitted value, not to the accumulated total.
Rank around the player
Global top lists are only one view. Fetch the player standing and nearby ranks for the surface players return to.
Keep trust server-side
For competitive boards, let the authoritative game server decide the result and submit with a server token instead of trusting client claims.
Create one board, submit three scores, query around one player.
That test exercises the ranking behavior you will actually ship and exposes whether your score-authority model is safe enough before you wire UI around it.
Frequently asked questions
What leaderboard update modes does Crux support?
A leaderboard can use replace, best or sum update strategy, ascending or descending sort order, optional per-submission score bounds, and an optional seasonal reset schedule.
Can a player submit their own score?
The API accepts player-authenticated score submissions, but competitive games should submit authoritative results from a trusted server token so a modified client cannot invent a score.
Can I show more than the global top list?
Yes. Crux exposes top rankings, an individual player standing and around-player ranking windows; the API also keeps leaderboard seasons.