Polymarket: Get Order Book

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

Tool ID: polymarket_get_order_book

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.

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

deepline tools execute polymarket_get_order_book --input '{
  "token_id": "token_123"
}' --json

Example response

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

{
  "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 tools get 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)

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

Deepline cost

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

Get started

Build and automate

Common workflows

Data and integrations

Reference

Polymarket: Get Order Book

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation