Fetch Order Book

Fetch the current order book (bids/asks) for a specific outcome. Essential for calculating spread, depth, and execution prices.

GET /api/{exchange}/fetchOrderBook

cURL

Interactive Example

curl --request GET \
  --url https://api.pmxt.dev/api/{exchange}/fetchOrderBook \
  --header 'Authorization: Bearer <token>'

200

{
  "success": true,
  "error": {
    "message": "<string>"
  },
  "data": {
    "bids": [
      {
        "price": 123,
        "size": 123
      }
    ],
    "asks": [
      {
        "price": 123,
        "size": 123
      }
    ],
    "timestamp": 123
  }
}

Authorizations

Authorization · string · header · required

Required when calling the hosted API directly (curl, requests, fetch). SDK users pass credentials via constructor params instead.

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

Query Parameters

id · string · required

Response

200 - application/json

Fetch Order Book response

success · boolean

Example:

true

error · object

Show child attributes

data · object

Show child attributes