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 Users API

Access registered users on Lichess.- Each user blog exposes an atom (RSS) feed, like - User blogs mashup feed: https://lichess.org/blog/community.atom- User blogs mashup feed for a language: https://lichess.org/blog/community/fr.atom

Lichess Users 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 User. 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 13 operations across 12 paths, and defines 32 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.

13 operations 12 paths 32 schemas 11 GET2 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 Users 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 13

Across 12 paths, the API surfaces 13 operations — 11 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Users 13

Access registered users on Lichess. - Each user blog exposes an atom (RSS) feed, like - User blogs mashup feed: https://lichess.org/blog/community.atom - User blogs mashup feed fo…

GET
/api/users/status
Get real-time users status
apiUsersStatus 4 params → 200
GET
/api/player
Get all top 10
player → 200
GET
/api/player/top/{nb}/{perfType}
Get one leaderboard
playerTopNbPerfType 2 params → 200
GET
/api/user/{username}
Get user public data
apiUser 5 params → 200
GET
/api/user/{username}/rating-history
Get rating history of a user
apiUserRatingHistory 1 param → 200
GET
/api/user/{username}/perf/{perf}
Get performance statistics of a user
apiUserPerf 2 params → 200
GET
/api/user/{username}/activity
Get user activity
apiUserActivity 1 param → 200
POST
/api/users
Get users by ID
apiUsers 2 params body → 200
GET
/api/streamer/live
Get live streamers
streamerLive → 200
GET
/api/crosstable/{user1}/{user2}
Get crosstable
apiCrosstable 3 params → 200
GET
/api/player/autocomplete
Autocomplete usernames
apiPlayerAutocomplete 9 params → 200
POST
/api/user/{username}/note
Add a note for a user
writeNote 1 param body → 200
GET
/api/user/{username}/note
Get notes for a user
readNote 1 param → 200

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are Perfs (18 properties), UserActivity (17 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…
LightUserOnline
UserActivity
object
17 properties 1 required
PlayTime
object
3 properties 2 required
Patron
boolean
Use patronColor value instead to determine if player is a patron.
Count
object
13 properties 9 required
VariantKey
string
GameColor
string
RatingHistory
array
PerfStat
object
5 properties 5 required
UserExtended
Leaderboard
object
1 property 1 required
UserStreamer
object
2 properties
Ok
object
1 property 1 required
PerfType
string
UserNote
object
4 properties
Profile
object
11 properties
Flair
string
See [available flair list and images](https://github.com/lichess-org/lila/tree/master/public/flair)
Perf
object
6 properties 4 required
Top10s
object
13 properties 13 required
TopUser
object
7 properties 2 required
UserActivityFollowList
object
2 properties 1 required
User
object
14 properties 2 required
Perfs
object
18 properties
PerfTop10
array
LightUser
object
6 properties 2 required
RatingHistoryEntry
object
2 properties
Crosstable
object
2 properties 2 required
Title
string
only appears if the user is a titled player or a bot user
UserActivityCorrespondenceGame
object
8 properties 4 required
UserActivityScore
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lichess-users-api-openapi.yml Raw ↑

Other APIs Lichess publishes across the network.

Lichess Account API
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
Where this information came from

This is an independent, third-party profile of Lichess Users 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.