Skip to main content

Module api

Module api 

Source

Modules§

account
Read and manage the logged in user’s own account: public profile, email address, kid mode, preferences, and activity timeline.
analysis
Position analysis.
arena_tournaments
Arena tournaments: Lichess’s continuous-pairing tournament format, where players score points per game and climb a live leaderboard for the duration of the event.
board
The Board API: play games as if from a physical board or other external device, rather than the normal Lichess UI.
bot
Play games as a Lichess Bot account.
broadcasts
Broadcasts: Lichess’s live relays of over-the-board tournaments, made up of one tournament containing one or more rounds, each fed by an external PGN source.
bulk_pairings
Bulk pairings let a broadcaster or tournament organizer schedule many games between paired players at once, up to a week in advance, rather than creating challenges one by one.
challenges
Challenge other players, bots, or the Lichess AI to a game.
external_engine
Register and use an external engine: a chess engine running on the user’s own machine, made available for cloud analysis (e.g. from the Lichess analysis board) via a provider/secret handshake.
fide
Look up FIDE-rated players and their rating history.
games
Fetching, exporting, streaming, and importing games.
messaging
Sending private messages to other Lichess players.
oauth
Inspect and revoke OAuth2 tokens, and exchange an authorization code for an access token.
openings
Query move statistics for a position from the Opening Explorer: aggregated master games (openings_masters), rated Lichess games (openings_lichess), or a specific player’s games (openings_player), plus fetching a masters game’s PGN by ID (openings_otb). All of these are public and need no token, and are served from a separate host, Domain::Explorer.
puzzles
Fetching puzzles, tracking puzzle progress, and puzzle racing.
relations
Follow, unfollow, and block other Lichess players.
simuls
Simultaneous exhibitions: one host playing many opponents at once.
studies
Create, import into, and export studies and their chapters.
swiss_tournaments
Swiss-system tournaments.
tablebase
Look up Syzygy endgame tablebase results for positions with few pieces remaining, one method per variant: standard chess (lookup_standard), antichess (lookup_antichess), and atomic chess (lookup_atomic). Each returns the win/loss/draw category and, where known, distance-to-zero and distance-to-mate for the position and for every legal move. These endpoints are public and need no token, and are served from a separate host, Domain::Tablebase.
teams
Team info, membership, and team-only tournament listings.
tv
Lichess TV: the best ongoing games, overall and per channel (speed variants like bullet or blitz, plus computer and bot games).
users
Public user profiles, ratings, and activity.