Skip to navigation
API ReferenceGames

Export your bookmarked games

Download all games bookmarked by you, in PGN or ndjson format. Games are sorted by reverse chronological order (most recent first). We recommend streaming the response, for it can be very long.

Authentication

Query parameters

sinceintegerOptional>=1356998400070
Download games bookmarked since this timestamp. Defaults to account creation date.
untilintegerOptional>=1356998400070
Download games bookmarked until this timestamp. Defaults to now.
maxintegerOptional>=1
How many bookmarked games to download. Leave empty to download all bookmarked games.
movesbooleanOptionalDefaults to true
Include the PGN moves.
pgnInJsonbooleanOptionalDefaults to false

Include the full PGN within the JSON response, in a pgn field. The response type must be set to application/x-ndjson by the request Accept header.

tagsbooleanOptionalDefaults to true
Include the PGN tags.
clocksbooleanOptionalDefaults to false

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 false

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 false

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

divisionbooleanOptionalDefaults to false
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)

lastFenbooleanOptionalDefaults to false

Include the FEN notation of the last position of the game. The response type must be set to application/x-ndjson by the request Accept header.

sortenumOptionalDefaults to dateDesc
Sort order of the bookmarks.
Allowed values:

Response

The bookmarked games of the user.
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