Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.codex.io/llms.txt

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

​
outcomeId
String!
The composite outcome ID.
​
protocol
PredictionProtocol!
The protocol that provides this market. See PredictionProtocol
​
venueOutcomeId
String!
The venue-specific outcome / asset / token ID used by the venue’s CLOB.
​
bids
[PredictionOrderBookLevel!]!
Bids ordered such that the last element is the best (highest) bid. Empty when no book is available. See PredictionOrderBookLevel
​
asks
[PredictionOrderBookLevel!]!
Asks ordered such that the last element is the best (lowest) ask. Empty when no book is available. See PredictionOrderBookLevel
​
timestamp
Int!
Venue-reported timestamp for the snapshot, in unix seconds. 0 when no book is available.
​
bookLiquidityUsd
String
Total bid-side notional liquidity in USD across all bid levels in the venue’s CLOB. Null when no book is available.
​
bookLiquidityCT
String
Total bid-side notional liquidity in collateral token units across all bid levels in the venue’s CLOB. Null when no book is available.

​
Used By

Returned by
  • predictionOutcomeOrderBooks: Returns live order books for a set of prediction outcomes, fetched from the venue’s CLOB. Polymarket and Kalshi; outcomes from other venues will return null. Cached for up to 10s.