Guide
Data dictionary
Every response field, grouped by object.
Every object the API returns, generated from the live OpenAPI document. Types are JSON types; | null marks fields that can be null. See Data conventions for units and semantics.
Game
| Field | Type | Description |
|---|---|---|
| game_id | string | — |
| sport | enum | Sport. ncaaf is FBS college football.mlbnflncaafnbanhl |
| season | integer | — |
| season_type | string | null | regular | postseason |
| week | integer | null | NFL/NCAAF week |
| game_date | string | YYYY-MM-DD in America/New_York. |
| start_time | string | ISO-8601 UTC kickoff / first pitch / tip. |
| status | enum | —final |
| home | object | — |
| home.team_id | integer | null | Team id |
| home.abbreviation | string | null | Abbreviation as in /v1/teams |
| home.name | string | null | Team name |
| home.score | integer | null | Final score |
| away | object | — |
| away.team_id | integer | null | Team id |
| away.abbreviation | string | null | Abbreviation as in /v1/teams |
| away.name | string | null | Team name |
| away.score | integer | null | Final score |
| neutral_site | boolean | null | Neutral site |
| overtime | boolean | null | Went to OT / extra innings / shootout |
| venue | object | null | — |
| venue.venue_id | integer | null | Venue id |
| venue.name | string | null | Venue name |
| venue.city | string | null | City |
| venue.indoor | boolean | null | Indoor / dome |
| referee | string | null | Lead official / home-plate umpire name |
| result | object | — |
| result.margin_home | integer | null | home score − away score |
| result.home_covered | boolean | null | Home covered the consensus closing spread (null on push or no line). |
| result.went_over | boolean | null | Final total went over the consensus closing total (null on push or no line). |
| result.favorite | enum | null | Consensus closing favorite.homeaway |
| consensus | object | Market-wide consensus: the modal line across US books and the mean implied-probability price of the books on that line. Same numbers the web builder grades against. Null when no US book posted the market. |
| consensus.moneyline | object | — |
| consensus.moneyline.home_open | integer | null | Home ML open. American odds (e.g. -110). |
| consensus.moneyline.home_close | integer | null | Home ML close. American odds (e.g. -110). |
| consensus.moneyline.away_open | integer | null | Away ML open. American odds (e.g. -110). |
| consensus.moneyline.away_close | integer | null | Away ML close. American odds (e.g. -110). |
| consensus.spread | object | — |
| consensus.spread.open | number | null | Home spread open (negative = home favored). Decimal line (e.g. -3.5, 47.5). |
| consensus.spread.close | number | null | Home spread close. Decimal line (e.g. -3.5, 47.5). |
| consensus.spread.home_juice_open | integer | null | Home spread price at open. American odds (e.g. -110). |
| consensus.spread.home_juice_close | integer | null | Home spread price at close. American odds (e.g. -110). |
| consensus.spread.away_juice_open | integer | null | Away spread price at open. American odds (e.g. -110). |
| consensus.spread.away_juice_close | integer | null | Away spread price at close. American odds (e.g. -110). |
| consensus.total | object | — |
| consensus.total.open | number | null | Total open. Decimal line (e.g. -3.5, 47.5). |
| consensus.total.close | number | null | Total close. Decimal line (e.g. -3.5, 47.5). |
| consensus.total.over_juice_close | integer | null | Over price at close. American odds (e.g. -110). |
| consensus.total.under_juice_close | integer | null | Under price at close. American odds (e.g. -110). |
GameDetail
Everything in Game, plus:
| Field | Type | Description |
|---|---|---|
| period_scores | map<object> | Per-period scores keyed by period (q1…q4, 1h, 2h, p1…p3, inn1, inn5, ot). Only periods we have. |
| period_scores.*.home | integer | null | — |
| period_scores.*.away | integer | null | — |
| weather | object | null | — |
| weather.temp_f | number | null | °F |
| weather.wind_mph | number | null | mph |
| weather.wind_direction | string | null | — |
| weather.condition | string | null | Text condition; Indoor for domes |
| books | BookOdds[] | Per-book full-game odds. US books only. |
| period_odds | PeriodOdds[] | — |
BookOdds
| Field | Type | Description |
|---|---|---|
| book_id | integer | — |
| book | string | Book slug, e.g. draftkings. |
| book_name | string | — |
| moneyline | object | — |
| moneyline.home_open | integer | null | Home ML open. American odds (e.g. -110). |
| moneyline.home_close | integer | null | Home ML close. American odds (e.g. -110). |
| moneyline.away_open | integer | null | Away ML open. American odds (e.g. -110). |
| moneyline.away_close | integer | null | Away ML close. American odds (e.g. -110). |
| spread | object | — |
| spread.open | number | null | Home spread open. Decimal line (e.g. -3.5, 47.5). |
| spread.close | number | null | Home spread close. Decimal line (e.g. -3.5, 47.5). |
| spread.home_juice_open | integer | null | American odds (e.g. -110). |
| spread.home_juice_close | integer | null | American odds (e.g. -110). |
| spread.away_juice_open | integer | null | American odds (e.g. -110). |
| spread.away_juice_close | integer | null | American odds (e.g. -110). |
| total | object | — |
| total.open | number | null | Total open. Decimal line (e.g. -3.5, 47.5). |
| total.close | number | null | Total close. Decimal line (e.g. -3.5, 47.5). |
| total.over_juice_open | integer | null | American odds (e.g. -110). |
| total.over_juice_close | integer | null | American odds (e.g. -110). |
| total.under_juice_open | integer | null | American odds (e.g. -110). |
| total.under_juice_close | integer | null | American odds (e.g. -110). |
| team_total | object | — |
| team_total.home_open | number | null | Decimal line (e.g. -3.5, 47.5). |
| team_total.home_close | number | null | Decimal line (e.g. -3.5, 47.5). |
| team_total.away_open | number | null | Decimal line (e.g. -3.5, 47.5). |
| team_total.away_close | number | null | Decimal line (e.g. -3.5, 47.5). |
PeriodOdds
| Field | Type | Description |
|---|---|---|
| period | string | 1h, 2h, q1–q4, p1, inn1, inn5. |
| book_id | integer | — |
| book | string | — |
| moneyline | object | — |
| moneyline.home_open | integer | null | American odds (e.g. -110). |
| moneyline.home_close | integer | null | American odds (e.g. -110). |
| moneyline.away_open | integer | null | American odds (e.g. -110). |
| moneyline.away_close | integer | null | American odds (e.g. -110). |
| spread | object | — |
| spread.open | number | null | Decimal line (e.g. -3.5, 47.5). |
| spread.close | number | null | Decimal line (e.g. -3.5, 47.5). |
| spread.home_juice_close | integer | null | American odds (e.g. -110). |
| spread.away_juice_close | integer | null | American odds (e.g. -110). |
| total | object | — |
| total.open | number | null | Decimal line (e.g. -3.5, 47.5). |
| total.close | number | null | Decimal line (e.g. -3.5, 47.5). |
| total.over_juice_close | integer | null | American odds (e.g. -110). |
| total.under_juice_close | integer | null | American odds (e.g. -110). |
OddsRow
| Field | Type | Description |
|---|---|---|
| game_id | string | — |
| sport | enum | Sport. ncaaf is FBS college football.mlbnflncaafnbanhl |
| game_date | string | — |
| start_time | string | — |
| home | string | null | Home abbreviation |
| away | string | null | Away abbreviation |
| book_id | integer | — |
| book | string | — |
| book_name | string | — |
| moneyline | object | — |
| moneyline.home_open | integer | null | American odds (e.g. -110). |
| moneyline.home_close | integer | null | American odds (e.g. -110). |
| moneyline.away_open | integer | null | American odds (e.g. -110). |
| moneyline.away_close | integer | null | American odds (e.g. -110). |
| spread | object | — |
| spread.open | number | null | Home spread. Decimal line (e.g. -3.5, 47.5). |
| spread.close | number | null | Home spread. Decimal line (e.g. -3.5, 47.5). |
| spread.home_juice_open | integer | null | American odds (e.g. -110). |
| spread.home_juice_close | integer | null | American odds (e.g. -110). |
| spread.away_juice_open | integer | null | American odds (e.g. -110). |
| spread.away_juice_close | integer | null | American odds (e.g. -110). |
| total | object | — |
| total.open | number | null | Decimal line (e.g. -3.5, 47.5). |
| total.close | number | null | Decimal line (e.g. -3.5, 47.5). |
| total.over_juice_open | integer | null | American odds (e.g. -110). |
| total.over_juice_close | integer | null | American odds (e.g. -110). |
| total.under_juice_open | integer | null | American odds (e.g. -110). |
| total.under_juice_close | integer | null | American odds (e.g. -110). |
| team_total | object | — |
| team_total.home_open | number | null | Decimal line (e.g. -3.5, 47.5). |
| team_total.home_close | number | null | Decimal line (e.g. -3.5, 47.5). |
| team_total.home_over_juice_close | integer | null | American odds (e.g. -110). |
| team_total.home_under_juice_close | integer | null | American odds (e.g. -110). |
| team_total.away_open | number | null | Decimal line (e.g. -3.5, 47.5). |
| team_total.away_close | number | null | Decimal line (e.g. -3.5, 47.5). |
| team_total.away_over_juice_close | integer | null | American odds (e.g. -110). |
| team_total.away_under_juice_close | integer | null | American odds (e.g. -110). |
| result | object | Graded against THIS book's closing number. |
| result.home_covered | boolean | null | — |
| result.spread_push | boolean | null | — |
| result.went_over | boolean | null | — |
| result.total_push | boolean | null | — |
Sport
| Field | Type | Description |
|---|---|---|
| sport | enum | Sport. ncaaf is FBS college football.mlbnflncaafnbanhl |
| name | string | — |
| season_label | string | How season is numbered for this sport. |
| seasons | object[] | — |
| seasons[].season | integer | — |
| seasons[].status | enum | in_progress = season still has unplayed games; rows are added nightly.publishedin_progress |
| seasons[].first_game | string | null | YYYY-MM-DD |
| seasons[].last_game | string | null | YYYY-MM-DD of the most recent completed game |
| seasons[].games | integer | — |
| seasons[].games_with_closing_line | integer | Games where at least one US book posted a closing line. |
| bet_types | string[] | Markets published in /v1/bets for this sport. |
| last_completed_game | string | null | YYYY-MM-DD |
| teams | integer | — |
Team
| Field | Type | Description |
|---|---|---|
| team_id | integer | — |
| abbreviation | string | — |
| name | string | — |
| city | string | null | — |
| school | string | null | College only |
| mascot | string | null | — |
| conference | string | null | — |
| division | string | null | — |
| logo_url | string | null | — |
Season
| Field | Type | Description |
|---|---|---|
| sport | enum | Sport. ncaaf is FBS college football.mlbnflncaafnbanhl |
| season | integer | — |
| status | enum | —publishedin_progress |
| first_game | string | null | YYYY-MM-DD |
| last_game | string | null | YYYY-MM-DD |
| games | integer | — |
| regular_season_games | integer | null | — |
| postseason_games | integer | null | — |
| weeks | integer | null | NFL/NCAAF: highest completed week |
Error
| Field | Type | Description |
|---|---|---|
| error | object | — |
| error.code | enum | —invalid_paramunauthorizedforbiddenrate_limitedquota_exceedednot_foundinternal |
| error.message | string | — |
| error.param | string | — |