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.

role
PredictionMarketRole!
Per-market role within the event (same value as the legacy marketRole). See PredictionMarketRole
sortKey
Int
Position of this market within the event’s display list (lower = show first). Folds in ladder ordering for THRESHOLD_BUCKET / DATE_BUCKET events; equivalent to suggestedOrder ?? displayOrder on the legacy fields.
segment
PredictionMarketSegment!
Sub-event period (set, half, game, etc.) and/or stat (points, rebounds, …). Always present; type = NONE for non-sports markets and whole-match sports markets. The groupingKey field encodes the documented “stat wins over period” precedence so clients don’t have to. See PredictionMarketSegment
entrant
PredictionMarketEntrant
Populated when role = ENTRANT. Identifies the kind of entrant (person, team, country, …) and provides type-specific hints (e.g. ISO 3166-1 alpha-2 country code). See PredictionMarketEntrant
thresholdBucket
PredictionMarketThresholdBucket
Populated when role = THRESHOLD_BUCKET. Carries the parsed numeric rung value, comparison operator, and metric kind (price, temperature, tweets, …). Saves clients from re-parsing the label. See PredictionMarketThresholdBucket
dateBucket
PredictionMarketDateBucket
Populated when role = DATE_BUCKET. Carries the parsed timestamp(s) and operator (BEFORE / AFTER / ON / BETWEEN). See PredictionMarketDateBucket
rawSubtype
String
Original subtype slug emitted by the classifier (e.g. “first_half_spread”, “player_points”). Provided so clients can forward-ship support for new subtypes before this schema gains structured fields for them.

Used By

Returned by
  • eventScopedFilterPredictionMarkets: Filters prediction markets within a single event and returns structured classification metadata for each market. Use this instead of filterPredictionMarkets when you need entrant/segment/ladder details (country codes, period+stat grouping, parsed numeric/date rungs) without re-parsing labels client-side.
  • filterPredictionMarkets: Filters prediction markets using optional text, IDs, event constraints, and ranking criteria.