Get a game snapshot (public)

GET

/games/{id}

const url = 'https://play-api.jc.id.lv/games/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://play-api.jc.id.lv/games/example

The polling read of a single game — the same state object the game stream sends on connect. Also where a withheld dice reveal (mirror-pair games) becomes available once both games of the pair conclude.

Parameters

Path Parameters

required

string

Game id.

Responses

200

The current public game state.

application/json

The single-game snapshot — identical to the game stream’s Snapshot.state.

object

version

required

integer

dfen

required

DFEN — the 7th field is the pending dice pool as piece letters.

string

activeSeat

required

string

Allowed values: White Black

dicePending

required

boolean

status

required

Single-key status, e.g. {“Active”:{}} or {“Ended”:{}}.

object

timeControl

required

One of:

A single-key time-control wrapper.

object

Unlimited

required

object

clocks

Remaining milliseconds per side as of the carrying event; null on Unlimited games.

object

white

integer

black

integer

commit

required

SHA-256 of the server seed (the dice commitment).

string

seed

Revealed server seed after the game ends (null until then; withheld for a pending mirror pair).

string | null

clientSeeds

The two revealed client seeds

object | null

legalMoves

Any of:

object
null

A prefix tree of UCI micro-moves. Each key is a micro-move; its value is the tree of legal continuations. A leaf ({}) is a complete legal turn. An empty top-level tree means a forced pass. On inline copies, null means the enumeration was too large — fetch GET /games/{id}/moves.

object

key

additional properties

object recursive

players

Any of:

object
null

object

white

required

A participant’s public, spectator-safe face — never a raw id.

object

kind

required

string

Allowed values: Bot Human

name

Team-qualified bot name

string | null

black

required

A participant’s public, spectator-safe face — never a raw id.

object

kind

required

string

Allowed values: Bot Human

name

Team-qualified bot name

string | null

Example

{
  "activeSeat": "White",
  "players": {
    "white": {
      "kind": "Bot"
    },
    "black": {
      "kind": "Bot"
    }
  }
}

404

Unknown resource.