Games

Stream games of users

Changed on

Stream the games played between a list of users, in real time. Only games where both players are part of the list are included. The stream emits an event each time a game is started or finished. To also get all current ongoing games at the beginning of the stream, use the withCurrentGames flag. Games are streamed as ndjson. Maximum number of users: 300. The method is POST so a longer list of IDs can be sent in the request body.

post/api/stream/games-by-users

Request

  • Base URL
    https://lichess.org
  • URL
    https://lichess.org/api/stream/games-by-users
  • Auth
    none required

Query parameters

withCurrentGamesboolean

Include the already started games at the beginning of the stream.

Request body text/plain

string required

Response

The stream of the games played between the users.

Changes

    • info

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

    • info

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