Docs / Getting started

Quick start

Make your first request in two minutes: get a key, search, fetch one item, and filter.

Get a key

Reading needs no key, so the search below works as it is. For photos, contributing, and a higher rate limit: log in, open Account → API keys, and create one. Keys start with bgdb_ and are shown once.

curl "https://tablearchive.dev/v1/items?q=wingspan" \
  -H "Authorization: Bearer $TA_KEY"
{
  "total": 3,
  "items": [{
    "id": "9b2e…",
    "kind": "board_game",
    "name": "Wingspan",
    "slug": "wingspan",
    "data": { "year_published": 2019, "min_players": 1, "max_players": 5, "min_age": 10 },
    "image": { "thumb_url": "https://tablearchive.dev/v1/images/…/file?size=thumb&…" },
    "updated_at": "2026-10-04T18:21:07.000Z"
  }]
}

Fetch one item

curl "https://tablearchive.dev/v1/items/wingspan" -H "Authorization: Bearer $TA_KEY"

The response adds credits, terms, relations, images, external_ids, and provenance (which source set each field). See Items.

Filter

Combine any of these on GET /v1/items:

ParameterExampleWhat it does
qcatanSearch names and descriptions
kindboard_gameOne kind; see Items
players2Playable with exactly this many
max_playtime45At most this many minutes
age8Suitable for a player this old
year2019Published that year
external_id029877030712A barcode, Wikidata QID, or BGG ID

Full list in Search and filters.