Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.predexon.com/llms.txt

Use this file to discover all available pages before exploring further.

The orderbook channel ("orderbook") streams real-time off-chain orderbook data from Polymarket’s CLOB. Subscribe by token_ids, condition_ids, or market_slugs, or use wildcard (["*"]) for the full firehose of all 100k+ tokens.
  • Targeted subscriptions deliver individual events as they happen. Latency is essentially identical to Polymarket’s native feeds.
  • Wildcard subscriptions deliver 250ms batched events with price-level conflation.

​
Subscribe

{
  "action": "subscribe",
  "platform": "polymarket",
  "version": 1,
  "type": "orderbook",
  "filters": {
    "market_slugs": ["us-x-iran-ceasefire-by-april-7-278"]
  }
}

​
Filter Types

Exactly one filter type per subscribe message.
FilterDescriptionExample
token_idsCLOB token IDs["82855...", "55194..."]
condition_idsMarket condition IDs["0x4c57..."]
market_slugsMarket URL slugs["bitcoin-100k-2026"]
Use ["*"] with any filter type for the full firehose. When subscribing by market_slugs or condition_ids, both sides of the market (Yes + No) are resolved and subscribed automatically. You’ll receive a book_snapshot for each outcome. When subscribing by token_ids, you receive only the specific outcome(s) you subscribed to.
users filter is not supported on the orderbook channel. Use the trades channel for wallet-level filtering.

​
Connection Lifecycle

​
Targeted Subscriptions

→ subscribe
← ack
← book_snapshot (Yes side)
← book_snapshot (No side)
← snapshots_done
← price_change events (individual, as they happen)
← last_trade events
← tick_size_change events

​
Wildcard / Firehose

→ subscribe
← ack
← event_batch (every ~250ms, conflated)
← event_batch
← ...

​
Event Types

​
book_snapshot

Sent on subscribe. Includes full orderbook state and market metadata for enrichment. 
{
  "type": "event",
  "subscription_id": "sub_xxx",
  "data": {
    "event_type": "book_snapshot",
    "token_id": "82855...",
    "condition_id": "0x4c57...",
    "slug": "us-x-iran-ceasefire-by-april-7-278",
    "question": "US x Iran ceasefire by April 7?",
    "event_title": "US x Iran ceasefire by...?",
    "outcome": "Yes",
    "timestamp": 1775196804071,
    "bids": [{"price": "0.02", "size": "5000"}, ...],
    "asks": [{"price": "0.98", "size": "3000"}, ...],
    "hash": "abc123..."
  }
}
question and event_title are included only in book_snapshot events. Live events (price_change, last_trade, tick_size_change) omit these for bandwidth efficiency. Use the snapshot for display metadata.

​
price_change

Live delta for a single price level. Size "0" means the level was removed; otherwise upsert (add or update). 
{
  "type": "event",
  "subscription_id": "sub_xxx",
  "data": {
    "event_type": "price_change",
    "token_id": "82855...",
    "condition_id": "0x4c57...",
    "slug": "us-x-iran-ceasefire-by-april-7-278",
    "outcome": "Yes",
    "timestamp": 1775196805000,
    "side": "BUY",
    "price": "0.03",
    "size": "71891.78",
    "best_bid": "0.03",
    "best_ask": "0.97"
  }
}

​
Field Reference

FieldTypeDescription
event_typestring"price_change"
token_idstringCLOB token ID
condition_idstringMarket condition ID (hex)
slugstringMarket URL slug
outcomestring"Yes" or "No"
timestampnumberPolymarket server timestamp (Unix ms)
sidestring"BUY" (bid) or "SELL" (ask)
pricestringPrice level (0 to 1)
sizestringSize at this level ("0" = removed)
best_bidstringCurrent best bid price for this token
best_askstringCurrent best ask price for this token

​
last_trade

Trade execution event. 
{
  "type": "event",
  "subscription_id": "sub_xxx",
  "data": {
    "event_type": "last_trade",
    "token_id": "82855...",
    "condition_id": "0x4c57...",
    "slug": "us-x-iran-ceasefire-by-april-7-278",
    "outcome": "Yes",
    "timestamp": 1775196806000,
    "side": "BUY",
    "price": "0.46",
    "size": "219.22",
    "fee_rate_bps": "0"
  }
}

​
tick_size_change

Emitted when the market’s tick size changes. 
{
  "type": "event",
  "subscription_id": "sub_xxx",
  "data": {
    "event_type": "tick_size_change",
    "token_id": "82855...",
    "condition_id": "0x4c57...",
    "slug": "us-x-iran-ceasefire",
    "outcome": "Yes",
    "timestamp": 1775196807000,
    "tick_size": "0.001"
  }
}

​
snapshots_done

Marker sent after all initial snapshots have been delivered. count is the number of book_snapshot events that preceded it. 
{
  "type": "event",
  "subscription_id": "sub_xxx",
  "data": {
    "event_type": "snapshots_done",
    "count": 2
  }
}

​
event_batch

Firehose only. Batched every ~250ms with price-level conflation. Each element in the events array has the same shape as the data field in individual events (price_change, last_trade, tick_size_change, etc.). 
{
  "type": "event_batch",
  "subscription_id": "sub_xxx",
  "count": 350,
  "events": [{...}, {...}, ...],
  "gap": false
}
If gap: true, events were missed during a reconnect. Client should rebuild state from the next snapshot.

​
resync

Sent after an internal reconnect. Signals the client to discard local state and rebuild. 
{
  "type": "event",
  "subscription_id": "sub_xxx",
  "data": {
    "event_type": "resync"
  }
}
After resync, fresh book_snapshot events and a snapshots_done follow automatically.

​
Unsubscribe

To stop receiving orderbook events, send an unsubscribe with the subscription ID from the original ack: 
{
  "action": "unsubscribe",
  "subscription_id": "sub_xxx"
}
Updating orderbook subscriptions is not supported. To change filters, unsubscribe and resubscribe. See Subscriptions for full details on subscription management.

​
New Market Timing

Newly created markets are available within a few seconds of creation on Polymarket. Book snapshots may be empty initially. Live deltas will populate as the market becomes active.