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

# API overview

> Every public PolymarketData route, generated from the live OpenAPI spec.

Base URL: `https://api.polymarketdata.co`

Authenticate every `/v1` call with `X-API-Key`. Each route below is its own reference page — parameters, responses, and the playground come from `https://api.polymarketdata.co/openapi.json`. Do not add per-endpoint MDX files.

<Columns cols={2}>
  <Card title="Authentication" icon="key" href="/authentication">
    `X-API-Key` header, 401s, and plan `403`s.
  </Card>

  <Card title="Data model" icon="search" href="/guides/concepts">
    Series, events, markets, and tokens before you pull history.
  </Card>

  <Card title="Errors and limits" icon="triangle-alert" href="/guides/errors">
    Rate limits, lookback windows, and validation errors.
  </Card>

  <Card title="Python SDK" icon="code" href="/sdks/python">
    Same surface as typed methods and iterators.
  </Card>
</Columns>

## Utility

<CardGroup cols={2}>
  <Card title="GET /v1/health" href="/api-reference/utility/authenticated-liveness-check">
    Authenticated liveness check.
  </Card>

  <Card title="GET /v1/usage" href="/api-reference/utility/get-usage-information">
    Plan, rate-limit remaining, and allowed data points.
  </Card>
</CardGroup>

## Discovery

<CardGroup cols={2}>
  <Card title="GET /v1/series" href="/api-reference/discovery/list-series">
    List series (NBA, US Politics, …).
  </Card>

  <Card title="GET /v1/events" href="/api-reference/discovery/list-events">
    List events inside a series.
  </Card>

  <Card title="GET /v1/markets" href="/api-reference/discovery/list-markets">
    List markets and their tokens.
  </Card>

  <Card title="GET /v1/markets/{id_or_slug}" href="/api-reference/discovery/get-market-details">
    One market, including resolution and tokens.
  </Card>

  <Card title="GET /v1/tags" href="/api-reference/discovery/list-available-tags">
    Unique tags for discovery filters.
  </Card>
</CardGroup>

## History

<CardGroup cols={2}>
  <Card title="GET /v1/markets/{id_or_slug}/metrics" href="/api-reference/history/get-market-metrics-history">
    Volume, liquidity, and spread.
  </Card>

  <Card title="GET /v1/markets/{id_or_slug}/prices" href="/api-reference/history/get-market-token-prices-history">
    Prices for every token in a market.
  </Card>

  <Card title="GET /v1/tokens/{token_id}/prices" href="/api-reference/history/get-token-price-history">
    Prices for a single token.
  </Card>

  <Card title="GET /v1/markets/{id_or_slug}/books" href="/api-reference/history/get-market-order-book-history">
    L2 books for every token in a market.
  </Card>

  <Card title="GET /v1/tokens/{token_id}/books" href="/api-reference/history/get-token-order-book-history">
    L2 book for a single token.
  </Card>
</CardGroup>

## Shared history query parameters

These appear on every prices, metrics, and books route:

| Parameter    | Required | Notes                                         |
| ------------ | -------- | --------------------------------------------- |
| `start_ts`   | Yes      | Inclusive. ISO 8601 or Unix seconds           |
| `end_ts`     | Yes      | Exclusive. ISO 8601 or Unix seconds           |
| `resolution` | Yes      | `1m`, `10m`, `1h`, `6h`, or `1d`              |
| `limit`      | No       | Default 100, max 200                          |
| `cursor`     | No       | `metadata.next_cursor` from the previous page |

## Formats

History endpoints return JSON only. Discovery endpoints are also JSON.

<Note>
  After the API spec changes, trigger a Mintlify deploy so each route page picks up the new document. Hide an operation from this sidebar with `x-hidden: true` in the spec.
</Note>