Get order book summaries for a set of markets with a single request.
POST /<clob-endpoint>/books
Name | Required | Type | Description |
---|---|---|---|
params | yes | BookParams | search params for books |
BookParams
object is of the form:
Name | Required | Type | Description |
---|---|---|---|
token_id | yes | string | token ID of market to get book for |
Name | Type | Description |
---|---|---|
- | OrderBook[] | list orderbooks |
OrderBook
object is of the form:
Name | Type | Description |
---|---|---|
market | string | condition id |
asset_id | string | id of the asset/token |
hash | string | hash summary of the orderbook content |
timestamp | string | unix timestamp the current book generation in milliseconds (1/1,000 second) |
bids | OrderSummary[] | list of bid levels |
asks | OrderSummary[] | list of ask levels |
min_order_size | string | Minimum allowed order size |
neg_risk | boolean | NegRisk or not |
tick_size | string | Current tick size for this market |
OrderSummary
object is of the form:
Name | Type | Description |
---|---|---|
price | string | price |
size | string | size |