LIlichess
Board
Bot

Stream incoming events

Changed on

Stream the events reaching a lichess user in real time as ndjson.

An empty line is sent every 7 seconds for keep alive purposes.

Each non-empty line is a JSON object containing a type field. Possible values are:

  • gameStart Start of a game
  • gameFinish Completion of a game
  • challenge A player sends you a challenge or you challenge someone
  • challengeCanceled A player cancels their challenge to you
  • challengeDeclined The opponent declines your challenge

When the stream opens, all current challenges and games are sent.

Only one global event stream can be active at a time. When the stream opens, the previous one with the same access token is closed.

get/api/stream/event

Request

  • Base URL
    https://lichess.org
  • URL
    https://lichess.org/api/stream/event
  • Auth
    OAuth 2
    Authorization code: https://lichess.org/oauth
    Token URL: https://lichess.org/api/token scopes: challenge:read, bot:play, board:play

Response

The stream of events reaching the logged in user.

Changes

  • 9b0422af5084Revision changes
    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /////////// became required for the status

    • info

      the response property /////////// became required for the status

    • info

      the response property /////////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status