> ## 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. # List series > List broad categories of prediction markets (e.g., "NBA", "US Politics"). Supports filtering by date ranges, text search, tags, and pagination. Results are sorted by the selected field (default: `updated_at desc`). **Pagination:** Use the `next_cursor` value from the response to fetch the next page. ## OpenAPI ````yaml https://api.polymarketdata.co/openapi.json get /v1/series openapi: 3.1.0 info: title: PolymarketData API description: >- Historical Polymarket market data with plan-based access controls (resolution, lookback window, and RPM). Use this API to discover markets, then query historical metrics, prices, and order books. ## Authentication All `/v1` endpoints require an API key. 1. Sign in to the PolymarketData dashboard. [https://app.polymarketdata.co/](https://app.polymarketdata.co/dashboard) 2. Create an API key. 3. Send the key in the `X-API-Key` header on every request. Header format: `X-API-Key: pk_live_your_key_here` ## Key Concepts Polymarket data is organized in a hierarchy: - **Series**: Broad themes or recurring categories (for example, `US Politics` or `NBA`). - **Events**: Specific real-world happenings within a series (for example, `Presidential Debate`). - **Markets**: Tradable prediction questions inside an event (for example, `Will candidate X win?`). - **Tokens**: Outcome contracts within a market (for example, `Yes` and `No`). Mental model: `Series -> Events -> Markets -> Tokens`. ## Typical Workflow 1. Discover objects with `GET /v1/series`, `GET /v1/events`, and `GET /v1/markets`. 2. Select a market ID or slug from discovery responses. 3. Query historical data via `/v1/markets/{id_or_slug}/metrics`, `/prices`, or `/books`. version: 0.1.1 servers: - url: https://api.polymarketdata.co description: Production security: [] tags: - name: Clients & SDKs description: >- Official client libraries and SDK guidance. ### Python SDK - Package: [`polymarketdata-sdk`](https://pypi.org/project/polymarketdata-sdk/) - Install: `pip install polymarketdata-sdk` - Optional dataframe extras: `pip install "polymarketdata-sdk[dataframe]"` - API key can be passed directly or via `POLYMARKETDATA_API_KEY` ### SDK Surface Map | Namespace | What it covers | Core methods | |---|---|---| | `client.utility` | API health and plan/rate status | `health()`, `usage()` | | `client.discovery` | entity discovery and lookup | `list_series()`, `list_events()`, `list_markets()`, `get_market()`, `list_tags()` | | `client.discovery` iterators | auto-pagination for discovery | `iter_series()`, `iter_events()`, `iter_markets()` | | `client.history` | historical market/token data | `get_market_metrics()`, `get_market_prices()`, `get_token_prices()`, `get_market_books()`, `get_token_books()` | | `client.history` iterators | auto-pagination for history | `iter_market_metrics()`, `iter_token_prices()`, `iter_token_books()` | ### 60-Second Quickstart ```python from polymarketdata import PolymarketDataClient # api_key can also be set via POLYMARKETDATA_API_KEY with PolymarketDataClient(api_key="YOUR_API_KEY") as client: health = client.utility.health() usage = client.utility.usage() print(health.status) print(usage.plan) print(usage.limits.requests_remaining) ``` ### End-to-End Example (Discovery -> History) ```python from polymarketdata import PolymarketDataClient, Resolution with PolymarketDataClient(api_key="YOUR_API_KEY") as client: markets = client.discovery.list_markets( event_slug="us-presidential-election-2025", limit=5, ) market_id_or_slug = markets.data[0].slug or markets.data[0].id metrics = client.history.get_market_metrics( market_id_or_slug, start_ts="2025-09-01T00:00:00Z", end_ts="2025-11-05T00:00:00Z", resolution=Resolution.ONE_DAY, ) print(metrics.market_id, len(metrics.data)) ``` ### Supported Resolutions These match the API `resolution` enum: - `Resolution.ONE_MIN` (`1m`) - `Resolution.TEN_MIN` (`10m`) - `Resolution.ONE_HOUR` (`1h`) - `Resolution.SIX_HOUR` (`6h`) - `Resolution.ONE_DAY` (`1d`) ### DataFrame Helpers If installed with `polymarketdata-sdk[dataframe]`, use: - `to_dataframe_metrics(...)` - `to_dataframe_prices(...)` - `to_dataframe_books(...)` ### Errors and Retry Behavior All SDK exceptions inherit from `PolymarketDataError`. Common exception types: - `AuthenticationError` (401) - `PermissionDeniedError` (403) - `NotFoundError` (404) - `RateLimitError` (429) - `ServerError` (5xx) - `NetworkError` / `RequestTimeoutError` The SDK retries `429` and `5xx` responses with exponential backoff + jitter. Tune with `max_retries`, `retry_backoff_base`, `retry_backoff_max`, and `timeout`. ### Response Metadata Responses include: - `.meta` (HTTP metadata such as `status_code`, `request_id`) - `.raw` (unmodified response payload) externalDocs: description: Python SDK package url: https://pypi.org/project/polymarketdata-sdk/ - name: Discovery description: >- Start here. Discover series, events, and markets, then use the returned market IDs/slugs in History endpoints. - name: History description: >- Retrieve historical metrics, prices, and order book snapshots for a specific market. - name: Utility description: Health, status, and usage endpoints. paths: /v1/series: get: tags: - Discovery summary: List series description: >- List broad categories of prediction markets (e.g., "NBA", "US Politics"). Supports filtering by date ranges, text search, tags, and pagination. Results are sorted by the selected field (default: `updated_at desc`). **Pagination:** Use the `next_cursor` value from the response to fetch the next page. operationId: list_series_v1_series_get parameters: - name: search in: query required: false schema: type: string maxLength: 200 description: Optional case-insensitive text match for series title or slug. examples: - nba title: Search description: Optional case-insensitive text match for series title or slug. - name: limit in: query required: false schema: type: integer maximum: 1000 minimum: 1 description: Maximum number of items returned in this page. examples: - 100 default: 100 title: Limit description: Maximum number of items returned in this page. - name: cursor in: query required: false schema: type: string description: Opaque cursor from a previous `metadata.next_cursor` value. title: Cursor description: Opaque cursor from a previous `metadata.next_cursor` value. - name: start_date_min in: query required: false schema: type: string description: >- Filter for series with `start_date` greater than or equal to this ISO 8601 timestamp. examples: - '2026-01-01T00:00:00Z' title: Start Date Min description: >- Filter for series with `start_date` greater than or equal to this ISO 8601 timestamp. - name: start_date_max in: query required: false schema: type: string description: >- Filter for series with `start_date` less than or equal to this ISO 8601 timestamp. examples: - '2026-12-31T23:59:59Z' title: Start Date Max description: >- Filter for series with `start_date` less than or equal to this ISO 8601 timestamp. - name: end_date_min in: query required: false schema: type: string description: >- Filter for series with `end_date` greater than or equal to this ISO 8601 timestamp. examples: - '2026-01-01T00:00:00Z' title: End Date Min description: >- Filter for series with `end_date` greater than or equal to this ISO 8601 timestamp. - name: end_date_max in: query required: false schema: type: string description: >- Filter for series with `end_date` less than or equal to this ISO 8601 timestamp. examples: - '2026-12-31T23:59:59Z' title: End Date Max description: >- Filter for series with `end_date` less than or equal to this ISO 8601 timestamp. - name: tags in: query required: false schema: anyOf: - type: array items: type: string - type: 'null' description: >- Filter by event tags. Supports repeated params and comma-separated values. examples: - crypto title: Tags description: >- Filter by event tags. Supports repeated params and comma-separated values. - name: tags_match in: query required: false schema: $ref: '#/components/schemas/TagsMatchMode' description: 'Tag matching strategy: any (OR) or all (AND).' default: any description: 'Tag matching strategy: any (OR) or all (AND).' - name: sort in: query required: false schema: $ref: '#/components/schemas/SortField' description: Field used to sort the response rows. default: updated_at description: Field used to sort the response rows. - name: order in: query required: false schema: $ref: '#/components/schemas/SortOrder' description: Sort direction. default: desc description: Sort direction. responses: '200': description: Paginated list of market series. content: application/json: schema: $ref: '#/components/schemas/SeriesListResponse' '400': description: Malformed date range or invalid pagination cursor. content: application/json: examples: invalid_cursor: summary: Invalid cursor value: detail: Invalid pagination cursor invalid_date_range: summary: Invalid date range value: detail: start_date_min must be <= start_date_max schema: $ref: '#/components/schemas/ErrorResponse' '401': description: API key is missing, invalid, or expired. content: application/json: example: detail: Invalid or expired API key. schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Validation error for one or more request parameters. content: application/json: example: detail: - loc: - query - limit msg: Input should be less than or equal to 1000 type: less_than_equal '429': description: Rate limit exceeded for the current API key. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: detail: Rate limit exceeded. Please try again later. '500': description: Unexpected server-side error. content: application/json: example: detail: Failed to fetch data. schema: $ref: '#/components/schemas/ErrorResponse' security: - ApiKeyAuth: [] components: schemas: TagsMatchMode: type: string enum: - any - all title: TagsMatchMode description: Tag match behavior for filtering. SortField: type: string enum: - created_at - updated_at title: SortField description: Sortable fields for discovery listings. SortOrder: type: string enum: - asc - desc title: SortOrder description: Sort direction for discovery listings. SeriesListResponse: properties: metadata: $ref: '#/components/schemas/PaginationMetadata' description: Pagination metadata. data: items: $ref: '#/components/schemas/SeriesItem' type: array title: Data description: Series results for this page. type: object required: - metadata - data title: SeriesListResponse description: Paginated response for `GET /series`. example: data: - id: '101' slug: nba start_date: '2025-09-01T00:00:00Z' status: open title: NBA - id: '102' slug: us-politics start_date: '2025-09-01T00:00:00Z' status: open title: US Politics metadata: count: 2 limit: 100 next_cursor: eyJ2IjoiMjAyNS0wNi0wNVQxMjozNDo1NiswMDowMCIsImlkIjoiMTAxIn0= ErrorResponse: properties: detail: type: string title: Detail description: Human-readable error description. type: object required: - detail title: ErrorResponse description: Generic API error response. PaginationMetadata: properties: count: type: integer minimum: 0 title: Count description: Number of items returned in this page. limit: type: integer maximum: 1000 minimum: 1 title: Limit description: Requested maximum number of items for this page. next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: >- Opaque cursor to request the next page. Null when there are no more results. type: object required: - count - limit title: PaginationMetadata description: Pagination metadata returned by list endpoints. SeriesItem: properties: id: type: string title: Id description: Unique series identifier. examples: - '101' slug: type: string title: Slug description: Stable URL-friendly series slug. examples: - nba title: type: string title: Title description: Display title of the series. examples: - NBA status: type: string title: Status description: Current series status. examples: - open start_date: anyOf: - type: string format: date-time - type: 'null' title: Start Date description: Series start timestamp in ISO 8601 format. examples: - '2025-09-01T00:00:00Z' end_date: anyOf: - type: string format: date-time - type: 'null' title: End Date description: Series end timestamp in ISO 8601 format, if closed. examples: - '2025-10-31T23:59:59Z' type: object required: - id - slug - title - status title: SeriesItem description: Series object returned by `GET /series`. securitySchemes: ApiKeyAuth: type: apiKey description: >- Create an API key in the PolymarketData dashboard and send it in the `X-API-Key` request header. Example: `X-API-Key: pk_live_your_key_here` in: header name: X-API-Key ````