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
Show Properties
Show Properties
The unique identifier.
The prediction protocol.
See PredictionProtocol
The venue-specific market ID.
The venue-specific market slug.
The ID of the prediction event.
The venue-specific event ID.
The question or title.
The display label.
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.The parent event label.
Primary rules text.
Secondary rules text.
Venue-specific outcome IDs.
Internal outcome IDs.
Labels for each outcome.
The resolution details.
See PredictionResolution
URL of the large image.
URL of the thumbnail image.
URL of the small image.
The creation timestamp.
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 network ID.
The exchange contract address.
Categories associated with this entity.
See PredictionCategory
Show Properties
Show Properties
The ID of the winning outcome.
Per-domain structured enrichment (sports market type/teams/start times today). Null when no domain-specific signal extracted.
See PredictionMarketEnrichedMetadata
Show Properties
Show Properties
Discriminator naming which sub-block carries data.
See PredictionMetadataType
Show Properties
Show Properties
Sports games (league, teams, start times).
Populated when
metadataType = SPORTS.
See SportsMarketEnrichedMetadataShow Properties
Show Properties
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
Show Properties
Show Properties
Lowercased venue-canonical abbreviation.
Known alternate forms for the same team (rebrands, relocations, 2-vs-3-letter conventions). Excludes
abbreviation.Display name.
Soft-normalised league for this team.
Logo URL.
Display alias.
Brand colour.
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 SportsTimezoneShow Properties
Show Properties
UTC.
gameStartTime is canonical ISO-8601; gameStartTimeSeconds populated.The prediction event.
See PredictionEvent
Show Properties
Show Properties
The unique identifier.
The prediction protocol.
See PredictionProtocol
The venue-specific event ID.
The venue-specific series ID.
The question or title.
The external URL.
Primary rules text.
Secondary rules text.
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.
The resolution details.
See PredictionResolution
URL of the large image.
URL of the thumbnail image.
URL of the small image.
The creation timestamp.
The last update timestamp.
The network ID.
Associated market IDs.
Categories associated with this entity.
See PredictionCategory
Show Properties
Show Properties
Per-domain structured enrichment (sports league/teams/start times today; new domains added over time). Null when no domain-specific signal extracted.
See PredictionEventEnrichedMetadata
Show Properties
Show Properties
Discriminator naming which sub-block carries data.
See PredictionMetadataType
Show Properties
Show Properties
Sports games (league, teams, start times).
Populated when
metadataType = SPORTS.
See SportsEventEnrichedMetadataShow Properties
Show Properties
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
Show Properties
Show Properties
Lowercased venue-canonical abbreviation.
Known alternate forms for the same team (rebrands, relocations, 2-vs-3-letter conventions). Excludes
abbreviation.Display name.
Soft-normalised league for this team.
Logo URL.
Display alias.
Brand colour.
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 SportsTimezoneShow Properties
Show Properties
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
Show Properties
Show Properties
Populated for Kalshi events whose ticker matches the sports template.
See KalshiSportsTickerComponents
Show Properties
Show Properties
Original ticker string.
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 bar data.
See PredictionMarketBar
Show Properties
Show Properties
The unix timestamp for this bar.
Volume in USD.
Volume in collateral token units.
Volume in shares.
The number of unique traders.
The last event timestamp.
The number of trades.
The all time volume usd (from on-chain trades).
The all time venue volume usd (reported by venue).
The all time volume collateral token (from on-chain trades).
The all time venue volume collateral token (reported by venue).
Open interest in USD.
See PredictionMarketBarOhlc
Outcome 0 data.
See PredictionOutcomeBar
Show Properties
Show Properties
The venue-specific outcome ID.
The number of trades.
The number of buys.
The number of sells.
Volume in shares.
Buy volume in shares.
Sell volume in shares.
Volume in USD.
Buy volume in USD.
Sell volume in USD.
Volume in collateral token units.
Buy volume in collateral token units.
Sell volume in collateral token units.
The price usd.
See PredictionMarketBarOhlc
The price collateral token.
See PredictionMarketBarOhlc
Liquidity in USD.
See PredictionMarketBarOhlc
The liquidity collateral token.
See PredictionMarketBarOhlc
The bid usd.
See PredictionMarketBarOhlc
The bid collateral token.
See PredictionMarketBarOhlc
The ask usd.
See PredictionMarketBarOhlc
The ask collateral token.
See PredictionMarketBarOhlc
The two percent bid depth usd.
See PredictionMarketBarOhlc
The two percent bid depth collateral token.
See PredictionMarketBarOhlc
The two percent ask depth usd.
See PredictionMarketBarOhlc
Outcome 1 data.
See PredictionOutcomeBar
Show Properties
Show Properties
The venue-specific outcome ID.
The number of trades.
The number of buys.
The number of sells.
Volume in shares.
Buy volume in shares.
Sell volume in shares.
Volume in USD.
Buy volume in USD.
Sell volume in USD.
Volume in collateral token units.
Buy volume in collateral token units.
Sell volume in collateral token units.
The price usd.
See PredictionMarketBarOhlc
The price collateral token.
See PredictionMarketBarOhlc
Liquidity in USD.
See PredictionMarketBarOhlc
The liquidity collateral token.
See PredictionMarketBarOhlc
The bid usd.
See PredictionMarketBarOhlc
The bid collateral token.
See PredictionMarketBarOhlc
The ask usd.
See PredictionMarketBarOhlc
The ask collateral token.
See PredictionMarketBarOhlc
The two percent bid depth usd.
See PredictionMarketBarOhlc
The two percent bid depth collateral token.
See PredictionMarketBarOhlc
The two percent ask depth usd.
See PredictionMarketBarOhlc
Used By
Returned by- predictionEventTopMarketsBars: Returns bar data for top markets inside a prediction event.
- predictionMarketBars: Returns OHLC-style bar data for a prediction market.