Lichess.org API reference (2.0.0)

Download OpenAPI specification:Download

Introduction

Welcome to the reference for the Lichess API! Lichess is free/libre, open-source chess server powered by volunteers and donations.

Endpoint

All requests go to https://lichess.org (unless otherwise specified).

Rate limiting

All requests are rate limited using various strategies, to ensure the API remains responsive for everyone. Only make one request at a time. If you receive an HTTP response with a 429 status, please wait a full minute before resuming API usage.

Streaming with ND-JSON

Some API endpoints stream their responses as Newline Delimited JSON a.k.a. nd-json, with one JSON object per line.

Here's a JavaScript utility function to help reading NDJSON streamed responses.

Authentication

Which authentication method is right for me?

Read about the Lichess API authentication methods and code examples

Personal Access Token

Personal API access tokens allow you to quickly interact with Lichess API without going through an OAuth flow.

Authorization Code Flow with PKCE

The authorization code flow with PKCE allows your users to login with Lichess. Lichess supports unregistered and public clients (no client authentication, choose any unique client id). The only accepted code challenge method is S256. Access tokens are long-lived (expect one year), unless they are revoked. Refresh tokens are not supported.

See the documentation for the OAuth endpoints or the PKCE RFC for a precise protocol description.

Real life examples

Token format

Access tokens and authorization codes match ^[A-Za-z0-9_]+$. The length of tokens can be increased without notice. Make sure your application can handle at least 512 characters. By convention tokens have a recognizable prefix, but do not rely on this.

Account

Read and write account information and preferences. https://lichess.org/account/preferences/game-display

Get my profile

Public information about the logged in user.

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "id": "georges",
  • "username": "Georges",
  • "perfs": {
    },
  • "createdAt": 1290415680000,
  • "disabled": false,
  • "tosViolation": false,
  • "profile": {
    },
  • "seenAt": 1522636452014,
  • "patron": true,
  • "verified": true,
  • "playTime": {
    },
  • "title": "NM",
  • "count": {
    },
  • "streaming": false,
  • "streamer": {},
  • "followable": true,
  • "following": false,
  • "blocking": false,
  • "followsYou": false
}

Get my email address

Read the email address of the logged in user.

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "email": "abathur@mail.org"
}

Get my preferences

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "prefs": {
    },
  • "language": "en-GB"
}

Get my kid mode status

Read the kid mode status of the logged in user.

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "kid": false
}

Set my kid mode status

Set the kid mode status of the logged in user.

Authorizations:
OAuth2
query Parameters
v
required
boolean
Example: v=true

Kid mode status

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Users

Access registered users on Lichess. https://lichess.org/player

Get real-time users status

Read the online, playing and streaming flags of several users.

This API is very fast and cheap on lichess side. So you can call it quite often (like once every 5 seconds).

Use it to track players and know when they're connected on lichess and playing games.

query Parameters
ids
required
string
Example: ids=aliquantus,chess-network,lovlas

User IDs separated by commas. Up to 100 IDs.

withGameIds
boolean
Example: withGameIds=true

Also return the ID of the game being played, if any, for each player, in a playingId field. Defaults to false to preserve server resources.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Get all top 10

Get the top 10 players for each speed and variant.

See https://lichess.org/player.

Responses

Response samples

Content type
application/json
{
  • "bullet": [
    ],
  • "blitz": [ ],
  • "rapid": [ ],
  • "classical": [ ],
  • "ultraBullet": [ ],
  • "chess960": [ ],
  • "crazyhouse": [ ],
  • "antichess": [ ],
  • "atomic": [ ],
  • "horde": [ ],
  • "kingOfTheHill": [ ],
  • "racingKings": [ ],
  • "threeCheck": [ ]
}

Get one leaderboard

Get the leaderboard for a single speed or variant (a.k.a. perfType). There is no leaderboard for correspondence or puzzles.

See https://lichess.org/player/top/200/bullet.

path Parameters
nb
required
integer [ 1 .. 200 ]
Example: 100

How many users to fetch

perfType
required
string
Enum: "ultraBullet" "bullet" "blitz" "rapid" "classical" "chess960" "crazyhouse" "antichess" "atomic" "horde" "kingOfTheHill" "racingKings" "threeCheck"
Example: bullet

The speed or variant

Responses

Response samples

Content type
application/vnd.lichess.v3+json
{
  • "users": [
    ]
}

Get user public data

Read public data of a user.

If the request is authenticated with OAuth2, then extra fields might be present in the response: followable, following, blocking, followsYou.

Authorizations:
OAuth2
path Parameters
username
required
string
query Parameters
trophies
boolean
Default: false

Include user trophies

Responses

Response samples

Content type
application/json
{
  • "id": "georges",
  • "username": "Georges",
  • "perfs": {
    },
  • "createdAt": 1290415680000,
  • "disabled": false,
  • "tosViolation": false,
  • "profile": {
    },
  • "seenAt": 1522636452014,
  • "patron": true,
  • "verified": true,
  • "playTime": {
    },
  • "title": "NM",
  • "count": {
    },
  • "streaming": false,
  • "streamer": {},
  • "followable": true,
  • "following": false,
  • "blocking": false,
  • "followsYou": false
}

Get rating history of a user

Read rating history of a user, for all perf types. There is at most one entry per day. Format of an entry is [year, month, day, rating]. month starts at zero (January).

path Parameters
username
required
string

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Get performance statistics of a user

Read performance statistics of a user, for a single performance. Similar to the performance pages on the website.

path Parameters
username
required
string
perf
required
string (PerfType)
Enum: "ultraBullet" "bullet" "blitz" "rapid" "classical" "correspondence" "chess960" "crazyhouse" "antichess" "atomic" "horde" "kingOfTheHill" "racingKings" "threeCheck"

Responses

Response samples

Content type
application/json
{
  • "perf": {
    },
  • "rank": 98121,
  • "percentile": 69.7,
  • "stat": {
    }
}

Get user activity

Read data to generate the activity feed of a user.

path Parameters
username
required
string

Responses

Response samples

Get users by ID

Get up to 300 users by their IDs. Users are returned in the same order as the IDs.

The method is POST to allow a longer list of IDs to be sent in the request body.

