Get a live game summary

Live scoreboard projection for a game the key owner may view: per-seat scores, leg/set, whose turn, checkout suggestion and board presence. Built from the game engine’s state; use it instead of the full detail while a game is live.

GET/games/{id}/summary

Authorization

x-api-keyAPI key · headerrequired

A user (dp_) or organization (dp_org_) API key with read scopes.

Path parameters

idstringrequired

The entity id.

Responses

200

The live game summary.

idstringrequired

typestringrequired

statusstringrequired

stateUpdatedAtstringrequired

stateVersioninteger | nullrequired

Show properties

Any of:

integer

integer

null

null

seatsGameSummarySeat[]required

Show properties

Array of GameSummarySeat

indexintegerrequired

min -9007199254740991 · max 9007199254740991

namestringrequired

userIdstring | nullrequired

imagestring | nullrequired

scorenumber | nullrequired

turnScoreinteger | nullrequired

Show properties

Any of:

integer

integer

null

null

isBustbooleanrequired

legsWoninteger | nullrequired

Show properties

Any of:

integer

integer

null

null

setsWoninteger | nullrequired

Show properties

Any of:

integer

integer

null

null

isActivebooleanrequired

turnobjectrequired

Show properties

seatIndexinteger | nullrequired

Show properties

Any of:

integer

integer

null

null

namestring | nullrequired

leginteger | nullrequired

Show properties

Any of:

integer

integer

null

null

setinteger | nullrequired

Show properties

Any of:

integer

integer

null

null

checkoutGameSummaryCheckout[] | nullrequired

Show properties

Any of:

GameSummaryCheckout[]

Array of GameSummaryCheckout

labelstringrequired

scoreintegerrequired

min -9007199254740991 · max 9007199254740991

null

null

boardsGameSummaryBoard[]required

Show properties

Array of GameSummaryBoard

idstringrequired

connectedbooleanrequired

onlineboolean | nullrequired

videoboolean | nullrequired

400

Invalid request.

messagestringrequired

401

Missing or invalid API key.

messagestringrequired

403

The API key is missing a required scope or is the wrong type for this endpoint.

messagestringrequired

404

Entity not found.

messagestringrequired

429

Rate limit exceeded. See the Retry-After header.

messagestringrequired

500

Internal server error.

messagestringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

idpath*The entity id.

Request

curl -X GET 'https://api.dartpilot.app/v1/games/string/summary' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Accept: application/json'

const response = await fetch("https://api.dartpilot.app/v1/games/string/summary", {
  method: "GET",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.dartpilot.app/v1/games/string/summary",
    headers={
        "x-api-key": "YOUR_API_KEY",
        "Accept": "application/json"
    },
)

Response

{
  "id": "string",
  "type": "string",
  "status": "string",
  "stateUpdatedAt": "string",
  "stateVersion": -9007199254740991,
  "seats": [
    {
      "index": -9007199254740991,
      "name": "string",
      "userId": "string",
      "image": "string",
      "score": 0,
      "turnScore": -9007199254740991,
      "isBust": true,
      "legsWon": -9007199254740991,
      "setsWon": -9007199254740991,
      "isActive": true
    }
  ],
  "turn": {
    "seatIndex": -9007199254740991,
    "name": "string"
  },
  "leg": -9007199254740991,
  "set": -9007199254740991,
  "checkout": [
    {
      "label": "string",
      "score": -9007199254740991
    }
  ],
  "boards": [
    {
      "id": "string",
      "connected": true,
      "online": true,
      "video": true
    }
  ]
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}