Fetch Order Books

Batch variant of {@link fetchOrderBook}. Fetches order books for multiple outcomes in a single request where the exchange supports it.

POST /api/{exchange}/fetchOrderBooks

Python

Polymarket

import pmxt

# API key optional — enables faster catalog-backed lookups
exchange = pmxt.Polymarket(
    pmxt_api_key="YOUR_PMXT_API_KEY",
)
result = exchange.fetch_order_books(["67890"])

200

{
  "success": true,
  "error": {
    "message": "<string>",
    "code": "HOSTED_TRADING_ERROR",
    "retryable": true,
    "exchange": "<string>",
    "detail": {}
  },
  "data": {}
}

Path Parameters

exchange · enum<string> · required

The prediction market exchange to target.

Available options: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us, gemini-titan, hyperliquid, suibets, rain, hunch, router

Body

application/json

args · string[][] · required

Required array length: 1 element

credentials · object

Optional authentication credentials for exchange operations.

Show child attributes

Response

200 - application/json

Fetch Order Books response

success · boolean

Example:

true

error · object

Structured error envelope returned inside BaseResponse.error and ErrorResponse.error. Hosted-mode endpoints populate code, retryable, and optionally exchange / detail; legacy local-mode endpoints may still return only message.

Show child attributes

data · object

Show child attributes