Users
Autocomplete usernames
Provides autocompletion options for an incomplete username.
get/api/player/autocomplete
Request
- Base URLhttps://lichess.org
- URLhttps://lichess.org/api/player/autocomplete
- Auth
- none
- or OAuth 2Authorization code: https://lichess.org/oauthToken URL: https://lichess.org/api/token
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.
Changes
No recorded changes to this operation across all 16 revisions of this API.