Watch Order Book

Watch order book updates in real-time via WebSocket. Returns a promise that resolves with the next order book update. Call repeatedly in a loop to stream updates (CCXT Pro pattern).

POST /api/{exchange}/watchOrderBook

cURL

Interactive Example

curl --request POST \
  --url https://api.pmxt.dev/api/{exchange}/watchOrderBook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "args": [
    "<string>"
  ],
  "credentials": {
    "apiKey": "<string>",
    "apiSecret": "<string>",
    "passphrase": "<string>",
    "apiToken": "<string>",
    "privateKey": "<string>",
    "signatureType": 123,
    "funderAddress": "<string>"
  }
}
'

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

Body

application/json

args · (string | number)[] · required

Required array length: 1 - 2 elements

credentials · object

Optional authentication credentials for exchange operations.

Show child attributes

Response

200 - application/json

Watch Order Book response

success · boolean

Example:

true

error · object

Show child attributes

data · object

Show child attributes