Skip to content
DonutStatsAPI
Sign up
Players

Search players

Autocomplete usernames as someone types.

GET/v1/players/search

Finds players whose username starts with q. An exact match always comes first, then the richest players, then the most recently seen. It is built for search boxes: fast, small and cached.

Authentication

API key with the read scope

Cached for

30 s

Data updates

Live.

Query parameters

  • qstringrequired

    Start of a username. Letters, digits and underscores, with an optional leading dot.

    1 to 16 characters
  • limitintegeroptionaldefault 10

    Players to return.

    1 to 25

Response

Matching players, best match first.

  • playersobject[]

    Up to limit players.

    Show3 child fields
    • usernamestring

      Username with its current capitalization.

    • moneynumber | null

      Balance in DonutSMP dollars, when known.

    • lastSeenAttimestamp

      When the player last showed up anywhere.