Skip to content
DonutStatsAPI
Sign up
Leaderboards

List leaderboard snapshots

Every complete version of a leaderboard ever recorded.

GET/v1/leaderboards/{board}/snapshots

A new snapshot of each DonutSMP leaderboard is recorded every 6 hours and kept forever. This lists them newest first. Read one in full with get a snapshot.

Use from and to to find the snapshot closest to a date, for example the baltop on the first of the month.

Authentication

API key with the read scope

Cached for

1 min

Data updates

A new snapshot every 6 hours.

Path parameters

  • boardstringrequired

    Which board. Only DonutSMP boards have snapshots.

    moneydeathsplaytimeplacedBlocksbrokenBlocksmobsKilled

Query parameters

  • fromtimestampoptional

    Only entries at or after this time, in Unix milliseconds.

  • totimestampoptional

    Only entries before this time, in Unix milliseconds.

  • limitintegeroptionaldefault 100

    Entries per page.

    1 to 500
  • cursorstringoptional

    The next value from the previous response. Leave it out for the first page. See cursors.

Response

A feed of snapshots, newest first. Filters apply to finishedAt.

  • limitinteger

    Entries per page.

  • nextstring | null

    Pass this as cursor to get the next page. null on the last page.

  • entriesSnapshot[]

    The entries on this page, newest first.

    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.

Status codes

StatusWhen
400Bad RequestUnknown board, or a malformed cursor.