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.
The ID of the prediction market.
The prediction market.
See PredictionMarket The venue-specific market ID.
The venue-specific market slug.
The ID of the prediction event.
The venue-specific event ID.
A clean, UI-ready label derived from label/question with the parent event name stripped (and Kalshi Yes:/No: prefixes unwrapped). Falls back to question when label is missing or unknown.
Venue-specific outcome IDs.
URL of the thumbnail image.
The last update timestamp.
The timestamp when this entity opens.
The timestamp when this entity closes.
The expected resolution timestamp.
The actual resolution timestamp.
The last observation timestamp.
The exchange contract address.
The ID of the winning outcome.
enrichedMetadata
PredictionMarketEnrichedMetadata
Per-domain structured enrichment (sports market type/teams/start times today). Null when no domain-specific signal extracted.
See PredictionMarketEnrichedMetadata Discriminator naming which sub-block carries data.
See PredictionMetadataType Sports games (league, teams, start times).
sports
SportsMarketEnrichedMetadata
Populated when metadataType = SPORTS.
See SportsMarketEnrichedMetadata Market template slug (e.g. “moneyline”, “spreads”, “totals”, “ufc_method_of_victory”). Free string — list grows as venues add templates.
Soft-normalised league identifier (mirrors the parent event).
Teams referenced by this market, when known.
See SportsTeam Lowercased venue-canonical abbreviation.
Known alternate forms for the same team (rebrands, relocations, 2-vs-3-letter conventions). Excludes abbreviation.
Soft-normalised league for this team.
Provider-side identifier (e.g. Polymarket gamma id).
Whether this team is the home team in the event.
Game-start date in UTC (“YYYY-MM-DD”). Derived from gameStartTime when present.
Game-start clock value as canonical UTC ISO-8601.
Game-start as Unix seconds (UTC).
Timezone discriminator for gameStartTime / gameStartDate. Always UTC for any record produced after the ET→UTC normalisation rollout.
See SportsTimezone UTC. gameStartTime is canonical ISO-8601; gameStartTimeSeconds populated.
The prediction event.
See PredictionEvent The venue-specific event ID.
The venue-specific series ID.
Tags associated with this entity.
The timestamp when this entity opens.
The timestamp when this entity closes.
The expected resolution timestamp.
The actual resolution timestamp.
URL of the thumbnail image.
The last update timestamp.
enrichedMetadata
PredictionEventEnrichedMetadata
Per-domain structured enrichment (sports league/teams/start times today; new domains added over time). Null when no domain-specific signal extracted.
See PredictionEventEnrichedMetadata Discriminator naming which sub-block carries data.
See PredictionMetadataType Sports games (league, teams, start times).
sports
SportsEventEnrichedMetadata
Populated when metadataType = SPORTS.
See SportsEventEnrichedMetadata Soft-normalised league/sport identifier (e.g. NBA, NFL, EPL). Free string to tolerate new venues; well-known values match the canonical set.
Teams participating in the game, when known. Null when the venue does not expose teams.
See SportsTeam Lowercased venue-canonical abbreviation.
Known alternate forms for the same team (rebrands, relocations, 2-vs-3-letter conventions). Excludes abbreviation.
Soft-normalised league for this team.
Provider-side identifier (e.g. Polymarket gamma id).
Whether this team is the home team in the event.
Game-start date in UTC (“YYYY-MM-DD”). Derived from gameStartTime when present.
Game-start clock value as canonical UTC ISO-8601.
Game-start as Unix seconds (UTC).
Timezone discriminator for gameStartTime / gameStartDate. Always UTC for any record produced after the ET→UTC normalisation rollout.
See SportsTimezone UTC. gameStartTime is canonical ISO-8601; gameStartTimeSeconds populated.
Decomposed venue ticker (parsed components from the venue’s native event identifier). Useful for cross-venue matching when canonical league/teams fields don’t disambiguate.
See DecomposedVenueTicker kalshiSports
KalshiSportsTickerComponents
Populated for Kalshi events whose ticker matches the sports template.
See KalshiSportsTickerComponents Series prefix (e.g. “KXMLBGAME”).
Soft-normalised series sport.
Raw uppercase team-tail captured from the ticker (e.g. “1WINTUNDRA”). Present when the parser matched the structural shape.
Populated only when the parser can confidently split the team tail.
Populated only when the parser can confidently split the team tail.
The timestamp of the last transaction.
lifecycle
PredictionLifecycleStats!
Lifecycle metadata.
See PredictionLifecycleStats The expected lifespan seconds.
The time to resolution seconds.
The ID of the winning outcome.
statsMin5
EnhancedWindowedPredictionMarketStats
Stats for the 5-minute window.
See EnhancedWindowedPredictionMarketStats Timestamp of last transaction in window.
core
WindowedPredictionMarketCoreStats!
uniqueTraders
WindowedPredictionMarketUniqueTraderStats
liquidity
WindowedPredictionMarketLiquidityStats
openInterest
WindowedPredictionMarketOpenInterestStats
statsChange
WindowedPredictionMarketChangeStats!
Change stats for this window.
See WindowedPredictionMarketChangeStats Volume change percentage.
Trades change percentage.
Unique traders change percentage (optional).
Liquidity change percentage (optional).
Open interest change percentage (optional).
scores
PredictionMarketWindowScores!
outcome0Stats
EnhancedWindowedPredictionOutcomeStats!
Outcome 0 stats.
See EnhancedWindowedPredictionOutcomeStats core
WindowedPredictionOutcomeCoreStats!
buySell
WindowedPredictionOutcomeBuySellStats
liquidity
WindowedPredictionOutcomeLiquidityStats
orderbook
WindowedPredictionOutcomeOrderbookStats
depth
WindowedPredictionOutcomeDepthStats
statsChange
WindowedPredictionOutcomeChangeStats!
Change stats for this window.
See WindowedPredictionOutcomeChangeStats Volume change percentage.
Volume shares change percentage.
Trades change percentage.
Price range over the window (volatility proxy).
Buys change percentage (optional).
Sells change percentage (optional).
Liquidity change percentage (optional).
outcome1Stats
EnhancedWindowedPredictionOutcomeStats!
Outcome 1 stats.
See EnhancedWindowedPredictionOutcomeStats core
WindowedPredictionOutcomeCoreStats!
buySell
WindowedPredictionOutcomeBuySellStats
liquidity
WindowedPredictionOutcomeLiquidityStats
orderbook
WindowedPredictionOutcomeOrderbookStats
depth
WindowedPredictionOutcomeDepthStats
statsChange
WindowedPredictionOutcomeChangeStats!
Change stats for this window.
See WindowedPredictionOutcomeChangeStats Volume change percentage.
Volume shares change percentage.
Trades change percentage.
Price range over the window (volatility proxy).
Buys change percentage (optional).
Sells change percentage (optional).
Liquidity change percentage (optional).
allTimeStats
WindowedPredictionAllTimeStats!
statsHour1
EnhancedWindowedPredictionMarketStats
Stats for the 1-hour window.
See EnhancedWindowedPredictionMarketStats Timestamp of last transaction in window.
core
WindowedPredictionMarketCoreStats!
uniqueTraders
WindowedPredictionMarketUniqueTraderStats
liquidity
WindowedPredictionMarketLiquidityStats
openInterest
WindowedPredictionMarketOpenInterestStats
statsChange
WindowedPredictionMarketChangeStats!
Change stats for this window.
See WindowedPredictionMarketChangeStats Volume change percentage.
Trades change percentage.
Unique traders change percentage (optional).
Liquidity change percentage (optional).
Open interest change percentage (optional).
scores
PredictionMarketWindowScores!
outcome0Stats
EnhancedWindowedPredictionOutcomeStats!
Outcome 0 stats.
See EnhancedWindowedPredictionOutcomeStats core
WindowedPredictionOutcomeCoreStats!
buySell
WindowedPredictionOutcomeBuySellStats
liquidity
WindowedPredictionOutcomeLiquidityStats
orderbook
WindowedPredictionOutcomeOrderbookStats
depth
WindowedPredictionOutcomeDepthStats
statsChange
WindowedPredictionOutcomeChangeStats!
Change stats for this window.
See WindowedPredictionOutcomeChangeStats Volume change percentage.
Volume shares change percentage.
Trades change percentage.
Price range over the window (volatility proxy).
Buys change percentage (optional).
Sells change percentage (optional).
Liquidity change percentage (optional).
outcome1Stats
EnhancedWindowedPredictionOutcomeStats!
Outcome 1 stats.
See EnhancedWindowedPredictionOutcomeStats core
WindowedPredictionOutcomeCoreStats!
buySell
WindowedPredictionOutcomeBuySellStats
liquidity
WindowedPredictionOutcomeLiquidityStats
orderbook
WindowedPredictionOutcomeOrderbookStats
depth
WindowedPredictionOutcomeDepthStats
statsChange
WindowedPredictionOutcomeChangeStats!
Change stats for this window.
See WindowedPredictionOutcomeChangeStats Volume change percentage.
Volume shares change percentage.
Trades change percentage.
Price range over the window (volatility proxy).
Buys change percentage (optional).
Sells change percentage (optional).
Liquidity change percentage (optional).
allTimeStats
WindowedPredictionAllTimeStats!
statsHour4
EnhancedWindowedPredictionMarketStats
Stats for the 4-hour window.
See EnhancedWindowedPredictionMarketStats Timestamp of last transaction in window.
core
WindowedPredictionMarketCoreStats!
uniqueTraders
WindowedPredictionMarketUniqueTraderStats
liquidity
WindowedPredictionMarketLiquidityStats
openInterest
WindowedPredictionMarketOpenInterestStats
statsChange
WindowedPredictionMarketChangeStats!
Change stats for this window.
See WindowedPredictionMarketChangeStats Volume change percentage.
Trades change percentage.
Unique traders change percentage (optional).
Liquidity change percentage (optional).
Open interest change percentage (optional).
scores
PredictionMarketWindowScores!
outcome0Stats
EnhancedWindowedPredictionOutcomeStats!
Outcome 0 stats.
See EnhancedWindowedPredictionOutcomeStats core
WindowedPredictionOutcomeCoreStats!
buySell
WindowedPredictionOutcomeBuySellStats
liquidity
WindowedPredictionOutcomeLiquidityStats
orderbook
WindowedPredictionOutcomeOrderbookStats
depth
WindowedPredictionOutcomeDepthStats
statsChange
WindowedPredictionOutcomeChangeStats!
Change stats for this window.
See WindowedPredictionOutcomeChangeStats Volume change percentage.
Volume shares change percentage.
Trades change percentage.
Price range over the window (volatility proxy).
Buys change percentage (optional).
Sells change percentage (optional).
Liquidity change percentage (optional).
outcome1Stats
EnhancedWindowedPredictionOutcomeStats!
Outcome 1 stats.
See EnhancedWindowedPredictionOutcomeStats core
WindowedPredictionOutcomeCoreStats!
buySell
WindowedPredictionOutcomeBuySellStats
liquidity
WindowedPredictionOutcomeLiquidityStats
orderbook
WindowedPredictionOutcomeOrderbookStats
depth
WindowedPredictionOutcomeDepthStats
statsChange
WindowedPredictionOutcomeChangeStats!
Change stats for this window.
See WindowedPredictionOutcomeChangeStats Volume change percentage.
Volume shares change percentage.
Trades change percentage.
Price range over the window (volatility proxy).
Buys change percentage (optional).
Sells change percentage (optional).
Liquidity change percentage (optional).
allTimeStats
WindowedPredictionAllTimeStats!
statsHour12
EnhancedWindowedPredictionMarketStats
Stats for the 12-hour window.
See EnhancedWindowedPredictionMarketStats Timestamp of last transaction in window.
core
WindowedPredictionMarketCoreStats!
uniqueTraders
WindowedPredictionMarketUniqueTraderStats
liquidity
WindowedPredictionMarketLiquidityStats
openInterest
WindowedPredictionMarketOpenInterestStats
statsChange
WindowedPredictionMarketChangeStats!
Change stats for this window.
See WindowedPredictionMarketChangeStats Volume change percentage.
Trades change percentage.
Unique traders change percentage (optional).
Liquidity change percentage (optional).
Open interest change percentage (optional).
scores
PredictionMarketWindowScores!
outcome0Stats
EnhancedWindowedPredictionOutcomeStats!
Outcome 0 stats.
See EnhancedWindowedPredictionOutcomeStats core
WindowedPredictionOutcomeCoreStats!
buySell
WindowedPredictionOutcomeBuySellStats
liquidity
WindowedPredictionOutcomeLiquidityStats
orderbook
WindowedPredictionOutcomeOrderbookStats
depth
WindowedPredictionOutcomeDepthStats
statsChange
WindowedPredictionOutcomeChangeStats!
Change stats for this window.
See WindowedPredictionOutcomeChangeStats Volume change percentage.
Volume shares change percentage.
Trades change percentage.
Price range over the window (volatility proxy).
Buys change percentage (optional).
Sells change percentage (optional).
Liquidity change percentage (optional).
outcome1Stats
EnhancedWindowedPredictionOutcomeStats!
Outcome 1 stats.
See EnhancedWindowedPredictionOutcomeStats core
WindowedPredictionOutcomeCoreStats!
buySell
WindowedPredictionOutcomeBuySellStats
liquidity
WindowedPredictionOutcomeLiquidityStats
orderbook
WindowedPredictionOutcomeOrderbookStats
depth
WindowedPredictionOutcomeDepthStats
statsChange
WindowedPredictionOutcomeChangeStats!
Change stats for this window.
See WindowedPredictionOutcomeChangeStats Volume change percentage.
Volume shares change percentage.
Trades change percentage.
Price range over the window (volatility proxy).
Buys change percentage (optional).
Sells change percentage (optional).
Liquidity change percentage (optional).
allTimeStats
WindowedPredictionAllTimeStats!
statsDay1
EnhancedWindowedPredictionMarketStats
Stats for the 1-day window.
See EnhancedWindowedPredictionMarketStats Timestamp of last transaction in window.
core
WindowedPredictionMarketCoreStats!
uniqueTraders
WindowedPredictionMarketUniqueTraderStats
liquidity
WindowedPredictionMarketLiquidityStats
openInterest
WindowedPredictionMarketOpenInterestStats
statsChange
WindowedPredictionMarketChangeStats!
Change stats for this window.
See WindowedPredictionMarketChangeStats Volume change percentage.
Trades change percentage.
Unique traders change percentage (optional).
Liquidity change percentage (optional).
Open interest change percentage (optional).
scores
PredictionMarketWindowScores!
outcome0Stats
EnhancedWindowedPredictionOutcomeStats!
Outcome 0 stats.
See EnhancedWindowedPredictionOutcomeStats core
WindowedPredictionOutcomeCoreStats!
buySell
WindowedPredictionOutcomeBuySellStats
liquidity
WindowedPredictionOutcomeLiquidityStats
orderbook
WindowedPredictionOutcomeOrderbookStats
depth
WindowedPredictionOutcomeDepthStats
statsChange
WindowedPredictionOutcomeChangeStats!
Change stats for this window.
See WindowedPredictionOutcomeChangeStats Volume change percentage.
Volume shares change percentage.
Trades change percentage.
Price range over the window (volatility proxy).
Buys change percentage (optional).
Sells change percentage (optional).
Liquidity change percentage (optional).
outcome1Stats
EnhancedWindowedPredictionOutcomeStats!
Outcome 1 stats.
See EnhancedWindowedPredictionOutcomeStats core
WindowedPredictionOutcomeCoreStats!
buySell
WindowedPredictionOutcomeBuySellStats
liquidity
WindowedPredictionOutcomeLiquidityStats
orderbook
WindowedPredictionOutcomeOrderbookStats
depth
WindowedPredictionOutcomeDepthStats
statsChange
WindowedPredictionOutcomeChangeStats!
Change stats for this window.
See WindowedPredictionOutcomeChangeStats Volume change percentage.
Volume shares change percentage.
Trades change percentage.
Price range over the window (volatility proxy).
Buys change percentage (optional).
Sells change percentage (optional).
Liquidity change percentage (optional).
allTimeStats
WindowedPredictionAllTimeStats!
statsWeek1
EnhancedWindowedPredictionMarketStats
Stats for the 1-week window.
See EnhancedWindowedPredictionMarketStats Timestamp of last transaction in window.
core
WindowedPredictionMarketCoreStats!
uniqueTraders
WindowedPredictionMarketUniqueTraderStats
liquidity
WindowedPredictionMarketLiquidityStats
openInterest
WindowedPredictionMarketOpenInterestStats
statsChange
WindowedPredictionMarketChangeStats!
Change stats for this window.
See WindowedPredictionMarketChangeStats Volume change percentage.
Trades change percentage.
Unique traders change percentage (optional).
Liquidity change percentage (optional).
Open interest change percentage (optional).
scores
PredictionMarketWindowScores!
outcome0Stats
EnhancedWindowedPredictionOutcomeStats!
Outcome 0 stats.
See EnhancedWindowedPredictionOutcomeStats core
WindowedPredictionOutcomeCoreStats!
buySell
WindowedPredictionOutcomeBuySellStats
liquidity
WindowedPredictionOutcomeLiquidityStats
orderbook
WindowedPredictionOutcomeOrderbookStats
depth
WindowedPredictionOutcomeDepthStats
statsChange
WindowedPredictionOutcomeChangeStats!
Change stats for this window.
See WindowedPredictionOutcomeChangeStats Volume change percentage.
Volume shares change percentage.
Trades change percentage.
Price range over the window (volatility proxy).
Buys change percentage (optional).
Sells change percentage (optional).
Liquidity change percentage (optional).
outcome1Stats
EnhancedWindowedPredictionOutcomeStats!
Outcome 1 stats.
See EnhancedWindowedPredictionOutcomeStats core
WindowedPredictionOutcomeCoreStats!
buySell
WindowedPredictionOutcomeBuySellStats
liquidity
WindowedPredictionOutcomeLiquidityStats
orderbook
WindowedPredictionOutcomeOrderbookStats
depth
WindowedPredictionOutcomeDepthStats
statsChange
WindowedPredictionOutcomeChangeStats!
Change stats for this window.
See WindowedPredictionOutcomeChangeStats Volume change percentage.
Volume shares change percentage.
Trades change percentage.
Price range over the window (volatility proxy).
Buys change percentage (optional).
Sells change percentage (optional).
Liquidity change percentage (optional).
allTimeStats
WindowedPredictionAllTimeStats!
trendingScores
DetailedPredictionStatsScores!
relevanceScores
DetailedPredictionStatsScores!
competitiveScores
DetailedPredictionStatsScores!
allTimeStats
PredictionMarketAllTimeStats!
Used By Returned by