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 trader.
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.Whether the trader has an open position.
Outcome 0 stats.
See PredictionTraderOutcomeStats
Show Properties
Show Properties
The ID of the prediction outcome.
The shares held.
The avg entry price usd.
The avg entry price ct.
The cost basis usd.
The cost basis ct.
The number of buys.
The number of sells.
Buy volume in USD.
Sell volume in USD.
Buy volume in collateral token units.
Sell volume in collateral token units.
Buy volume in shares.
Sell volume in shares.
The realized pnl usd.
The realized pnl ct.
The pnl status.
See PredictionTraderMarketPnlStatus
The timestamp of the first trade.
The timestamp of the last trade.
Outcome 1 stats.
See PredictionTraderOutcomeStats
Show Properties
Show Properties
The ID of the prediction outcome.
The shares held.
The avg entry price usd.
The avg entry price ct.
The cost basis usd.
The cost basis ct.
The number of buys.
The number of sells.
Buy volume in USD.
Sell volume in USD.
Buy volume in collateral token units.
Sell volume in collateral token units.
Buy volume in shares.
Sell volume in shares.
The realized pnl usd.
The realized pnl ct.
The pnl status.
See PredictionTraderMarketPnlStatus
The timestamp of the first trade.
The timestamp of the last trade.
The creation timestamp.
The last update timestamp.
Used By
Returned by- predictionTraderMarketsStats: Returns per-market performance stats for a specific trader.