LIlichess
Users

Get users by ID

Get up to 300 users by their IDs. Users are returned in the same order as the IDs. The method is POST to allow a longer list of IDs to be sent in the request body. Please do not try to download all the Lichess users with this endpoint, or any other endpoint. An API is not a way to fully export a website. We do not provide a full download of the Lichess users. This endpoint is limited to 8,000 users every 10 minutes, and 120,000 every day.

post/api/users

Request

  • Base URL
    https://lichess.org
  • URL
    https://lichess.org/api/users
  • Auth
    none required

Query parameters

profileboolean

Include user profile data

rankboolean

Include global lichess ranking for each perf

Request body text/plain

string required

Response

The list of users.

idstring required
usernamestring required
title'GM' | 'WGM' | 'IM' | 'WIM' | 'FM' | 'WFM' | 'NM' | 'CM' | 'WCM' | 'WNM' | 'LM' | 'BOT'

only appears if the user is a titled player or a bot user

flairstring

See available flair list and images

createdAtinteger
disabledboolean

only appears if a user's account is closed

tosViolationboolean

only appears if a user's account is marked for the violation of Lichess TOS

seenAtinteger
patronboolean

Use patronColor value instead to determine if player is a patron.

patronColorinteger

Players can choose a color for their Patron wings. See here for the color mappings.

The presence of this field indicates the player is an active Patron.

verifiedboolean

Changes

No recorded changes to this operation across all 16 revisions of this API.