Please do not try to download all the Lichess users with this endpoint, or any other endpoint. An API is not a way to fully export a website. We do not provide a full download of the Lichess users.

This endpoint is limited to 8,000 users every 10 minutes, and 120,000 every day.

Request Body schema: text/plain
required

User IDs separated by commas.

string

Responses

Request samples

Content type
text/plain
aliquantus,chess-network,lovlas

Response samples

Content type
application/json
[
  • {
    }
]

Get live streamers

Get basic info about currently streaming users.

This API is very fast and cheap on lichess side. So you can call it quite often (like once every 5 seconds).

Responses

Response samples

Content type
application/json
[]

Get crosstable

Get total number of games, and current score, of any two users.

If the matchup flag is provided, and the users are currently playing, also gets the current match game number and scores.

path Parameters
user1
required
string
user2
required
string
query Parameters
matchup
boolean

Whether to get the current match data, if any

Responses

Response samples

Content type
application/json
{
  • "users": {
    },
  • "nbGames": 346,
  • "matchup": {
    }
}

Autocomplete usernames

Provides autocompletion options for an incomplete username.

query Parameters
term
required
string >= 3 characters

The beginning of a username

object
boolean
Default: false
  • false returns an array of usernames
  • true returns an object with matching users
friend
boolean

Returns followed players matching term if any, else returns other players. Requires OAuth.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ]
}

Add a note for a user

Add a private note available only to you about this account.

Authorizations:
OAuth2
path Parameters
username
required
string
Example: thibault
Request Body schema: application/x-www-form-urlencoded
required
text
required
string

The contents of the note

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Get notes for a user

Get the private notes that you have added for a user.

Authorizations:
OAuth2
path Parameters
username
required
string
Example: thibault

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Relations

Access relations between users.

Get users followed by the logged in user

Users are streamed as ndjson.

Authorizations:
OAuth2

Responses

Response samples

Content type
application/x-ndjson
{
  • "id": "georges",
  • "username": "Georges",
  • "perfs": {
    },
  • "createdAt": 1290415680000,
  • "disabled": false,
  • "tosViolation": false,
  • "profile": {
    },
  • "seenAt": 1522636452014,
  • "patron": true,
  • "verified": true,
  • "playTime": {
    },
  • "title": "NM",
  • "count": {
    },
  • "streaming": false,
  • "streamer": {},
  • "followable": true,
  • "following": false,
  • "blocking": false,
  • "followsYou": false
}

Follow a player

Follow a player, adding them to your list of Lichess friends.

Authorizations:
OAuth2
path Parameters
username
required
string
Example: thibault

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Unfollow a player

Unfollow a player, removing them from your list of Lichess friends.

Authorizations:
OAuth2
path Parameters
username
required
string
Example: thibault

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Games

Access games played on Lichess. https://lichess.org/games

Export one game

Download one game in either PGN or JSON format.

Ongoing games have their last 3 moves omitted after move 5, as to prevent cheat bots from using this API.

path Parameters
gameId
required
string

The game ID (8 characters).

query Parameters
moves
boolean
Default: true

Include the PGN moves.

pgnInJson
boolean
Default: false

Include the full PGN within the JSON response, in a pgn field.

tags
boolean
Default: true

Include the PGN tags.

clocks
boolean
Default: true

Include clock status when available.

Either as PGN comments: 2. exd5 { [%clk 1:01:27] } e5 { [%clk 1:01:28] }

Or in a clocks JSON field, as centisecond integers, depending on the response type.

evals
boolean
Default: true

Include analysis evaluations and comments, when available.

Either as PGN comments: 12. Bxf6 { [%eval 0.23] } a3 { [%eval -1.09] }

Or in an analysis JSON field, depending on the response type.

accuracy
boolean
Default: false

Include accuracy percent of each player, when available.

opening
boolean
Default: true

Include the opening name.

Example: [Opening "King's Gambit Accepted, King's Knight Gambit"]

literate
boolean
Default: false

Insert textual annotations in the PGN about the opening, analysis variations, mistakes, and game termination.

Example: 5... g4? { (-0.98 β†’ 0.60) Mistake. Best move was h6. } (5... h6 6. d4 Ne7 7. g3 d5 8. exd5 fxg3 9. hxg3 c6 10. dxc6)

players
string

URL of a text file containing real names and ratings, to replace Lichess usernames and ratings in the PGN. Example: https://gist.githubusercontent.com/ornicar/6bfa91eb61a2dcae7bcd14cce1b2a4eb/raw/768b9f6cc8a8471d2555e47ba40fb0095e5fba37/gistfile1.txt

Responses

Response samples

Content type
No sample

Export ongoing game of a user

Download the ongoing game, or the last game played, of a user. Available in either PGN or JSON format.

Ongoing games have their last 3 moves omitted after move 5, as to prevent cheat bots from using this API.

path Parameters
username
required
string
query Parameters
moves
boolean
Default: true

Include the PGN moves.

pgnInJson
boolean
Default: false

Include the full PGN within the JSON response, in a pgn field.

tags
boolean
Default: true

Include the PGN tags.

clocks
boolean
Default: true

Include clock status when available.

Either as PGN comments: 2. exd5 { [%clk 1:01:27] } e5 { [%clk 1:01:28] }

Or in a clocks JSON field, as centisecond integers, depending on the response type.

evals
boolean
Default: true

Include analysis evaluations and comments, when available.

Either as PGN comments: 12. Bxf6 { [%eval 0.23] } a3 { [%eval -1.09] }

Or in an analysis JSON field, depending on the response type.

accuracy
boolean
Default: false

Include accuracy percent of each player, when available.

opening
boolean
Default: true

Include the opening name.

Example: [Opening "King's Gambit Accepted, King's Knight Gambit"]

literate
boolean
Default: false

Insert textual annotations in the PGN about the opening, analysis variations, mistakes, and game termination.

Example: 5... g4? { (-0.98 β†’ 0.60) Mistake. Best move was h6. } (5... h6 6. d4 Ne7 7. g3 d5 8. exd5 fxg3 9. hxg3 c6 10. dxc6)

players
string

URL of a text file containing real names and ratings, to replace Lichess usernames and ratings in the PGN. Example: https://gist.githubusercontent.com/ornicar/6bfa91eb61a2dcae7bcd14cce1b2a4eb/raw/768b9f6cc8a8471d2555e47ba40fb0095e5fba37/gistfile1.txt

