Expand description
The Lichess API, organized by business concern.
Each submodule groups related concerns into a category; every concern
exposes its endpoints through an accessor on
LichessClient (for example client.account() or
client.broadcasts()).
Modulesยง
- auth
- Authentication: the
OAuth2Authorization Code flow with PKCE. - broadcasting
- Broadcasting: official broadcasts and live TV.
- database
- Position databases and analysis: opening explorer, tablebase, cloud eval.
- engine
- External analysis engines.
- gameplay
- Playing and exporting games: board/bot play, challenges, bulk pairings, and game export/import.
- social
- Social and community features: following/blocking, messaging, and teams.
- tournaments
- Tournaments and simultaneous exhibitions: arena, swiss, and simuls.
- training
- Training: puzzles and studies.
- users
- User accounts, public profiles, players, and FIDE data.