Skip to main content

Get Round Details

Get detailed information about a specific broadcast round.

Endpoint

Path Parameters

string
required
Tournament slug (used for URL formatting)
string
required
Round slug (used for URL formatting)
string
required
The round ID (8 characters)

Response

object
Round information
object
Parent tournament information
object
Study settings and permissions
array
Array of chapter previews (games) in the round
object
Group information if applicable
object
Player photos keyed by player name
boolean
Whether the current user is subscribed (requires authentication)
integer
WebSocket version for real-time updates

Authentication

Optional. Provide an OAuth token with study:read scope to:
  • Access private broadcasts
  • Get subscription status
  • Receive socket version for real-time updates

Get My Rounds

Get broadcast rounds that you have access to manage.

Endpoint

Query Parameters

integer
Maximum number of rounds to return

Response

Returns a stream of rounds in NDJSON format where you have contributor access.

Authentication

Required. OAuth token with study:read scope.

Export Round PGN

Download all games from a broadcast round as PGN.

Endpoint

Path Parameters

string
required
The round ID (8 characters)

Response

Returns PGN data for all games in the round as application/x-chess-pgn.

Stream Round Games

Stream all games from a broadcast round in real-time as they are updated.

Endpoint

Path Parameters

string
required
The round ID (8 characters)

Response

Returns a persistent streaming connection that sends updated PGN data as games progress. The stream stays open and sends updates as they occur.
The stream includes keep-alive spaces every 60 seconds to maintain the connection.

Rate Limits

  • Higher limits for verified users
  • Connection limits apply per IP address

Reset Round

Reset a broadcast round, clearing all games and allowing it to be re-synced.

Endpoint

Path Parameters

string
required
The round ID (8 characters)

Response

Returns success confirmation.

Authentication

Required. OAuth token with study:write scope. You must be a contributor to the broadcast.
This action cannot be undone. All games in the round will be removed.

Get Round Stats

Get viewership statistics for a broadcast round.

Endpoint

Path Parameters

string
required
The round ID (8 characters)

Response

array
Array of viewer count data points. Each element is [timestamp, count] where timestamp is in seconds and count is the number of concurrent viewers.
integer
Total number of unique viewers (if greater than 0)