Responses

Response samples

Content type
No sample

Export games of a user

Download all games of any user in PGN or ndjson format.

Games are sorted by reverse chronological order (most recent first).

We recommend streaming the response, for it can be very long. https://lichess.org/@/german11 for instance has more than 500,000 games.

The game stream is throttled, depending on who is making the request:

  • Anonymous request: 20 games per second
  • OAuth2 authenticated request: 30 games per second
  • Authenticated, downloading your own games: 60 games per second
Authorizations:
OAuth2
path Parameters
username
required
string

The user name.

query Parameters
since
integer >= 1356998400070

Download games played since this timestamp. Defaults to account creation date.

until
integer >= 1356998400070

Download games played until this timestamp. Defaults to now.

max
integer >= 1

How many games to download. Leave empty to download all games.

vs
string

[Filter] Only games played against this opponent

rated
boolean

[Filter] Only rated (true) or casual (false) games

perfType
string
Default: null
Enum: "ultraBullet" "bullet" "blitz" "rapid" "classical" "correspondence" "chess960" "crazyhouse" "antichess" "atomic" "horde" "kingOfTheHill" "racingKings" "threeCheck"

[Filter] Only games in these speeds or variants.

Multiple perf types can be specified, separated by a comma.

Example: blitz,rapid,classical

color
string
Enum: "white" "black"

[Filter] Only games played as this color.

analysed
boolean

[Filter] Only games with or without a computer analysis available

moves
boolean
Default: true

Include the PGN moves.

pgnInJson
boolean
Default: false

Include the full PGN within the JSON response, in a pgn field. The response type must be set to application/x-ndjson by the request Accept header.

tags
boolean
Default: true

Include the PGN tags.

clocks
boolean
Default: false

Include clock status when available.

Either as PGN comments: 2. exd5 { [%clk 1:01:27] } e5 { [%clk 1:01:28] }

Or in a clocks JSON field, as centisecond integers, depending on the response type.

evals
boolean
Default: true

Include analysis evaluations and comments, when available.

Either as PGN comments: 12. Bxf6 { [%eval 0.23] } a3 { [%eval -1.09] }

Or in an analysis JSON field, depending on the response type.

accuracy
boolean
Default: false

Include accuracy percent of each player, when available.

opening
boolean
Default: false

Include the opening name.

Example: [Opening "King's Gambit Accepted, King's Knight Gambit"]

ongoing
boolean
Default: false

Include ongoing games. Their last 3 moves are omitted after move 5, as to prevent cheat bots from using this API.

finished
boolean
Default: true

Include finished games. Set to false to only get ongoing games.

literate
boolean
Default: false

Insert textual annotations in the PGN about the opening, analysis variations, mistakes, and game termination.

Example: 5... g4? { (-0.98 β†’ 0.60) Mistake. Best move was h6. } (5... h6 6. d4 Ne7 7. g3 d5 8. exd5 fxg3 9. hxg3 c6 10. dxc6)

lastFen
boolean
Default: false

Include the FEN notation of the last position of the game.

players
string

URL of a text file containing real names and ratings, to replace Lichess usernames and ratings in the PGN. Example: https://gist.githubusercontent.com/ornicar/6bfa91eb61a2dcae7bcd14cce1b2a4eb/raw/768b9f6cc8a8471d2555e47ba40fb0095e5fba37/gistfile1.txt

sort
string
Default: "dateDesc"
Enum: "dateAsc" "dateDesc"

Sort order of the games.

Responses

Response samples

Content type
No sample

Export games by IDs

Download games by IDs in PGN or ndjson format, depending on the request Accept header.

Games are sorted by reverse chronological order (most recent first)

The method is POST so a longer list of IDs can be sent in the request body.

300 IDs can be submitted.

Ongoing games have their last 3 moves omitted after move 5, as to prevent cheat bots from using this API.

query Parameters
moves
boolean
Default: true

Include the PGN moves.

pgnInJson
boolean
Default: false

Include the full PGN within the JSON response, in a pgn field.

tags
boolean
Default: true

Include the PGN tags.

clocks
boolean
Default: false

Include clock status when available.

Either as PGN comments: 2. exd5 { [%clk 1:01:27] } e5 { [%clk 1:01:28] }

Or in a clocks JSON field, as centisecond integers, depending on the response type.

evals
boolean
Default: true

Include analysis evaluations and comments, when available.

Either as PGN comments: 12. Bxf6 { [%eval 0.23] } a3 { [%eval -1.09] }

Or in an analysis JSON field, depending on the response type.

accuracy
boolean
Default: false

Include accuracy percent of each player, when available.

opening
boolean
Default: false

Include the opening name.

Example: [Opening "King's Gambit Accepted, King's Knight Gambit"]

literate
boolean
Default: false

Insert textual annotations in the PGN about the opening, analysis variations, mistakes, and game termination.

Example: 5... g4? { (-0.98 β†’ 0.60) Mistake. Best move was h6. } (5... h6 6. d4 Ne7 7. g3 d5 8. exd5 fxg3 9. hxg3 c6 10. dxc6)

players
string

URL of a text file containing real names and ratings, to replace Lichess usernames and ratings in the PGN. Example: https://gist.githubusercontent.com/ornicar/6bfa91eb61a2dcae7bcd14cce1b2a4eb/raw/768b9f6cc8a8471d2555e47ba40fb0095e5fba37/gistfile1.txt

Request Body schema: text/plain
required

Game IDs separated by commas. Up to 300.

string

Responses

Request samples

Content type
text/plain
TJxUmbWK,4OtIh2oh,ILwozzRZ

Response samples

Content type
No sample

Stream games of users

Stream the games played between a list of users, in real time. Only games where both players are part of the list are included.

The stream emits an event each time a game is started or finished.

To also get all current ongoing games at the beginning of the stream, use the withCurrentGames flag.

Games are streamed as ndjson.

Maximum number of users: 300.

The method is POST so a longer list of IDs can be sent in the request body.

query Parameters
withCurrentGames
boolean
Default: false

Include the already started games at the beginning of the stream.

Request Body schema: text/plain
required

