Skip to navigation

Export one game

Download one game in either PGN or JSON format. Ongoing games are delayed by a few seconds ranging from 3 to 60 depending on the time control, as to prevent cheat bots from using this API.

Path parameters

gameIdstringRequired=8 characters
The game ID

Query parameters

movesbooleanOptionalDefaults to true
Include the PGN moves.
pgnInJsonbooleanOptionalDefaults to false

Include the full PGN within the JSON response, in a pgn field.

tagsbooleanOptionalDefaults to true
Include the PGN tags.
clocksbooleanOptionalDefaults to true

Include clock status when available. Either as PGN comments: 2. exd5 { [%clk 1:01:27] } e5 { [%clk 1:01:28] } Or in a clocks JSON field, as centisecond integers, depending on the response type.

evalsbooleanOptionalDefaults to true

Include analysis evaluations and comments, when available. Either as PGN comments: 12. Bxf6 { [%eval 0.23] } a3 { [%eval -1.09] } Or in an analysis JSON field, depending on the response type.

accuracybooleanOptionalDefaults to false

Include accuracy percent of each player, when available. Only available in JSON.

openingbooleanOptionalDefaults to true

Include the opening name. Example: [Opening "King's Gambit Accepted, King's Knight Gambit"]

divisionbooleanOptionalDefaults to true
Plies which mark the beginning of the middlegame and endgame. Only available in JSON
literatebooleanOptionalDefaults to false

Insert textual annotations in the PGN about the opening, analysis variations, mistakes, and game termination. Example: 5... g4? { (-0.98 → 0.60) Mistake. Best move was h6. } (5... h6 6. d4 Ne7 7. g3 d5 8. exd5 fxg3 9. hxg3 c6 10. dxc6)

withBookmarkedbooleanOptionalDefaults to false

Add a bookmarked: true JSON field when the logged in user has bookmarked the game. The response type must be set to application/x-ndjson by the request Accept header.

Response

The game representation.
idstring
ratedboolean
variantenumDefaults to standard
speedenum
perfstring
createdAtlong
lastMoveAtlong
statusenum
playersobject
sourcestringOptional
initialFenstringOptional
winnerenumOptional
Allowed values:
openingobjectOptional
movesstringOptional
pgnstringOptional
daysPerTurnintegerOptional
analysislist of objectsOptional
tournamentstringOptional
swissstringOptional
clockobjectOptional
clockslist of integersOptional
divisionobjectOptional