Skip to content
DonutStatsAPI
Sign up
Leaderboards

Get a snapshot

One past version of a leaderboard, page by page.

GET/v1/leaderboards/{board}/snapshots/{id}

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

API key with the read scope

Cached for

5 min

Data updates

Never changes.

Path parameters

  • boardstringrequired

    The board the snapshot belongs to.

    moneydeathsplaytimeplacedBlocksbrokenBlocksmobsKilled
  • idintegerrequired

    Snapshot id from list snapshots.

Query parameters

  • pageintegeroptionaldefault 1

    Page to return, starting at 1.

    1 to 100,000
  • limitintegeroptionaldefault 100

    Entries per page.

    1 to 500

Response

The snapshot and one page of rows.

  • snapshotSnapshot

    The snapshot you asked for.

    Show6 child fields
    • idinteger

      Snapshot id. Use it with /v1/leaderboards/{board}/snapshots/{id}.

    • boardstring

      Board id.

    • daystring

      UTC date the snapshot belongs to, YYYY-MM-DD.

    • startedAttimestamp

      When the snapshot started.

    • finishedAttimestamp

      When the snapshot was complete.

    • entriesinteger

      Players on the board at that time.

  • pageinteger

    The page you asked for.

  • limitinteger

    Rows per page.

  • totalinteger

    Rows in the whole snapshot.

  • entriesobject[]

    Rows, best first.

    Show4 child fields
    • rankinteger

      Position, starting at 1.

    • usernamestring

      The player.

    • uuidstring | null

      Minecraft UUID, once known.

    • valuenumber

      The ranked value: money, a count, seconds of playtime or a bounty.

Status codes

StatusWhen
400Bad RequestUnknown board or a malformed id.
404Not FoundNo complete snapshot with this id on this board.