Up to 300 user IDs separated by commas. Example: aliquantus,chess-network,lovlas

string

Responses

Response samples

Content type
application/x-ndjson
[
  • {
    }
]

Stream games by IDs

Creates a stream of games from an arbitrary streamId, and a list of game IDs.

The stream first outputs the games that already exists, then emits an event each time a game is started or finished.

Games are streamed as ndjson.

Maximum number of games: 500 for anonymous requests, or 1000 for OAuth2 authenticated requests.

While the stream is open, it is possible to add new game IDs to watch.

path Parameters
streamId
required
string
Example: myAppName-someRandomId

Arbitrary stream ID that you can later use to add game IDs to the stream.

Request Body schema: text/plain
required

Up to 500 or 1000 game IDs separated by commas. Example: gameId01,gameId02,gameId03

string

Responses

Response samples

Content type
application/x-ndjson
[
  • {
    }
]

Add game IDs to stream

Add new game IDs for an existing stream to watch. The stream will immediately outputs the games that already exists, then emit an event each time a game is started or finished.

path Parameters
streamId
required
string
Example: myAppName-someRandomId

The stream ID you used to create the stream.

Request Body schema: text/plain
required

Up to 500 or 1000 game IDs separated by commas. Example: gameId04,gameId05,gameId06

string

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Get my ongoing games

Get the ongoing games of the current user. Real-time and correspondence games are included. The most urgent games are listed first.

Authorizations:
OAuth2
query Parameters
nb
integer [ 1 .. 50 ]
Default: 9

Max number of games to fetch

Responses

Response samples

Content type
application/json
{
  • "nowPlaying": [
    ]
}

Stream moves of a game

Stream positions and moves of any ongoing game, in ndjson.

A description of the game is sent as a first message. Then a message is sent each time a move is played. Finally a description of the game is sent when it finishes, and the stream is closed.

After move 5, the stream intentionally remains 3 moves behind the game status, as to prevent cheat bots from using this API.

No more than 8 game streams can be opened at the same time from the same IP address.

path Parameters
id
required
string
Example: LuGQwhBb

Responses

Response samples

Content type
application/x-ndjson
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Import one game

Import a game from PGN. See https://lichess.org/paste.

Rate limiting: 200 games per hour for OAuth requests, 100 games per hour for anonymous requests.

To broadcast ongoing games, consider pushing to a broadcast instead.

To analyse a position or a line, just construct an analysis board URL: https://lichess.org/analysis/pgn/e4_e5_Nf3_Nc6_Bc4_Bc5_Bxf7+

Authorizations:
OAuth2
Request Body schema: application/x-www-form-urlencoded
required

A single game to import

pgn
string

The PGN. It can contain only one game. Most standard tags are supported.

Responses

Response samples

Content type
application/json
{}

TV

Access Lichess TV channels and games. https://lichess.org/tv & https://lichess.org/games

Get current TV games

Get basic info about the best games being played for each speed and variant, but also computer games and bot games.

See lichess.org/tv.

Responses

Response samples

Content type
application/json
{
  • "bot": {
    },
  • "blitz": {
    },
  • "racingKings": {
    },
  • "ultraBullet": {
    },
  • "bullet": {
    },
  • "classical": {
    },
  • "threeCheck": {
    },
  • "antichess": {
    },
  • "computer": {
    },
  • "horde": {
    },
  • "rapid": {
    },
  • "atomic": {
    },
  • "crazyhouse": {
    },
  • "chess960": {
    },
  • "kingOfTheHill": {
    },
  • "topRated": {
    }
}

Stream current TV game

Stream positions and moves of the current TV game in ndjson. A summary of the game is sent as a first message, and when the featured game changes.

Try it with curl https://lichess.org/api/tv/feed.

Responses

Response samples

Content type
application/x-ndjson
{
  • "t": "featured",
  • "d": {
    }
}

Get best ongoing games of a TV channel

Get a list of ongoing games for a given TV channel. Similar to lichess.org/games.

Available in PGN or ndjson format, depending on the request Accept header.

path Parameters
channel
required
string

The name of the channel in camel case.

query Parameters
nb
number [ 1 .. 30 ]
Default: 10

Number of games to fetch.

moves
boolean
Default: true

Include the PGN moves.

pgnInJson
boolean
Default: false

Include the full PGN within the JSON response, in a pgn field.

tags
boolean
Default: true

Include the PGN tags.

clocks
boolean
Default: false

Include clock status when available.

Either as PGN comments: 2. exd5 { [%clk 1:01:27] } e5 { [%clk 1:01:28] }

Or in a clocks JSON field, as centisecond integers, depending on the response type.

opening
boolean
Default: false

Include the opening name.

Example: [Opening "King's Gambit Accepted, King's Knight Gambit"]

Responses

Response samples

Content type
No sample

Puzzles

Access Lichess puzzle history and dashboard.

Our collection of puzzles is in the public domain, you can download it here. For a list of our puzzle themes with their description, check out the theme translation file. The daily puzzle can be posted in your slack workspace.

Get the daily puzzle

Get the daily Lichess puzzle in JSON format.

Alternatively, you can post it in your slack workspace.

Responses

Response samples

Content type
application/json
{
  • "game": {
    },
  • "puzzle": {
    }
}

Get a puzzle by its ID

Get a single Lichess puzzle in JSON format.

path Parameters
id
required
string

The puzzle ID

Responses

Response samples

Content type
application/json
{
  • "game": {
    },
  • "puzzle": {
    }
}

Get your puzzle activity

Download your puzzle activity in ndjson format.

Puzzle activity is sorted by reverse chronological order (most recent first)

We recommend streaming the response, for it can be very long.

Authorizations:
OAuth2
query Parameters
max
integer >= 1

How many entries to download. Leave empty to download all activity.

before
integer >= 1356998400070

Download entries before this timestamp. Defaults to now. Use before and max for pagination.

Responses

Response samples

Content type
application/x-ndjson
{
  • "date": 1514505150384,
  • "win": true,
  • "puzzle": {
    }
}

Get your puzzle dashboard

Download your puzzle dashboard as JSON.

Also includes all puzzle themes played, with aggregated results.

Allows re-creating the improvement/strengths interfaces.

Authorizations:
OAuth2
path Parameters
days
required
integer >= 1

