Overview

API index

Every endpoint and its query parameters, in one list.

GET/v1

Returns the API name, its version and a compact list of every endpoint. It does not need a key, which makes it a quick way to check you can reach the API.

Authentication

None needed

Cached for

Not cached

Data updates

Static.

curl "https://api.donutstats.io/v1"

Response200OK

{
  "name": "DonutStats API",
  "version": 1,
  "endpoints": [
    "GET /v1/status",
    "GET /v1/players?sort=money|recent|trending&q=&page=&limit="
  ]
}

Try itNo key needed

This endpoint takes no parameters.

Response

An object describing the API.

namestring
Always DonutStats API.
versioninteger
Major API version. Breaking changes ship as a new version.
endpointsstring[]
Every endpoint as METHOD /path?param=values.