How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Lichess Broadcasts API

Relay chess events on Lichess.[Official broadcasts](https://lichess.org/broadcast) are maintained by Lichess,but you can [create your own broadcasts](https://lichess.org/broadcast/new) to cover any live game or chess event.You will need to publish PGN on a public URL so that Lichess can pull updates from it.Alternatively, you can push PGN updates to Lichess using [this API endpoint](#tag/broadcasts/POST/api/broadcast/round/{broadcastRoundId}/push).Broadcasts are organized in tournaments, which have several rounds, which have several games.You must first create a tournament, then you can add rounds to them.

Lichess Broadcasts API is one of 23 APIs that Lichess publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Broadcasts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, a JSON-LD context, and 2 JSON Schemas.

This API exposes 19 operations across 19 paths, and defines 44 schemas. It is described by OpenAPI 3.1.0, at version 2.0.144.

Requests are made against 4 base URLs: https://lichess.org, https://lichess.dev, http://localhost:{port}, http://l.org.

19 operations 19 paths 44 schemas 13 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.144
Base URL
https://lichess.org
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Lichess Broadcasts API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 23 scopes.

  • OAuth2 — Read [the introduction for how to make authenticated requests](description/authentication).

Paths & Operations 19

Across 19 paths, the API surfaces 19 operations — 13 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Broadcasts 19

Relay chess events on Lichess. [Official broadcasts](https://lichess.org/broadcast) are maintained by Lichess, but you can [create your own broadcasts](https://lichess.org/broadca…

GET
/api/broadcast
Get official broadcasts
broadcastsOfficial 3 params → 200
GET
/api/broadcast/top
Get paginated top broadcast previews
broadcastsTop 2 params → 200
GET
/api/broadcast/by/{username}
Get broadcasts created by a user
broadcastsByUser 3 params → 200
GET
/api/broadcast/search
Search broadcasts
broadcastsSearch 2 params → 200
POST
/broadcast/new
Create a broadcast tournament
broadcastTourCreate body → 200400
GET
/api/broadcast/{broadcastTournamentId}
Get a broadcast tournament
broadcastTourGet 1 param → 200
GET
/broadcast/{broadcastTournamentId}/players
Get players of a broadcast
broadcastPlayersGet 1 param → 200
GET
/broadcast/{broadcastTournamentId}/players/{playerId}
Get a player of a broadcast
broadcastPlayerGet 2 params → 200404
GET
/broadcast/{broadcastTournamentId}/teams/standings
Get the team leaderboard of a broadcast
broadcastTeamLeaderboardGet 1 param → 200404
POST
/broadcast/{broadcastTournamentId}/edit
Update your broadcast tournament
broadcastTourUpdate 1 param body → 200400
POST
/broadcast/{broadcastTournamentId}/new
Create a broadcast round
broadcastRoundCreate 1 param body → 200400
GET
/api/broadcast/{broadcastTournamentSlug}/{broadcastRoundSlug}/{broadcastRoundId}
Get a broadcast round
broadcastRoundGet 3 params → 200
POST
/broadcast/round/{broadcastRoundId}/edit
Update a broadcast round
broadcastRoundUpdate 2 params body → 200400
POST
/api/broadcast/round/{broadcastRoundId}/reset
Reset a broadcast round
broadcastRoundReset 1 param → 200
POST
/api/broadcast/round/{broadcastRoundId}/push
Push PGN to a broadcast round
broadcastPush 1 param body → 200400
GET
/api/stream/broadcast/round/{broadcastRoundId}.pgn
Stream an ongoing broadcast round as PGN
broadcastStreamRoundPgn 3 params → 200
GET
/api/broadcast/round/{broadcastRoundId}.pgn
Export one round as PGN
broadcastRoundPgn 3 params → 200
GET
/api/broadcast/{broadcastTournamentId}.pgn
Export all rounds as PGN
broadcastAllRoundsPgn 3 params → 200
GET
/api/broadcast/my-rounds
Get your broadcast rounds
broadcastMyRoundsGet 1 param → 200

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are BroadcastForm (18 properties), BroadcastTour (13 properties), BroadcastRoundInfo (13 properties), BroadcastGameEntry (9 properties). Each schema is shown below with its type and property counts.

BroadcastPhotos
object
Photos of players, when available. The object keys are FIDE IDs
StatByFideTC
object
3 properties
PatronColor
integer
Players can choose a color for their Patron wings. See [here for the color mappings](https://github.com/lichess-org/lila/blob/master/ui/lib/css/abstract/patron…
BroadcastWithLastRound
object
3 properties
BroadcastPointStr
string
BroadcastPgnPush
object
1 property 1 required
Patron
boolean
Use patronColor value instead to determine if player is a patron.
BroadcastTeamPOVMatchEntry
object
5 properties 2 required
BroadcastPlayerEntry
BroadcastWithRoundsAndFullGroup
object
5 properties 2 required
BroadcastPlayerEntryWithFideAndGames
BroadcastRoundNew
object
3 properties 3 required
BroadcastCustomScoring
object
Scoring overrides for wins or draws.
2 properties 2 required
NotFound
object
1 property 1 required
GameColor
string
BroadcastTop
object
3 properties
StudyPgn
string
BroadcastRoundInfo
object
13 properties 6 required
FideTimeControl
string
FIDE rating category
BroadcastRound
object
7 properties 5 required
BroadcastMyRound
object
3 properties 3 required
BroadcastTeamLeaderboardEntry
object
6 properties 5 required
Ok
object
1 property 1 required
BroadcastCustomPointsPerColor
object
2 properties 2 required
BroadcastRoundForm
BroadcastByUser
object
1 property 1 required
BroadcastRoundFormName
string
Name of the broadcast round. Example: Round 1
BroadcastCustomPoints
number
BroadcastRoundStudyInfo
object
2 properties
Flair
string
See [available flair list and images](https://github.com/lichess-org/lila/tree/master/public/flair)
BroadcastTiebreakExtendedCode
string
Extended tiebreak code
BroadcastPgnPushTags
object
Error
object
1 property 1 required
BroadcastPlayerWithFed
object
6 properties 1 required
BroadcastGroup
object
4 properties 4 required
BroadcastRoundGame
object
8 properties 2 required
BroadcastForm
object
18 properties 1 required
BroadcastGameEntry
object
9 properties 5 required
BroadcastGroupTour
object
4 properties 4 required
BroadcastPlayerTiebreak
object
3 properties 3 required
LightUser
object
6 properties 2 required
BroadcastWithRounds
object
5 properties 2 required
Title
string
only appears if the user is a titled player or a bot user
BroadcastTour
object
13 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lichess-broadcasts-api-openapi.yml Raw ↑

Other APIs Lichess publishes across the network.

Lichess Account API
Lichess Analysis API
Lichess Board API
Lichess Bot API
Lichess Bulk pairings API
Lichess Challenges API
Lichess External engine API
Lichess FIDE API
Lichess Games API
Lichess Messaging API
Lichess OAuth API
Lichess Opening Explorer API
Where this information came from

This is an independent, third-party profile of Lichess Broadcasts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.