Export games of a bulk pairing

GET

https://lichess.org/api/bulk-pairing/:id/games

GET

/api/bulk-pairing/:id/games

curl https://lichess.org/api/bulk-pairing/5IrD6Gzz/games \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "id": "string",
  "rated": true,
  "variant": "standard",
  "speed": "ultraBullet",
  "perf": "string",
  "createdAt": 1,
  "lastMoveAt": 1,
  "status": "created",
  "players": {
    "white": {
      "user": {
        "id": "string",
        "name": "string",
        "flair": "string",
        "title": "GM",
        "patronColor": 1,
        "patron": true
      },
      "rating": 1,
      "ratingDiff": 1,
      "name": "string",
      "provisional": true,
      "aiLevel": 1,
      "analysis": {
        "inaccuracy": 1.1,
        "mistake": 1.1,
        "blunder": 1.1,
        "acpl": 1.1,
        "accuracy": 1.1
      },
      "team": "string"
    },
    "black": {
      "user": {
        "id": "string",
        "name": "string",
        "flair": "string",
        "title": "GM",
        "patronColor": 1,
        "patron": true
      },
      "rating": 1,
      "ratingDiff": 1,
      "name": "string",
      "provisional": true,
      "aiLevel": 1,
      "analysis": {
        "inaccuracy": 1.1,
        "mistake": 1.1,
        "blunder": 1.1,
        "acpl": 1.1,
        "accuracy": 1.1
      },
      "team": "string"
    }
  },
  "source": "string",
  "initialFen": "string",
  "winner": "white",
  "opening": {
    "eco": "string",
    "name": "string",
    "ply": 1
  },
  "moves": "string",
  "pgn": "string",
  "daysPerTurn": 1,
  "analysis": [
    {
      "eval": 1.1,
      "mate": 1.1,
      "best": "c2c3",
      "variation": "c3 Nc6 d4 Qb6 Be2 Nge7 Na3 cxd4 cxd4 Nf5",
      "judgment": {
        "name": "Inaccuracy",
        "comment": "Blunder. Nxg6 was best."
      }
    }
  ],
  "tournament": "string",
  "swiss": "string",
  "clock": {
    "initial": 1,
    "increment": 1,
    "totalTime": 1
  },
  "clocks": [
    1
  ],
  "division": {
    "middle": 1,
    "end": 1
  }
}

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

Authentication

AuthorizationBearer

Read the introduction for how to make authenticated requests.

Path parameters

idstringRequired

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 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)

Response

The representation of the games.

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