v3

OpenAPI 3.1.0AGPL-3.0-or-later2026-07-311871891.1 MB
Board
Bot

Stream incoming events

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

Response

The stream of events reaching the logged in user.