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

> Get the bid-ask spread of a prediction market outcome, to judge how reliable its price is. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Get the bid-ask spread of a prediction market outcome, to judge how reliable its price is.

> [!NOTE]
>
> Tool ID: `polymarket_get_spread`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'polymarket_get_spread',
  {
    "token_id": "token_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute polymarket_get_spread --input '{
  "token_id": "token_123"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "spread": "example"
  }
}
```

Use `deepline describe polymarket_get_spread --json` for the latest machine-readable contract.

## Input reference

Retrieves the spread for a specific token ID. The spread is the difference between the best ask and best bid prices.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.token_id` | `string` | Yes | — | Token ID (asset ID) |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieves the spread for a specific token ID. The spread is the difference between the best ask and best bid prices.",
    "properties": {
      "token_id": {
        "type": "string",
        "description": "Token ID (asset ID)"
      }
    },
    "required": [
      "token_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.spread` | `string` | Yes | — | Spread as a string |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "spread": {
            "type": "string",
            "description": "Spread as a string"
          }
        },
        "required": [
          "spread"
        ],
        "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](https://deepline.com/docs/providers/polymarket/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


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