Overview

Get status

How much data there is and how fresh each dataset is.

GET/v1/status

One call that tells you the size and age of everything: tracked players, every leaderboard, the auction house, buy orders, priced items and the server. Use the updatedAt fields to show freshness in your own app.

Authentication

API key with the read scope

Cached for

10 s

Data updates

Live. Each dataset reports its own updatedAt.

curl "https://api.donutstats.io/v1/status" \
  -H "x-api-key: $DONUTSTATS_API_KEY"

Response200OK

{
  "players": 458683,
  "playersWithStats": 138504,
  "boards": [
    {
      "id": "money",
      "label": "Money",
      "stat": "money",
      "source": "leaderboard",
      "updatedAt": 1792694462533,
      "entries": 89727
    },
    {
      "id": "deaths",
      "label": "Deaths",
      "stat": "deaths",
      "source": "leaderboard",
      "updatedAt": 1792722232417,
      "entries": 1125
    }
  ],
  "orders": {
    "open": 14033,
    "openValue": 2021066961598.28,
    "new24h": 385862,
    "closed24h": 383926,
    "filled24h": 11920827679,
    "paidOut24h": 2465690883952.89,
    "updatedAt": 1792724121936
  },
  "auction": {
    "open": 111050,
    "liquidValue": 82786430718.73,
    "new24h": 1848145,
    "closed24h": 1844025,
    "updatedAt": 1792724122973
  },
  "items": 2770,
  "server": {
    "online": 19551,
    "updatedAt": 1792724136015
  }
}

Try itCounts towards your plan

This endpoint takes no parameters.

Response

Counts and freshness for every dataset.

playersinteger
Players on record.
playersWithStatsinteger
Players with full stats on record.
boardsBoard[]
Every leaderboard with its size and age.
ShowHide6 child fields
- idstring
  Board id: money, deaths, playtime, placedBlocks, brokenBlocks, mobsKilled, kills, shards or bounties.
- labelstring
  Human readable name, for example Blocks Placed.
- statstring
  The stat the board ranks, or bounty.
- sourcestring
  leaderboard for DonutSMP's own leaderboards, tracked for boards DonutStats ranks itself (kills and shards, which DonutSMP has no leaderboard for), bounty for the bounty board.
- updatedAttimestamp | null
  When the board last changed.
- entriesinteger
  Players on the board.
ordersobject
Same as GET /v1/orders/summary.
ShowHide7 child fields
- openinteger
  Open buy orders that still want items, lowballs left out.
- openValuenumber
  Money those orders would still pay out.
- new24hinteger
  Orders placed in the last 24 hours.
- closed24hinteger
  Orders that closed in the last 24 hours.
- filled24hinteger
  Items delivered to orders in the last 24 hours.
- paidOut24hnumber
  Money orders paid out in the last 24 hours.
- updatedAttimestamp | null
  When the buy orders were last refreshed.
auctionobject
Same as GET /v1/auction/summary.
ShowHide5 child fields
- openinteger
  Open auction listings.
- liquidValuenumber
  What the auction house could be sold for right now into buy orders: for each product, the smaller of items listed and items wanted, times the best bid.
- new24hinteger
  Listings created in the last 24 hours.
- closed24hinteger
  Listings that left the auction house in the last 24 hours: sold, cancelled or expired.
- updatedAttimestamp | null
  When the auction house was last refreshed.
itemsinteger
Products with a current price.
serverobject
Latest server check.
ShowHide2 child fields
- onlineinteger | null
  Players online.
- updatedAttimestamp | null
  When the server was checked.