v3

latestOpenAPI 3.1.0AGPL-3.0-or-later2026-07-311871891.1 MB
Users

Autocomplete usernames

Provides autocompletion options for an incomplete username.

get/api/player/autocomplete

Query parameters

termstring required

The beginning of a username

existsboolean

If true, only checks if the user exists.

objectboolean
  • false returns an array of usernames
  • true returns an object with matching users
namesboolean
  • false returns an array of usernames
  • true returns an array of usernames with preferred casing
friendboolean

Returns followed players matching term if any, else returns other players. Requires OAuth.

teamstring

Search within a team. Use team ID/slug.

tourstring

Search within a arena tournament. Use tournament ID.

swissstring

Search within a Swiss tournament.

teacherboolean

Only search for players who also have a teacher role.

Response

An array of players which usernames start with the provided term.

string[] required
OR