> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Base URL: https://api.eventory.ai. Send your API key in the apikey header. Market Data and Live Availability calls cost credits, pings included; GET /usage is free, so use it to test a key. Costs per endpoint: https://eventory.ai/docs/credits-and-access.md

# REST API reference

> Base URL, conventions, and a map of every HTTP endpoint.

## Base URL

```
https://api.eventory.ai
```

TLS only. Every endpoint below is relative to this host. The Notifications API is a
WebSocket on the same host and is documented under [Notifications API](/docs/stream/overview.md).

## Conventions

* **Authentication:** `apikey` header on every request. See [Authentication](/docs/authentication.md).
* **Content type:** send `Content-Type: application/json` on `POST` and `PATCH`.
* **Timestamps:** RFC 3339 / ISO 8601, UTC unless a platform says otherwise.
* **Decimals:** Market Data returns money and percentages as **strings** to preserve
  precision, e.g. `"129.50"`, except that Ticketmaster prices are numbers. Search hits
  and Live Availability return numbers.
* **Nulls:** a field that is on file but empty is `null`. Fields that never apply may
  be omitted entirely. Treat every optional field as possibly absent.
* **Additive changes:** new fields may appear in any response without notice. Ignore
  keys you do not know.
* **Response envelopes:** the Watchlist API wraps its payloads — `{ "items": [...] }`
  on a list, `{ "item": {...} }` on a single item. Market Data and Live Availability
  do not. Read each endpoint's response schema rather than assuming a bare object.
* **Errors:** one gateway envelope for auth, access, billing and routing; per-API
  formats after that. See [Errors](/docs/errors.md).

## Endpoints

### Market Data

Historical and aggregated marketplace data. Polling API, **1 credit** per call.

| Method | Path | What it returns |
| - | - | - |
| `POST` | `/eventory/data/search` | Full-text search over the event catalog with filters and sorting. |
| `GET` | `/eventory/data/viagogo/{event_id}` | Viagogo event metadata, latest summary, daily history, price histogram. |
| `GET` | `/eventory/data/sales/viagogo/{event_id}` | Recent individual sales, newest first. **1 credit per 20 rows.** |
| `GET` | `/eventory/data/ticketmaster/{tm_event_id}` | Ticketmaster scrape runs, section and offer stats, history, dashboard series. |
| `GET` | `/eventory/data/vividseats/{production_id}` | VividSeats listed inventory: latest summary with 24h changes, daily history, per-section breakdown. |
| `GET` | `/eventory/data/artist` | Artist profile, social metrics and snapshots, by exact URL. |
| `POST` | `/eventory/data/events/add` | Start tracking a Viagogo or Ticketmaster event. |
| `GET` | `/eventory/data/ping` | Liveness probe. |

### Live Availability

Current inventory for one event on one platform. **5 credits** per call.

| Method | Path | What it returns |
| - | - | - |
| `GET` | `/events/platforms` | Every platform key with regions, section shape and an example id. |
| `POST` | `/events/scrape` | Live sections, total stock and event info. Up to 60 s. |
| `GET` | `/events/ping` | Liveness probe. |

### Watchlist

The events the Notifications API watches for you. **Free.**

| Method | Path | What it does |
| - | - | - |
| `GET` | `/watchlist` | List your items, newest first. Whole watchlist by default; `limit` and `offset` page it. |
| `POST` | `/watchlist` | Create an item. Returns `201` with the created item(s). |
| `GET` | `/watchlist/{id}` | Read one item. |
| `PATCH` | `/watchlist/{id}` | Partial update. Send only what changes. |
| `DELETE` | `/watchlist/{id}` | Delete. Returns `200` with `deletedIds`. |
| `GET` | `/watchlist/health` | Liveness probe. |

### Account

| Method | Path | What it returns |
| - | - | - |
| `GET` | `/usage` | Plan, period and credit usage, live. **Free**, works with any valid key. |

## Trying it here

Each endpoint page has a playground. Paste your key into the `apikey` field and the
requests run against production, so **paid endpoints spend real credits** and
`POST /watchlist` creates real items.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.