Get a snapshot
One past version of a leaderboard, page by page.
Returns the rows of one snapshot exactly as the board stood at that moment. Snapshots never change once they are complete, so responses are cached for 5 minutes and you can cache them forever on your side.
Authentication
Cached for
Data updates
Path parameters
boardstringrequiredThe board the snapshot belongs to.
moneydeathsplaytimeplacedBlocksbrokenBlocksmobsKilledidintegerrequiredSnapshot id from list snapshots.
Query parameters
pageintegeroptionaldefault1Page to return, starting at 1.
1 to 100,000limitintegeroptionaldefault100Entries per page.
1 to 500
Response
The snapshot and one page of rows.
snapshotSnapshotThe snapshot you asked for.
ShowHide6 child fields
idintegerSnapshot id. Use it with
/v1/leaderboards/{board}/snapshots/{id}.boardstringBoard id.
daystringUTC date the snapshot belongs to,
YYYY-MM-DD.startedAttimestampWhen the snapshot started.
finishedAttimestampWhen the snapshot was complete.
entriesintegerPlayers on the board at that time.
pageintegerThe page you asked for.
limitintegerRows per page.
totalintegerRows in the whole snapshot.
entriesobject[]Rows, best first.
ShowHide4 child fields
rankintegerPosition, starting at 1.
usernamestringThe player.
uuidstring | nullMinecraft UUID, once known.
valuenumberThe ranked value: money, a count, seconds of playtime or a bounty.
