LIlichess
TV

Get best ongoing games of a TV channel

Changed on

Get a list of ongoing games for a given TV channel. Similar to lichess.org/games. Available in PGN or ndjson format, depending on the request Accept header.

get/api/tv/{channel}

Request

  • Base URL
    https://lichess.org
  • URL
    https://lichess.org/api/tv/{channel}
  • Auth
    none required

Path parameters

channelstring required

The name of the channel in camel case.

Query parameters

nbinteger

Number of games to fetch.

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.

openingboolean

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

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 (media type: application/x-ndjson)

    • breaking

      added to the / response property oneOf list for the response status (media type: application/x-ndjson)

    • breaking

      the / response's property type changed from object to no type for status (media type: application/x-ndjson)

    • breaking

      the / response's property type changed from object to no type for status (media type: application/x-ndjson)

    • breaking

      removed the required property // from the response with the status (media type: application/x-ndjson)

    • breaking

      removed the required property // from the response with the status (media type: application/x-ndjson)

    • breaking

      removed the required property // from the response with the status (media type: application/x-ndjson)

    • breaking

      removed the required property // from the response with the status (media type: application/x-ndjson)

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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