> ## 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 Order Book

> Reading the full bid and ask depth for one outcome token to judge liquidity. Includes SDK V2 examples, input constraints, response fields, and Deepline cost.

Reading the full bid and ask depth for one outcome token to judge liquidity.

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

## 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_order_book',
  {
    "token_id": "token_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute polymarket_get_order_book --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": {
    "market": "example",
    "asset_id": "asset_123",
    "timestamp": "example",
    "hash": "example",
    "bids": [
      {
        "price": "example",
        "size": "example"
      }
    ],
    "asks": [
      {
        "price": "example",
        "size": "example"
      }
    ],
    "min_order_size": "example",
    "tick_size": "example",
    "neg_risk": true,
    "last_trade_price": "example"
  }
}
```

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

## Input reference

Retrieves the order book summary for a specific token ID. Includes bids, asks, market details, and last trade price.

| 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 order book summary for a specific token ID. Includes bids, asks, market details, and last trade price.",
    "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.market` | `string` | Yes | — | Market condition ID |
| `result.data.asset_id` | `string` | Yes | — | Token ID (asset ID) |
| `result.data.timestamp` | `string` | Yes | — | Timestamp of the order book snapshot |
| `result.data.hash` | `string` | Yes | — | Hash of the order book summary |
| `result.data.bids` | `array` | Yes | — | List of bid orders (sorted by price descending) |
| `result.data.bids[].price` | `string` | Yes | — | Order price |
| `result.data.bids[].size` | `string` | Yes | — | Order size |
| `result.data.asks` | `array` | Yes | — | List of ask orders (sorted by price ascending) |
| `result.data.asks[].price` | `string` | Yes | — | Order price |
| `result.data.asks[].size` | `string` | Yes | — | Order size |
| `result.data.min_order_size` | `string` | Yes | — | Minimum order size |
| `result.data.tick_size` | `string` | Yes | — | Minimum price increment (tick size) |
| `result.data.neg_risk` | `boolean` | Yes | — | Whether negative risk is enabled for this market |
| `result.data.last_trade_price` | `string` | Yes | — | Last trade price |
| `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": {
          "market": {
            "type": "string",
            "description": "Market condition ID"
          },
          "asset_id": {
            "type": "string",
            "description": "Token ID (asset ID)"
          },
          "timestamp": {
            "type": "string",
            "description": "Timestamp of the order book snapshot"
          },
          "hash": {
            "type": "string",
            "description": "Hash of the order book summary"
          },
          "bids": {
            "type": "array",
            "description": "List of bid orders (sorted by price descending)",
            "items": {
              "type": "object",
              "properties": {
                "price": {
                  "type": "string",
                  "description": "Order price"
                },
                "size": {
                  "type": "string",
                  "description": "Order size"
                }
              },
              "required": [
                "price",
                "size"
              ],
              "additionalProperties": false
            }
          },
          "asks": {
            "type": "array",
            "description": "List of ask orders (sorted by price ascending)",
            "items": {
              "type": "object",
              "properties": {
                "price": {
                  "type": "string",
                  "description": "Order price"
                },
                "size": {
                  "type": "string",
                  "description": "Order size"
                }
              },
              "required": [
                "price",
                "size"
              ],
              "additionalProperties": false
            }
          },
          "min_order_size": {
            "type": "string",
            "description": "Minimum order size"
          },
          "tick_size": {
            "type": "string",
            "description": "Minimum price increment (tick size)"
          },
          "neg_risk": {
            "type": "boolean",
            "description": "Whether negative risk is enabled for this market"
          },
          "last_trade_price": {
            "type": "string",
            "description": "Last trade price"
          }
        },
        "required": [
          "market",
          "asset_id",
          "timestamp",
          "hash",
          "bids",
          "asks",
          "min_order_size",
          "tick_size",
          "neg_risk",
          "last_trade_price"
        ],
        "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.