How many days to look back when aggregating puzzle results. 30 is sensible.

Responses

Response samples

Content type
application/json
{
  • "days": 30,
  • "global": {
    },
  • "themes": {
    }
}

Get the storm dashboard of a player

Download the storm dashboard of any player as JSON.

Contains the aggregated highscores, and the history of storm runs aggregated by days.

Use ?days=0 if you only care about the highscores.

path Parameters
username
required
string

Username of the player

query Parameters
days
integer [ 0 .. 365 ]
Default: 30

How many days of history to return

Responses

Response samples

Content type
application/json
{
  • "high": {
    },
  • "days": [
    ]
}

Create and join a puzzle race

Create a new private puzzle race. The Lichess user who creates the race must join the race page, and manually start the race when enough players have joined.

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{}

Teams

Access and manage Lichess teams and their members. https://lichess.org/team

Get team swiss tournaments

Get all swiss tournaments of a team.

Tournaments are sorted by reverse chronological order of start date (last starting first).

Tournaments are streamed as ndjson.

path Parameters
teamId
required
string
Example: coders
query Parameters
max
integer >= 1
Default: 100

How many tournaments to download.

Responses

Response samples

Content type
application/nd-json
{
  • "rated": true,
  • "clock": {
    },
  • "createdBy": "thibault",
  • "id": "ZmKWCOye",
  • "name": "Wang",
  • "nbOngoing": 0,
  • "nbPlayers": 0,
  • "nbRounds": 2,
  • "nextRound": {
    },
  • "round": 0,
  • "startsAt": "2020-05-11T12:23:18.233-06:00",
  • "status": "created",
  • "variant": "standard",
  • "isRecentlyFinished": false,
  • "password": true,
  • "stats": {
    }
}

Get a single team

Infos about a team

path Parameters
teamId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "coders",
  • "name": "Coders",
  • "description": "There are 10 kinds of people in the world: those who understand binary, and the others.\r\n\r\nIf you want to join the team, prove (briefly) that you can code in the request message!",
  • "open": false,
  • "leader": {
    },
  • "leaders": [
    ],
  • "nbMembers": 3129
}

Get popular teams

Paginator of the most popular teams.

query Parameters
page
number
Default: 1
Example: page=1

Responses

Response samples

Content type
application/json
{
  • "currentPage": 4,
  • "maxPerPage": 15,
  • "currentPageResults": [
    ],
  • "nbResults": 205194,
  • "previousPage": 3,
  • "nextPage": 5,
  • "nbPages": 13680
}

Teams of a player

All the teams a player is a member of.

path Parameters
username
required
string
Example: thibault

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search teams

Paginator of team search results for a keyword.

query Parameters
text
string
Example: text=coders
page
number
Default: 1
Example: page=1

Responses

Response samples

Content type
application/json
{
  • "currentPage": 4,
  • "maxPerPage": 15,
  • "currentPageResults": [
    ],
  • "nbResults": 205194,
  • "previousPage": 3,
  • "nextPage": 5,
  • "nbPages": 13680
}

Get members of a team

Members are sorted by reverse chronological order of joining the team (most recent first). OAuth is only required if the list of members is private.

Members are streamed as ndjson.

Authorizations:
OAuth2
path Parameters
teamId
required
string
Example: coders

Responses

Response samples

Content type
application/x-ndjson
{
  • "id": "georges",
  • "username": "Georges",
  • "perfs": {
    },
  • "createdAt": 1290415680000,
  • "disabled": false,
  • "tosViolation": false,
  • "profile": {
    },
  • "seenAt": 1522636452014,
  • "patron": true,
  • "verified": true,
  • "playTime": {
    },
  • "title": "NM",
  • "count": {
    },
  • "streaming": false,
  • "streamer": {},
  • "followable": true,
  • "following": false,
  • "blocking": false,
  • "followsYou": false
}

Get team Arena tournaments

Get all Arena tournaments relevant to a team.

Tournaments are sorted by reverse chronological order of start date (last starting first).

Tournaments are streamed as ndjson.

path Parameters
teamId
required
string

ID of the team

query Parameters
max
integer >= 1
Default: 100

How many tournaments to download.

Responses

Response samples

Content type
application/x-ndjson
{
  • "id": "QITRjufu",
  • "createdBy": "lichess",
  • "system": "arena",
  • "minutes": 57,
  • "clock": {
    },
  • "rated": true,
  • "fullName": "U1700 SuperBlitz Arena",
  • "nbPlayers": 154,
  • "variant": {
    },
  • "startsAt": 1522803600000,
  • "finishesAt": 1522807200000,
  • "status": 30,
  • "perf": {
    },
  • "secondsToStart": 576,
  • "hasMaxRating": true,
  • "maxRating": {
    },
  • "minRating": {
    },
  • "minRatedGames": {
    },
  • "onlyTitled": false,
  • "teamMember": "coders",
  • "private": true,
  • "position": {},
  • "schedule": {
    },
  • "teamBattle": {
    },
  • "winner": {
    }
}

Join a team

Join a team. If the team requires a password but the password field is incorrect, then the call fails with 403 Forbidden. Similarly, if the team join policy requires a confirmation but the message parameter is not given, then the call fails with 403 Forbidden.

Authorizations:
OAuth2
path Parameters
teamId
required
string
Example: coders
Request Body schema: application/x-www-form-urlencoded
required
message
string

Optional request message, if the team requires one.

password
string

Optional password, if the team requires one.

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Leave a team

Authorizations:
OAuth2
path Parameters
teamId
required
string
Example: coders

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Get join requests

Get pending join requests of your team

Authorizations:
OAuth2
path Parameters
teamId
required
string
query Parameters
declined
boolean
Default: false

Get the declined join requests

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Accept join request

Accept someone's request to join your team

Authorizations:
OAuth2
path Parameters
teamId
required
string
Example: coders
userId
required
string
Example: neio

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Decline join request

Decline someone's request to join your team

Authorizations:
OAuth2
path Parameters
teamId
required
string
Example: coders
userId
required
string
Example: neio

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Kick a user from your team

Kick a member out of one of your teams.

Authorizations:
OAuth2
path Parameters
teamId
required
string
Example: coders
userId
required
string
Example: neio

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Message all members

