lichess_client library
Classes
- AccountService
- Read and write account information and preferences. https://lichess.org/account/preferences/game-display.
- BoardService
- Play on Lichess with physical boards and third-party clients. Works with normal Lichess accounts. Engine play or assistance is forbidden.
- Count
- https://lichess.org/api#tag/Account/operation/accountMe
- GamesService
- Access games played on Lichess. https://lichess.org/games.
- JoinRequest
- https://lichess.org/api#tag/Teams/operation/teamRequests
- LichessBoardGameEvent
- LichessBoardGameIncomingEvent
- LichessChallengeCanceledEvent
- https://lichess.org/api#tag/Board
- LichessChallengeDeclinedEvent
- https://lichess.org/api#tag/Board
- LichessChallengeEvent
- https://lichess.org/api#tag/Board
- LichessChallengeEventInfo
- https://lichess.org/api#tag/Board
- LichessChallengeUser
- https://lichess.org/api#tag/Board
- LichessChatLineEvent
- https://lichess.org/api#tag/Board
- LichessClient
-
Interface for this client, if you are looking for a concrete implementation
use
LichessClientDio.createfromlichess_client_diopackage instead. - LichessGame
- https://lichess.org/api#tag/Games/operation/apiGamesUser
- LichessGameChallengePerf
- https://lichess.org/api#tag/Board
- LichessGameChatMessage
- https://lichess.org/api#tag/Board/operation/boardGameChatGet
- LichessGameClock
- https://lichess.org/api#tag/TV/operation/tvFeed https://lichess.org/api#tag/Board
- LichessGameEventCompat
- https://lichess.org/api#tag/Board
- LichessGameEventInfo
- https://lichess.org/api#tag/Board
- LichessGameEventPlayer
- https://lichess.org/api#tag/Board
- LichessGameFinishEvent
- https://lichess.org/api#tag/Board
- LichessGameFullEvent
- https://lichess.org/api#tag/Board
- LichessGameOpening
- https://lichess.org/api#tag/Board
- LichessGamePerf
- https://lichess.org/api#tag/Board
- LichessGamePlayer
- https://lichess.org/api#tag/TV/operation/tvFeed
- LichessGamePlayers
- https://lichess.org/api#tag/TV/operation/tvFeed
- LichessGameStartEvent
- https://lichess.org/api#tag/Board
- LichessGameStateEvent
- https://lichess.org/api#tag/Board
- LichessOpponentGoneEvent
- https://lichess.org/api#tag/Board
- LichessPuzzle
- LichessPuzzleActivity
- LichessPuzzleDashboard
- LichessPuzzleGame
- LichessPuzzleInfo
- LichessPuzzlePlayer
- LichessPuzzleResult
- LichessPuzzleTheme
- LichessTvGameBasicInfo
- https://lichess.org/api#tag/TV/operation/tvChannels
- LichessTvGameSummary
- https://lichess.org/api#tag/Games/operation/apiGamesUser
- LichessTvGameSummaryData
- https://lichess.org/api#tag/TV/operation/tvChannels
- LichessVariant
- https://lichess.org/api#tag/Board/operation/boardGameStream
- LiveStream
- https://lichess.org/api#tag/Users/operation/streamerLive
- LiveStreamer
- OAuthService
- Obtaining and revoking OAuth tokens.
-
PageOf<
T> -
A generic class that provides pagination fields plus a result list of type
T. - Perf
- https://lichess.org/api#tag/Account/operation/accountMe
- Perfs
- https://lichess.org/api#tag/Account/operation/accountMe
- PlayTime
- https://lichess.org/api#tag/Account/operation/accountMe
- Profile
- https://lichess.org/api#tag/Account/operation/accountMe
- PuzzlesService
- Read information about puzzles.
- RatingHistory
- https://lichess.org/api#tag/Users/operation/apiUserRatingHistory
- RatingHistoryEntry
- A typed entry that represents a point provided by the Lichess API user rating history.
- RatingHistoryInfo
- This class generate useful info from the raw rating points provided by the Lichess API.
- RealTimeUserStatus
- https://lichess.org/api#tag/Users/operation/streamerLive
- RelationsService
- Access relations between users.
- StormPerf
- https://lichess.org/api#tag/Account/operation/accountMe
- Team
- https://lichess.org/api#tag/Teams/operation/teamShow
- TeamsService
- Access and manage Lichess teams and their members.
- TvService
- Access Lichess TV channels and games. https://lichess.org/tv & https://lichess.org/games.
- User
- https://lichess.org/api#tag/Account/operation/accountMe
- UserPreferences
- https://lichess.org/api#tag/Account/operation/accountMe
- UsersService
- Access registered users on Lichess. https://lichess.org/player
Enums
- DaysPerTurn
- https://lichess.org/api#tag/Board/operation/apiBoardSeek
- LichessBoardGameEventType
- https://lichess.org/api#tag/Games/operation/apiGamesUser
- LichessBoardGameIncomingEventType
- https://lichess.org/api#tag/Games/operation/apiGamesUser
- LichessChallengeColor
- https://lichess.org/api#tag/TV/operation/tvFeed
- LichessChallengeDirection
- https://lichess.org/api#tag/TV/operation/tvFeed
- LichessChallengeStatus
- https://lichess.org/api#tag/TV/operation/tvFeed
- LichessChatLineRoom
- https://lichess.org/api#tag/Games/operation/apiGamesUser
- LichessColor
- https://lichess.org/api#tag/TV/operation/tvFeed
- LichessGameEventSource
- https://lichess.org/api#tag/Board/operation/apiStreamEvent
- LichessGameSort
- https://lichess.org/api#tag/Games/operation/apiGamesUser
- LichessGameStatus
- https://lichess.org/api#tag/TV/operation/tvChannels
- LichessSpeed
- https://lichess.org/api#tag/TV/operation/tvChannels
- LichessVariantKey
- https://lichess.org/api#tag/TV/operation/tvChannels
- PerfType
- https://lichess.org/api#tag/Account/operation/accountMe
- PieceSet
- Lichess piece set preferences enum.
- PieceSet3d
- Lichess piece set preferences enum.
- RatingHistorySortField
- Built-in fields supported by RatingHistoryInfo.
- SortDirection
- A general sorting direction enum class.
- SoundSet
- The library exposes this enum but we do not use it.
- Theme
- Lichess theme preferences enum.
- Theme3d
- Lichess theme 3D preferences enum.
- Title
- A chess player title enum.
- TvChannel
- https://lichess.org/api#tag/TV/operation/tvChannels
Mixins
- CloseableMixin
- Generic interface for closeable resources.
Constants
- kStandardChessInitialFen → const String
- Helper when the initial fen is not provided by the API.