> ## 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: Get Live Volume

> Reading the live traded volume of an event and its markets. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Reading the live traded volume of an event and its markets.

<Info>
  Tool ID: `polymarket_get_live_volume`
</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_get_live_volume',
  {
    "id": 123
  },
);

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

### CLI

```bash theme={null}
deepline tools execute polymarket_get_live_volume --input '{
  "id": 123
}' --json
```

## Example response

The static output schema is not detailed enough to generate a reliable example. Use `deepline tools get polymarket_get_live_volume --json` for the complete live contract.

## Input reference

**Data API v2:** this route has a v2 counterpart, `GET /v2/live-volume`. See [Migrating to Data API v2](/docs/migrate/data-api-v1-to-v2).

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.id` | `integer` | Yes | — | Minimum: 1. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "**Data API v2:** this route has a v2 counterpart, `GET /v2/live-volume`. See [Migrating to Data API v2](/migrate/data-api-v1-to-v2).",
    "properties": {
      "id": {
        "type": "integer",
        "minimum": 1
      }
    },
    "required": [
      "id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `array` | Yes | — | Provider response payload. |
| `result.data[].total` | `number` | No | — | — |
| `result.data[].markets` | `array` | No | — | — |
| `result.data[].markets[].market` | `string` | No | — | 0x-prefixed 64-hex string Pattern: `^0x[a-fA-F0-9]&#123;64&#125;$`. |
| `result.data[].markets[].value` | `number` | No | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "array",
        "description": "Provider response payload.",
        "items": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "markets": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "market": {
                    "type": "string",
                    "description": "0x-prefixed 64-hex string",
                    "pattern": "^0x[a-fA-F0-9]{64}$"
                  },
                  "value": {
                    "type": "number"
                  }
                },
                "additionalProperties": false
              }
            }
          },
          "additionalProperties": false
        }
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

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