Send a private message to all members of a team. You must own the team.

Authorizations:
OAuth2
path Parameters
teamId
required
string
Example: coders
Request Body schema: application/x-www-form-urlencoded
required
message
string

The message to send to all your team members.

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Board

Play on Lichess with physical boards and third-party clients. Works with normal Lichess accounts. Engine play or assistance is forbidden.

Features

Restrictions

Stream incoming events

Stream the events reaching a lichess user in real time as ndjson.

An empty line is sent every 6 seconds for keep alive purposes.

Each non-empty line is a JSON object containing a type field. Possible values are:

  • gameStart Start of a game
  • gameFinish Completion of a game
  • challenge A player sends you a challenge or you challenge someone
  • challengeCanceled A player cancels their challenge to you
  • challengeDeclined The opponent declines your challenge

When the stream opens, all current challenges and games are sent.

Authorizations:
OAuth2

Responses

Response samples

Content type
application/x-ndjson
Example
{
  • "type": "challenge",
  • "challenge": {
    }
}

Create a seek

Create a public seek, to start a game with a random player.

Real-time seek

Specify the time and increment clock values. The response is streamed but doesn't contain any information.

Keep the connection open to keep the seek active.

If the client closes the connection, the seek is canceled. This way, if the client terminates, the user won't be paired in a game they wouldn't play. When the seek is accepted, or expires, the server closes the connection.

Make sure to also have an Event stream open, to be notified when a game starts. We recommend opening the Event stream first, then the seek stream. This way, you won't miss the game event if the seek is accepted immediately.

Correspondence seek

Specify the days per turn value. The response is not streamed, it immediately completes with the seek ID. The seek remains active on the server until it is joined by someone.

Authorizations:
OAuth2
Request Body schema: application/x-www-form-urlencoded
required

Parameters of the seek

rated
boolean
Default: false

Whether the game is rated and impacts players ratings.

time
number [ 0 .. 180 ]

Clock initial time in minutes. Required for real-time seeks.

increment
integer [ 0 .. 180 ]

Clock increment in seconds. Required for real-time seeks.

days
integer
Enum: 1 2 3 5 7 10 14

Days per turn. Required for correspondence seeks.

variant
string (VariantKey)
Enum: "standard" "chess960" "crazyhouse" "antichess" "atomic" "horde" "kingOfTheHill" "racingKings" "threeCheck" "fromPosition"
color
string
Default: "random"
Enum: "random" "white" "black"

The color to play. Better left empty to automatically get 50% white.

ratingRange
string

The rating range of potential opponents. Better left empty. Example: 1500-1800

Responses

Response samples

Content type
text/plain

Stream Board game state

Stream the state of a game being played with the Board API, as ndjson.

Use this endpoint to get updates about the game in real-time, with a single request.

Each line is a JSON object containing a type field. Possible values are:

  • gameFull Full game data. All values are immutable, except for the state field.

  • gameState Current state of the game. Immutable values not included. Sent when a move is played, a draw is offered, or when the game ends.

  • chatLine Chat message sent by a user in the room "player" or "spectator".

  • opponentGone Whether the opponent has left the game, and how long before you can claim a win or draw.

The first line is always of type gameFull.

The server closes the stream when the game ends, or if the game has already ended.

Authorizations:
OAuth2
path Parameters
gameId
required
string
Example: 5IrD6Gzz

Responses

Response samples

Content type
application/x-ndjson
Example
{
  • "type": "gameFull",
  • "id": "5IrD6Gzz",
  • "rated": true,
  • "variant": {
    },
  • "clock": {
    },
  • "speed": "classical",
  • "perf": {
    },
  • "createdAt": 1523825103562,
  • "white": {
    },
  • "black": {
    },
  • "initialFen": "startpos",
  • "state": {
    }
}

Make a Board move

Make a move in a game being played with the Board API.

The move can also contain a draw offer/agreement.

Authorizations:
OAuth2
path Parameters
gameId
required
string
Example: 5IrD6Gzz
move
required
string
Example: e2e4

The move to play, in UCI format

query Parameters
offeringDraw
boolean

Whether to offer (or agree to) a draw

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Write in the chat

Post a message to the player or spectator chat, in a game being played with the Board API.

Authorizations:
OAuth2
path Parameters
gameId
required
string
Example: 5IrD6Gzz
Request Body schema: application/x-www-form-urlencoded
required
room
required
string
Enum: "player" "spectator"
text
required
string

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Fetch the game chat

Get the messages posted in the game chat

Authorizations:
OAuth2
path Parameters
gameId
required
string
Example: 5IrD6Gzz

Responses

Response samples

Content type
application/x-ndjson
[
  • {
    },
  • {
    },
  • {
    }
]

Abort a game

Abort a game being played with the Board API.

Authorizations:
OAuth2
path Parameters
gameId
required
string
Example: 5IrD6Gzz

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Resign a game

Resign a game being played with the Board API.

Authorizations:
OAuth2
path Parameters
gameId
required
string
Example: 5IrD6Gzz

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Handle draw offers

Create/accept/decline draw offers.

  • yes: Offer a draw, or accept the opponent's draw offer.
  • no: Decline a draw offer from the opponent.
Authorizations:
OAuth2
path Parameters
gameId
required
string
Example: 5IrD6Gzz
required
boolean or "yes" (string)
Example: yes

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Handle takeback offers

Create/accept/decline takebacks.

  • yes: Propose a takeback, or accept the opponent's takeback offer.
  • no: Decline a takeback offer from the opponent.
Authorizations:
OAuth2
path Parameters
gameId
required
string
Example: 5IrD6Gzz
required
boolean or "yes" (string)
Example: yes

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Claim victory of a game

Claim victory when the opponent has left the game for a while.

Authorizations:
OAuth2
path Parameters
gameId
required
string
Example: 5IrD6Gzz

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Berserk a tournament game

Go berserk on an arena tournament game. Halves the clock time, grants an extra point upon winning. Only available in arena tournaments that allow berserk, and before each player has made a move.

Authorizations:
OAuth2
path Parameters
gameId
required
string
Example: 5IrD6Gzz

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Bot

Play on Lichess as a bot. Allows engine play. Read the blog post announcement of lichess bots.

Only works with Bot accounts.

