LIlichess
Users

Get user public data

Read public data of a user.

get/api/user/{username}

Request

  • Base URL
    https://lichess.org
  • URL
    https://lichess.org/api/user/{username}
  • Auth
    OAuth 2
    Authorization code: https://lichess.org/oauth
    Token URL: https://lichess.org/api/token

Path parameters

usernamestring required

Query parameters

trophiesboolean

Include user trophies

profileboolean

Include user profile data

rankboolean

Include global lichess ranking for each perf

fideIdboolean

Include public FIDE ID if any

Response

The information of the user.

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
urlstring uri required
playingstring uri
streamingboolean
followableboolean

only appears if the request is authenticated with OAuth2

followingboolean

only appears if the request is authenticated with OAuth2

blockingboolean

only appears if the request is authenticated with OAuth2

fideIdnumber

Changes

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