Skip to main content
GET
Get Polymarket Orderbook Summary

Request

Headers

string
required
Bearer token. Example: Bearer YOUR_API_KEY

Query Parameters

string
required
The Polymarket market condition ID. Values are accepted with or without the 0x prefix.
string
required
CLOB token ID to summarize within the condition. Polymarket conditions can have multiple outcome token books, so this parameter is required.
To find asset_id values, request a small page from Get Polymarket Market Data and collect the unique asset_id fields. See Examples.
string
The UTC date to summarize, formatted as YYYY-MM-DD. Required unless start_timestamp and end_timestamp are provided.
integer
Inclusive lower timestamp bound in Unix seconds or milliseconds. Must be provided with end_timestamp.
integer
Inclusive upper timestamp bound in Unix seconds or milliseconds. Must be provided with start_timestamp.
integer
Time bucket resolution in seconds. Default: 60. Valid range: 1 to 3600.
Use date for a full UTC day, or use start_timestamp and end_timestamp for a custom UTC window. Custom windows hydrate book state from earlier records in the loaded UTC date partitions and emit buckets inside the requested range.

Response

string
The Polymarket market condition ID.
string
The CLOB token ID used for the summary.
string
The requested date.
integer
The bucket size used to build the summary.
integer
Number of summary points returned.
array
Array of time buckets. Each bucket includes close values and OHLC candles:
The legacy alias GET /api/v1/market/orderbook-summary remains available for existing integrations.

Example

Example response