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

# Polymarket: List Series

> Listing recurring market series, such as a monthly economic release, with every event in the series. Includes SDK V2 examples, schemas, and cost.

Listing recurring market series, such as a monthly economic release, with every event in the series.

<Info>
  Tool ID: `polymarket_list_series`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'polymarket_list_series',
  {
    "limit": 123,
    "offset": 123,
    "order": "example"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={null}
deepline tools execute polymarket_list_series --input '{
  "limit": 123,
  "offset": 123,
  "order": "example"
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": [
    {
      "id": "id_123",
      "ticker": "example",
      "slug": "example"
    }
  ]
}
```

Use `deepline tools get polymarket_list_series --json` for the latest machine-readable contract.

## Input reference

List series

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.limit` | `integer` | No | — | Minimum: 0. |
| `payload.offset` | `integer` | No | — | Minimum: 0. |
| `payload.order` | `string` | No | — | Comma-separated list of fields to order by |
| `payload.ascending` | `boolean` | No | — | — |
| `payload.slug` | `array` | No | — | — |
| `payload.categories_ids` | `array` | No | — | — |
| `payload.categories_labels` | `array` | No | — | — |
| `payload.closed` | `boolean` | No | — | — |
| `payload.include_chat` | `boolean` | No | — | — |
| `payload.recurrence` | `string` | No | — | — |
| `payload.exclude_events` | `boolean` | No | — | — |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "List series",
    "properties": {
      "limit": {
        "type": "integer",
        "minimum": 0
      },
      "offset": {
        "type": "integer",
        "minimum": 0
      },
      "order": {
        "type": "string",
        "description": "Comma-separated list of fields to order by"
      },
      "ascending": {
        "type": "boolean"
      },
      "slug": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "categories_ids": {
        "type": "array",
        "items": {
          "type": "integer"
        }
      },
      "categories_labels": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "closed": {
        "type": "boolean"
      },
      "include_chat": {
        "type": "boolean"
      },
      "recurrence": {
        "type": "string"
      },
      "exclude_events": {
        "type": "boolean"
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `array` | Yes | — | Provider response payload. |
| `result.data[].id` | `string` | No | — | — |
| `result.data[].ticker` | `string \| null` | No | — | — |
| `result.data[].slug` | `string \| null` | No | — | — |
| `result.data[].title` | `string \| null` | No | — | — |
| `result.data[].subtitle` | `string \| null` | No | — | — |
| `result.data[].seriesType` | `string \| null` | No | — | — |
| `result.data[].recurrence` | `string \| null` | No | — | — |
| `result.data[].description` | `string \| null` | No | — | — |
| `result.data[].image` | `string \| null` | No | — | — |
| `result.data[].icon` | `string \| null` | No | — | — |
| `result.data[].layout` | `string \| null` | No | — | — |
| `result.data[].active` | `boolean \| null` | No | — | — |
| `result.data[].closed` | `boolean \| null` | No | — | — |
| `result.data[].archived` | `boolean \| null` | No | — | — |
| `result.data[].new` | `boolean \| null` | No | — | — |
| `result.data[].featured` | `boolean \| null` | No | — | — |
| `result.data[].restricted` | `boolean \| null` | No | — | — |
| `result.data[].isTemplate` | `boolean \| null` | No | — | — |
| `result.data[].templateVariables` | `boolean \| null` | No | — | — |
| `result.data[].publishedAt` | `string \| null` | No | — | — |
| `result.data[].createdBy` | `string \| null` | No | — | — |
| `result.data[].updatedBy` | `string \| null` | No | — | — |
| `result.data[].createdAt` | `string \| null` | No | — | Format: `date-time`. |
| `result.data[].updatedAt` | `string \| null` | No | — | Format: `date-time`. |
| `result.data[].commentsEnabled` | `boolean \| null` | No | — | — |
| `result.data[].competitive` | `string \| null` | No | — | — |
| `result.data[].volume24hr` | `number \| null` | No | — | — |
| `result.data[].volume` | `number \| null` | No | — | — |
| `result.data[].liquidity` | `number \| null` | No | — | — |
| `result.data[].startDate` | `string \| null` | No | — | Format: `date-time`. |
| `result.data[].pythTokenID` | `string \| null` | No | — | — |
| `result.data[].cgAssetName` | `string \| null` | No | — | — |
| `result.data[].score` | `integer \| null` | No | — | — |
| `result.data[].events` | `array` | No | — | — |
| `result.data[].events[].id` | `string` | No | — | — |
| `result.data[].events[].ticker` | `string \| null` | No | — | — |
| `result.data[].events[].slug` | `string \| null` | No | — | — |
| `result.data[].events[].title` | `string \| null` | No | — | — |
| `result.data[].events[].subtitle` | `string \| null` | No | — | — |
| `result.data[].events[].description` | `string \| null` | No | — | — |
| `result.data[].events[].resolutionSource` | `string \| null` | No | — | — |
| `result.data[].events[].startDate` | `string \| null` | No | — | Format: `date-time`. |
| `result.data[].events[].creationDate` | `string \| null` | No | — | Format: `date-time`. |
| `result.data[].events[].endDate` | `string \| null` | No | — | Format: `date-time`. |
| `result.data[].events[].image` | `string \| null` | No | — | — |
| `result.data[].events[].icon` | `string \| null` | No | — | — |
| `result.data[].events[].active` | `boolean \| null` | No | — | — |
| `result.data[].events[].closed` | `boolean \| null` | No | — | — |
| `result.data[].events[].archived` | `boolean \| null` | No | — | — |

The table shows the first 50 fields. Use the live contract below for every field.

<Info>
  This output schema is too large to embed without slowing the page. Get the complete live contract with `deepline tools get polymarket_list_series --json`.
</Info>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Polymarket provider guide](/docs/providers/polymarket/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)


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