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

# 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 real-time stream is a
WebSocket on the same host and is documented under [Real-time stream](/stream/overview).

## Conventions

* **Authentication:** `apikey` header on every request. See [Authentication](/authentication).
* **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"`. Live Availability returns 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.
* **Errors:** one gateway envelope for auth, access, billing and routing; per-API
  formats after that. See [Errors](/errors).

## 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/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 real-time stream watches for you. **Free.**

| Method   | Path                | What it does                                 |
| -------- | ------------------- | -------------------------------------------- |
| `GET`    | `/watchlist`        | List all your items.                         |
| `POST`   | `/watchlist`        | Create an item. Returns `201` with the item. |
| `GET`    | `/watchlist/{id}`   | Read one item.                               |
| `PATCH`  | `/watchlist/{id}`   | Partial update. Send only what changes.      |
| `DELETE` | `/watchlist/{id}`   | Delete. Returns `204`.                       |
| `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.