Features

Restrictions

  • Bots can only play challenge games: pools and tournaments are off-limits
  • Bots cannot play UltraBullet (ΒΌ+0) because it requires making too many requests. But 0+1 and Β½+0 are allowed.

Integrations

Stream incoming events

Stream the events reaching a lichess user in real time as ndjson.

An empty line is sent every 6 seconds for keep alive purposes.

Each non-empty line is a JSON object containing a type field. Possible values are:

  • gameStart Start of a game
  • gameFinish Completion of a game
  • challenge A player sends you a challenge or you challenge someone
  • challengeCanceled A player cancels their challenge to you
  • challengeDeclined The opponent declines your challenge

When the stream opens, all current challenges and games are sent.

Authorizations:
OAuth2

Responses

Response samples

Content type
application/x-ndjson
Example
{
  • "type": "challenge",
  • "challenge": {
    }
}

Get online bots

Stream the online bot users, as ndjson. Throttled to 50 bot users per second.

query Parameters
nb
integer >= 1
Example: nb=20

How many bot users to fetch

Responses

Response samples

Content type
application/x-ndjson
{
  • "id": "georges",
  • "username": "Georges",
  • "perfs": {
    },
  • "createdAt": 1290415680000,
  • "disabled": false,
  • "tosViolation": false,
  • "profile": {
    },
  • "seenAt": 1522636452014,
  • "patron": true,
  • "verified": true,
  • "playTime": {
    },
  • "title": "NM"
}

Upgrade to Bot account

Upgrade a lichess player account into a Bot account. Only Bot accounts can use the Bot API.

The account cannot have played any game before becoming a Bot account. The upgrade is irreversible. The account will only be able to play as a Bot.

To upgrade an account to Bot, use the official lichess-bot client, or follow these steps:

  • Create an API access token with "Play bot moves" permission.
  • curl -d '' https://lichess.org/api/bot/account/upgrade -H "Authorization: Bearer <yourTokenHere>"

To know if an account has already been upgraded, use the Get my profile API: the title field should be set to BOT.

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Stream Bot game state

Stream the state of a game being played with the Bot API, as ndjson.

Use this endpoint to get updates about the game in real-time, with a single request.

Each line is a JSON object containing a type field. Possible values are:

  • gameFull Full game data. All values are immutable, except for the state field.

  • gameState Current state of the game. Immutable values not included.

  • chatLine Chat message sent by a user (or the bot itself) in the room "player" or "spectator".

  • opponentGone Whether the opponent has left the game, and how long before you can claim a win or draw.

The first line is always of type gameFull.

Authorizations:
OAuth2
path Parameters
gameId
required
string
Example: 5IrD6Gzz

Responses

Response samples

Content type
application/x-ndjson
Example
{
  • "type": "gameFull",
  • "id": "5IrD6Gzz",
  • "rated": true,
  • "variant": {
    },
  • "clock": {
    },
  • "speed": "classical",
  • "perf": {
    },
  • "createdAt": 1523825103562,
  • "white": {
    },
  • "black": {
    },
  • "initialFen": "startpos",
  • "state": {
    }
}

Make a Bot move

Make a move in a game being played with the Bot API.

The move can also contain a draw offer/agreement.

Authorizations:
OAuth2
path Parameters
gameId
required
string
Example: 5IrD6Gzz
move
required
string
Example: e2e4

The move to play, in UCI format

query Parameters
offeringDraw
boolean

Whether to offer (or agree to) a draw

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Write in the chat

Post a message to the player or spectator chat, in a game being played with the Bot API.

Authorizations:
OAuth2
path Parameters
gameId
required
string
Example: 5IrD6Gzz
Request Body schema: application/x-www-form-urlencoded
required
room
required
string
Enum: "player" "spectator"
text
required
string

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Fetch the game chat

Get the messages posted in the game chat

Authorizations:
OAuth2
path Parameters
gameId
required
string
Example: 5IrD6Gzz

Responses

Response samples

Content type
application/x-ndjson
[
  • {
    },
  • {
    },
  • {
    }
]

Abort a game

Abort a game being played with the Bot API.

Authorizations:
OAuth2
path Parameters
gameId
required
string
Example: 5IrD6Gzz

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Resign a game

Resign a game being played with the Bot API.

Authorizations:
OAuth2
path Parameters
gameId
required
string
Example: 5IrD6Gzz

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Challenges

Send and receive challenges to play.

To create a lot of challenges, consider bulk pairing instead.

List your challenges

Get a list of challenges created by or targeted at you.

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "in": [
    ],
  • "out": [
    ]
}

Create a challenge

Challenge someone to play. The targeted player can choose to accept or decline.

If the challenge is accepted, you will be notified on the event stream that a new game has started. The game ID will be the same as the challenge ID.

Challenges for realtime games (not correspondence) expire after 20s if not accepted. To prevent that, use the keepAliveStream flag described below.

Authorizations:
OAuth2
path Parameters
username
required
string
Example: LeelaChess
Request Body schema: application/x-www-form-urlencoded
required

Parameters of the challenge

rated
boolean
Default: false

Game is rated and impacts players ratings

clock.limit
number [ 0 .. 10800 ]

Clock initial time in seconds. If empty, a correspondence game is created.

clock.increment
integer [ 0 .. 60 ]

Clock increment in seconds. If empty, a correspondence game is created.

days
integer
Enum: 1 2 3 5 7 10 14

Days per move, for correspondence games. Clock settings must be omitted.

color
string
Default: "random"
Enum: "random" "white" "black"

Which color you get to play

variant
string (VariantKey)
Enum: "standard" "chess960" "crazyhouse" "antichess" "atomic" "horde" "kingOfTheHill" "racingKings" "threeCheck" "fromPosition"
fen
string (FromPositionFEN)

Custom initial position (in FEN). Variant must be standard, fromPosition, or chess960 (if a valid 960 starting position), and the game cannot be rated.

keepAliveStream
boolean

If set, the response is streamed as ndjson. The challenge is kept alive until the connection is closed by the client. When the challenge is accepted, declined or canceled, a message of the form {"done":"accepted"} is sent, then the connection is closed by the server. If not set, the response is not streamed, and the challenge expires after 20s if not accepted.

