Skip to main content

Module board

Module board 

Source
Expand description

The Board API: play games as if from a physical board or other external device, rather than the normal Lichess UI.

Covers making moves, offering or claiming draws, resigning, berserking, seeking a game, and chatting, plus the event and game-state streams needed to drive a game in real time. All methods here require a bearer token with the board:play scope.

LichessApi::board_stream_incoming_events and LichessApi::board_stream_board_state return streams of events rather than a single response: keep the connection open and read from the stream as moves and other updates happen, rather than polling.