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

Send and receive challenges to play.To create a lot of challenges, consider [bulk pairing](#tag/bulk-pairings/POST/api/bulk-pairing) instead.

Lichess Challenges 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 Challenges. 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 11 operations across 11 paths, and defines 23 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.

11 operations 11 paths 23 schemas 2 GET9 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 Challenges 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 11

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

Challenges 11

Send and receive challenges to play. To create a lot of challenges, consider [bulk pairing](tag/bulk-pairings/POST/api/bulk-pairing) instead.

GET
/api/challenge
List your challenges
challengeList → 200
POST
/api/challenge/{username}
Create a challenge
challengeCreate 1 param body → 200400
GET
/api/challenge/{challengeId}/show
Show one challenge
challengeShow 1 param → 200
POST
/api/challenge/{challengeId}/accept
Accept a challenge
challengeAccept 2 params → 200404
POST
/api/challenge/{challengeId}/decline
Decline a challenge
challengeDecline 1 param body → 200404
POST
/api/challenge/{challengeId}/cancel
Cancel a challenge
challengeCancel 2 params → 200404
POST
/api/challenge/ai
Challenge the AI
challengeAi body → 201400
POST
/api/challenge/open
Open-ended challenge
challengeOpen body → 200400
POST
/api/challenge/{gameId}/start-clocks
Start clocks of a game
challengeStartClocks 3 params → 200
POST
/api/round/{gameId}/add-time/{seconds}
Add time to the opponent clock
roundAddTime 2 params → 200
POST
/api/token/admin-challenge
Admin challenge tokens
adminChallengeTokens body → 200400

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are ChallengeOpenJson (16 properties), ChallengeJson (15 properties), ChallengeUser (10 properties), Variant (3 properties). Each schema is shown below with its type and property counts.

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…
FromPositionFEN
string
Custom initial position (in X-FEN). Variant must be standard, fromPosition, or chess960 (if a valid 960 starting position), and the game cannot be rated.
ChallengeColor
string
Variant
object
3 properties 2 required
Patron
boolean
Use patronColor value instead to determine if player is a patron.
VariantKey
string
ChallengeUser
object
10 properties 2 required
GameColor
string
NotFound
object
1 property 1 required
ChallengeOpenJson
object
16 properties 14 required
Ok
object
1 property 1 required
PerfType
string
GameStatusId
integer
Flair
string
See [available flair list and images](https://github.com/lichess-org/lila/tree/master/public/flair)
Error
object
1 property 1 required
ChallengeStatus
string
GameStatusName
string
Speed
string
ChallengeJson
object
15 properties 11 required
GameSource
string
TimeControl
Title
string
only appears if the user is a titled player or a bot user
GameStatus
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lichess-challenges-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 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 Challenges 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.