Broadcasts
Stream an ongoing broadcast round as PGN
This streaming endpoint first sends all games of a broadcast round 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 round. This is the best way to get updates about an ongoing round. Streaming means no polling, and no pollings means no latency, and minimum impact on the server.
get/api/stream/broadcast/round/{broadcastRoundId}.pgn
Path parameters
broadcastRoundIdstring required
The broadcast round ID
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 round games, then the PGNs of games as they are updated.