How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Lichess Account API

Read and write account information and preferences.

Lichess Account API is one of 23 APIs that Lichess publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Account. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, a JSON-LD context, and 2 JSON Schemas.

This API exposes 6 operations across 5 paths, and defines 31 schemas. It is described by OpenAPI 3.1.0, at version 2.0.144.

Requests are made against 4 base URLs: https://lichess.org, https://lichess.dev, http://localhost:{port}, http://l.org.

6 operations 5 paths 31 schemas 5 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.144
Base URL
https://lichess.org
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Lichess Account API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 23 scopes.

  • OAuth2 — Read [the introduction for how to make authenticated requests](description/authentication).

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 5 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Account 6

Read and write account information and preferences.

GET
/api/account
Get my profile
accountMe → 200
GET
/api/account/email
Get my email address
accountEmail → 200
GET
/api/account/preferences
Get my preferences
account → 200
GET
/api/account/kid
Get my kid mode status
accountKid → 200
POST
/api/account/kid
Set my kid mode status
accountKidPost 1 param → 200
GET
/api/timeline
Get my timeline
timeline 2 params → 200

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are UserPreferences (39 properties), Perfs (18 properties), User (14 properties), Count (13 properties). Each schema is shown below with its type and property counts.

PuzzleModePerf
object
2 properties 2 required
PatronColor
integer
Players can choose a color for their Patron wings. See [here for the color mappings](https://github.com/lichess-org/lila/blob/master/ui/lib/css/abstract/patron…
TimelineEntryGameEnd
object
3 properties 3 required
PlayTime
object
3 properties 2 required
Timeline
object
2 properties 2 required
Patron
boolean
Use patronColor value instead to determine if player is a patron.
Count
object
13 properties 9 required
TimelineEntryFollow
object
3 properties 3 required
UserExtended
UserStreamer
object
2 properties
Ok
object
1 property 1 required
PerfType
string
TimelineEntryPlanStart
object
3 properties 3 required
TimelineEntryForumPost
object
3 properties 3 required
UserPreferences
object
39 properties
Profile
object
11 properties
TimelineEntryUblogPost
object
3 properties 3 required
TimelineEntryStreamStart
object
3 properties 3 required
Flair
string
See [available flair list and images](https://github.com/lichess-org/lila/tree/master/public/flair)
Perf
object
6 properties 4 required
TimelineEntryTeamJoin
object
3 properties 3 required
TimelineEntryUblogPostLike
object
3 properties 3 required
TimelineEntrySimul
object
3 properties 3 required
User
object
14 properties 2 required
Perfs
object
18 properties
TimelineEntryBlogPost
object
3 properties 3 required
TimelineEntryTourJoin
object
3 properties 3 required
Title
string
only appears if the user is a titled player or a bot user
TimelineEntryTeamCreate
object
3 properties 3 required
TimelineEntryPlanRenew
object
3 properties 3 required
TimelineEntryStudyLike
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lichess-account-api-openapi.yml Raw ↑

Other APIs Lichess publishes across the network.

Lichess Analysis API
Lichess Board API
Lichess Bot API
Lichess Broadcasts API
Lichess Bulk pairings API
Lichess Challenges API
Lichess External engine API
Lichess FIDE API
Lichess Games API
Lichess Messaging API
Lichess OAuth API
Lichess Opening Explorer API
Where this information came from

This is an independent, third-party profile of Lichess Account API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.