v3

OpenAPI 3.1.0AGPL-3.0-or-later2026-07-311871891.1 MB
Broadcasts

Stream ongoing broadcast rounds of a group as PGN

For a given broadcast group (example), selects all the ongoing and recently finished rounds, and sends all games of these rounds in PGN format. Then, it waits for new moves to be played. As soon as it happens, the entire PGN of the game is sent to the stream. The stream will also send PGNs when games are added to the rounds. This is the best way to get updates about an ongoing broadcast with multiple concurrent rounds. To stream a single round, use this endpoint instead.

get/api/stream/broadcast/group/{broadcastGroupId}.pgn

Path parameters

broadcastGroupIdstring required

The broadcast group ID. It's the last past of the group URL, which can be found on the broadcast page overview section. Example the group URL is https://lichess.org/broadcast/fide-world-cadets-cup-2026/albQx5zq and therefore the group ID is albQx5zq.

Query parameters

clocksboolean

Include clock comments in the PGN moves, when available. Example: 2. exd5 { [%clk 1:01:27] } e5 { [%clk 1:01:28] }

commentsboolean

Include analysis comments in the PGN moves, when available. Example: 12. Bxf6 { [%eval 0.23] }

Response

The PGN representation of the rounds games, then the PGNs of games as they are updated.