LIlichess
Bulk pairings

Export games of a bulk pairing

Changed on

Download games of a bulk in PGN or ndjson format, depending on the request Accept header.

get/api/bulk-pairing/{id}/games

Request

  • Base URL
    https://lichess.org
  • URL
    https://lichess.org/api/bulk-pairing/{id}/games
  • Auth
    OAuth 2
    Authorization code: https://lichess.org/oauth
    Token URL: https://lichess.org/api/token scopes: challenge:bulk

Path parameters

idstring required

The ID of the bulk pairing

Example:5IrD6Gzz

Query parameters

movesboolean

Include the PGN moves.

pgnInJsonboolean

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

tagsboolean

Include the PGN tags.

clocksboolean

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.

evalsboolean

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.

accuracyboolean

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

openingboolean

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

divisionboolean

Plies which mark the beginning of the middlegame and endgame. Only available in JSON

literateboolean

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)

Headers

Accept'application/x-chess-pgn' | 'application/x-ndjson'

Specify the desired response format. Use application/x-chess-pgn to get the games in PGN format. Use application/x-ndjson to get the games in ndjson format. Read about ndjson here and how you can parse it in Javascript.

Response

The representation of the games.

Changes

  • 9c95384dd8b1Revision changes
    • info

      added the optional property ////// to the response with the status (media type: application/x-ndjson)

    • info

      added the optional property ////// to the response with the status (media type: application/x-ndjson)

  • 9b0422af5084Revision changes
    • breaking

      added to the / response property oneOf list for the response status

    • breaking

      added to the / response property oneOf list for the response status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status