> ## 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 Events

> Listing events, each grouping the related markets for one question, filtered by tag, slug, dates, or status. Includes SDK V2 examples, schemas, and cost.

Listing events, each grouping the related markets for one question, filtered by tag, slug, dates, or status.

<Info>
  Tool ID: `polymarket_list_events`
</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_events',
  {
    "limit": 123,
    "offset": 123,
    "order": "example"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute polymarket_list_events --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_events --json` for the latest machine-readable contract.

## Input reference

List events

| 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.id` | `array` | No | — | — |
| `payload.tag_id` | `integer` | No | — | — |
| `payload.exclude_tag_id` | `array` | No | — | — |
| `payload.slug` | `array` | No | — | — |
| `payload.tag_slug` | `string` | No | — | — |
| `payload.related_tags` | `boolean` | No | — | — |
| `payload.active` | `boolean` | No | — | — |
| `payload.archived` | `boolean` | No | — | — |
| `payload.featured` | `boolean` | No | — | — |
| `payload.cyom` | `boolean` | No | — | — |
| `payload.include_chat` | `boolean` | No | — | — |
| `payload.include_template` | `boolean` | No | — | — |
| `payload.recurrence` | `string` | No | — | — |
| `payload.closed` | `boolean` | No | — | — |
| `payload.liquidity_min` | `number` | No | — | — |
| `payload.liquidity_max` | `number` | No | — | — |
| `payload.volume_min` | `number` | No | — | — |
| `payload.volume_max` | `number` | No | — | — |
| `payload.start_date_min` | `string` | No | — | Format: `date-time`. |
| `payload.start_date_max` | `string` | No | — | Format: `date-time`. |
| `payload.end_date_min` | `string` | No | — | Format: `date-time`. |
| `payload.end_date_max` | `string` | No | — | Format: `date-time`. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "List events",
    "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"
      },
      "id": {
        "type": "array",
        "items": {
          "type": "integer"
        }
      },
      "tag_id": {
        "type": "integer"
      },
      "exclude_tag_id": {
        "type": "array",
        "items": {
          "type": "integer"
        }
      },
      "slug": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "tag_slug": {
        "type": "string"
      },
      "related_tags": {
        "type": "boolean"
      },
      "active": {
        "type": "boolean"
      },
      "archived": {
        "type": "boolean"
      },
      "featured": {
        "type": "boolean"
      },
      "cyom": {
        "type": "boolean"
      },
      "include_chat": {
        "type": "boolean"
      },
      "include_template": {
        "type": "boolean"
      },
      "recurrence": {
        "type": "string"
      },
      "closed": {
        "type": "boolean"
      },
      "liquidity_min": {
        "type": "number"
      },
      "liquidity_max": {
        "type": "number"
      },
      "volume_min": {
        "type": "number"
      },
      "volume_max": {
        "type": "number"
      },
      "start_date_min": {
        "type": "string",
        "format": "date-time"
      },
      "start_date_max": {
        "type": "string",
        "format": "date-time"
      },
      "end_date_min": {
        "type": "string",
        "format": "date-time"
      },
      "end_date_max": {
        "type": "string",
        "format": "date-time"
      }
    },
    "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[].description` | `string \| null` | No | — | — |
| `result.data[].resolutionSource` | `string \| null` | No | — | — |
| `result.data[].startDate` | `string \| null` | No | — | Format: `date-time`. |
| `result.data[].creationDate` | `string \| null` | No | — | Format: `date-time`. |
| `result.data[].endDate` | `string \| null` | No | — | Format: `date-time`. |
| `result.data[].image` | `string \| null` | No | — | — |
| `result.data[].icon` | `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[].liquidity` | `number \| null` | No | — | — |
| `result.data[].volume` | `number \| null` | No | — | — |
| `result.data[].openInterest` | `number \| null` | No | — | — |
| `result.data[].sortBy` | `string \| null` | No | — | — |
| `result.data[].category` | `string \| null` | No | — | — |
| `result.data[].subcategory` | `string \| null` | No | — | — |
| `result.data[].isTemplate` | `boolean \| null` | No | — | — |
| `result.data[].templateVariables` | `string \| null` | No | — | — |
| `result.data[].published_at` | `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` | `number \| null` | No | — | — |
| `result.data[].volume24hr` | `number \| null` | No | — | — |
| `result.data[].volume1wk` | `number \| null` | No | — | — |
| `result.data[].volume1mo` | `number \| null` | No | — | — |
| `result.data[].volume1yr` | `number \| null` | No | — | — |
| `result.data[].featuredImage` | `string \| null` | No | — | — |
| `result.data[].disqusThread` | `string \| null` | No | — | — |
| `result.data[].parentEvent` | `string \| null` | No | — | — |
| `result.data[].enableOrderBook` | `boolean \| null` | No | — | — |
| `result.data[].liquidityClob` | `number \| null` | No | — | — |
| `result.data[].negRisk` | `boolean \| null` | No | — | — |
| `result.data[].negRiskMarketID` | `string \| null` | No | — | — |
| `result.data[].negRiskFeeBips` | `integer \| null` | No | — | — |
| `result.data[].commentCount` | `integer \| null` | No | — | — |
| `result.data[].imageOptimized` | `object` | No | — | — |
| `result.data[].imageOptimized.id` | `string` | No | — | — |
| `result.data[].imageOptimized.imageUrlSource` | `string \| 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_events --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.