v3

OpenAPI 3.1.0AGPL-3.0-or-later2026-07-311871891.1 MB

Account

Get my profile

Public information about the logged in user.

get/api/account

Response

The public information about the logged in 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

Example response

{
  "profile": {
    "flag": "EC",
    "bio": "Free bugs!",
    "realName": "Thibault Duplessis",
    "fideRating": 1500,
    "uscfRating": 1500,
    "ecfRating": 1500,
    "cfcRating": 1500,
    "rcfRating": 1500,
    "dsbRating": 1500,
    "links": "github.com/ornicar\r\nmas.to/@thibault"
  },
  "streamer": {
    "twitch": {
      "channel": "https://www.twitch.tv/lichessdotorg"
    },
    "youtube": {
      "channel": "https://www.youtube.com/c/LichessDotOrg"
    }
  }
}