Board

Stream Board game state

Changed on

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.

get/api/board/game/stream/{gameId}

Request

  • Base URL
    https://lichess.org
  • URL
    https://lichess.org/api/board/game/stream/{gameId}
  • Auth
    OAuth 2
    Authorization code: https://lichess.org/oauth
    Token URL: https://lichess.org/api/token scopes: board:play

Path parameters

gameIdstring required
Example:5IrD6Gzz

Response

The stream of the game.

Changes

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status