# TableArchive

> A database of board games, card games, and tabletop RPGs with a simple JSON API. Facts only: players, playtime, age, credits, editions, barcodes, photos. No ratings or reviews.

- Base URL: https://tablearchive.dev/v1
- Auth: reading needs no key. Photos, contributing, and higher rate limits take `Authorization: Bearer <key>`; keys are made in the web app under Account → API keys.
- OpenAPI: https://tablearchive.dev/openapi.json
- Every docs page is also Markdown: https://tablearchive.dev/docs/<page>.md, or send `Accept: text/markdown` to https://tablearchive.dev/docs/<page>.
- All pages in one file: https://tablearchive.dev/llms-full.txt
- License: our own work is CC0 1.0 (public domain, no warranty); facts and photos from other sources keep their licenses, returned in each item's provenance and each photo's license field. See https://tablearchive.dev/docs/sources-licenses.md

## Getting started

- [Introduction](https://tablearchive.dev/docs/introduction.md): What TableArchive is, what it holds, and how to use it.
- [Quick start](https://tablearchive.dev/docs/quick-start.md): Make your first request in two minutes: get a key, search, fetch one item, and filter.
- [Authentication](https://tablearchive.dev/docs/authentication.md): API keys, the Authorization header, and what a key can do.
- [Rate limits and errors](https://tablearchive.dev/docs/rate-limits.md): Request limits, the 429 response, and the shape of every error.

## Catalog

- [Items and kinds](https://tablearchive.dev/docs/items.md): The item record, its known fields, and the kinds of things in the catalog.
- [Search and filters](https://tablearchive.dev/docs/search.md): Every parameter of GET /v1/items, and how results are sorted.
- [Lookup by barcode or ID](https://tablearchive.dev/docs/lookup.md): Find an item from a barcode scan or an ID in another database.
- [Photos](https://tablearchive.dev/docs/photos.md): Photo sizes, signed links, and the license on each one.
- [Credits, terms, relations](https://tablearchive.dev/docs/credits-terms-relations.md): People and publishers, mechanics and categories, and how items connect.
- [History and provenance](https://tablearchive.dev/docs/history.md): Where each fact came from, every change to an item, and a feed of changes to sync against.

## Contributing

- [Submissions](https://tablearchive.dev/docs/submissions.md): Adding items and correcting facts through the API, and what happens next.
- [Uploading photos](https://tablearchive.dev/docs/uploading-photos.md): Adding a photo to an item or to your pending submission.
- [Sources and licenses](https://tablearchive.dev/docs/sources-licenses.md): Where the data comes from, and what you may do with it.

## For AI agents

- [llms.txt](https://tablearchive.dev/docs/llms-txt.md): Files written for AI assistants and coding agents.
- [OpenAPI](https://tablearchive.dev/docs/openapi.md): The machine-readable description of the API, for typed clients and agents.
- [Prompting tips](https://tablearchive.dev/docs/prompting-tips.md): How to describe TableArchive to an AI assistant so it writes working code first time.

## Optional

- [API explorer](https://tablearchive.dev/api): Swagger UI for trying requests