rules
string
Enum: "noAbort" "noRematch" "noGiveTime" "noClaimWin" "noEarlyDraw"

Extra game rules separated by commas. Example: noAbort,noRematch

Responses

Response samples

Content type
application/json
{
  • "challenge": {
    }
}

Accept a challenge

Accept an incoming challenge.

You should receive a gameStart event on the incoming events stream.

Authorizations:
OAuth2
path Parameters
challengeId
required
string
Example: 5IrD6Gzz

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Decline a challenge

Decline an incoming challenge.

Authorizations:
OAuth2
path Parameters
challengeId
required
string
Example: 5IrD6Gzz
Request Body schema: application/x-www-form-urlencoded
optional

Details related to decline of challenge

reason
string
Enum: "generic" "later" "tooFast" "tooSlow" "timeControl" "rated" "casual" "standard" "variant" "noBot" "onlyBot"

Reason challenge was declined. It will be translated to the player's language. See the full list in the translation file.

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Cancel a challenge

Cancel a challenge you sent, or aborts the game if the challenge was accepted, but the game was not yet played. Note that the ID of a game is the same as the ID of the challenge that created it.

Works for user challenges and open challenges alike.

Authorizations:
OAuth2
path Parameters
challengeId
required
string
Example: 5IrD6Gzz
query Parameters
opponentToken
string

Optional challenge:write token of the opponent. If set, the game can be canceled even if both players have moved.

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Challenge the AI

Start a game with Lichess AI.

You will be notified on the event stream that a new game has started.

Authorizations:
OAuth2
Request Body schema: application/x-www-form-urlencoded
required

Parameters of the game

level
number [ 1 .. 8 ]

AI strength

clock.limit
number [ 0 .. 10800 ]

Clock initial time in seconds. If empty, a correspondence game is created.

clock.increment
integer [ 0 .. 60 ]

Clock increment in seconds. If empty, a correspondence game is created.

days
integer
Enum: 1 2 3 5 7 10 14

Days per move, for correspondence games. Clock settings must be omitted.

color
string
Default: "random"
Enum: "random" "white" "black"

Which color you get to play

variant
string (VariantKey)
Enum: "standard" "chess960" "crazyhouse" "antichess" "atomic" "horde" "kingOfTheHill" "racingKings" "threeCheck" "fromPosition"
fen
string (FromPositionFEN)

Custom initial position (in FEN). Variant must be standard, fromPosition, or chess960 (if a valid 960 starting position), and the game cannot be rated.

Responses

Response samples

Content type
application/json
{
  • "id": "q7ZvsdUF",
  • "rated": true,
  • "variant": "standard",
  • "speed": "blitz",
  • "perf": "blitz",
  • "createdAt": 1514505150384,
  • "lastMoveAt": 1514505592843,
  • "status": "draw",
  • "players": {
    },
  • "opening": {
    },
  • "moves": "d4 d5 c4 c6 Nc3 e6 e4 Nd7 exd5 cxd5 cxd5 exd5 Nxd5 Nb6 Bb5+ Bd7 Qe2+ Ne7 Nxb6 Qxb6 Bxd7+ Kxd7 Nf3 Qa6 Ne5+ Ke8 Qf3 f6 Nd3 Qc6 Qe2 Kf7 O-O Kg8 Bd2 Re8 Rac1 Nf5 Be3 Qe6 Rfe1 g6 b3 Bd6 Qd2 Kf7 Bf4 Qd7 Bxd6 Nxd6 Nc5 Rxe1+ Rxe1 Qc6 f3 Re8 Rxe8 Nxe8 Kf2 Nc7 Qb4 b6 Qc4+ Nd5 Nd3 Qe6 Nb4 Ne7 Qxe6+ Kxe6 Ke3 Kd6 g3 h6 Kd3 h5 Nc2 Kd5 a3 Nc6 Ne3+ Kd6 h4 Nd8 g4 Ne6 Ke4 Ng7 Nc4+ Ke6 d5+ Kd7 a4 g5 gxh5 Nxh5 hxg5 fxg5 Kf5 Nf4 Ne3 Nh3 Kg4 Ng1 Nc4 Kc7 Nd2 Kd6 Kxg5 Kxd5 f4 Nh3+ Kg4 Nf2+ Kf3 Nd3 Ke3 Nc5 Kf3 Ke6 Ke3 Kf5 Kd4 Ne6+ Kc4",
  • "clock": {
    }
}

Open-ended challenge

Create a challenge that any 2 players can join.

Share the URL of the challenge. the first 2 players to click it will be paired for a game.

The response body also contains whiteUrl and blackUrl. You can control which color each player gets by giving them these URLs, instead of the main challenge URL.

Open challenges expire after 24h.

If the challenge creation is authenticated with OAuth2, then you can use the challenge cancel endpoint to cancel it.

To directly pair 2 known players, use this endpoint instead.

Request Body schema: application/x-www-form-urlencoded
required

Parameters of the game

rated
boolean
Default: false

Game is rated and impacts players ratings

clock.limit
number [ 0 .. 10800 ]

Clock initial time in seconds. If empty, a correspondence game is created.

clock.increment
integer [ 0 .. 60 ]

Clock increment in seconds. If empty, a correspondence game is created.

days
integer
Enum: 1 2 3 5 7 10 14

Days per turn. For correspondence challenges.

variant
string (VariantKey)
Enum: "standard" "chess960" "crazyhouse" "antichess" "atomic" "horde" "kingOfTheHill" "racingKings" "threeCheck" "fromPosition"
fen
string (FromPositionFEN)

Custom initial position (in FEN). Variant must be standard, fromPosition, or chess960 (if a valid 960 starting position), and the game cannot be rated.

name
string

Optional name for the challenge, that players will see on the challenge page.

rules
string
Enum: "noAbort" "noRematch" "noGiveTime" "noClaimWin" "noEarlyDraw"

Extra game rules separated by commas. Example: noAbort,noRematch

users
string

Optional pair of usernames, separated by a comma. If set, only these users will be allowed to join the game. The first username gets the white pieces. Example: Username1,Username2

expiresAt
integer

Timestamp in milliseconds to expire the challenge. Defaults to 24h after creation. Can't be more than 2 weeks after creation.

Responses

Response samples

Content type
application/json
{