> ## Documentation Index
> Fetch the complete documentation index at: https://docs.splashsports.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Enumerations

> Every fixed set of values the Predictions API accepts in a query parameter or returns in a field.

Where a query parameter accepts several values, pass them as one comma-separated string:
`?sub_category=nfl,nba`. A value outside the list is a `400`.

## Leagues (`sub_category`)

Accepted by `sub_category` on the listing endpoints, and returned as `sub_category` on groups and
markets and as `league` on games, teams and players.

| Value | League | Filterable in `?sub_category=` |
| - | - | - |
| `nfl` | NFL | Yes |
| `ncaaf` | College football | Yes |
| `nba` | NBA | Yes |
| `wnba` | WNBA | Yes |
| `ncaab` | College basketball | Yes |
| `mlb` | MLB | Yes |
| `nhl` | NHL | Yes |
| `epl` | Premier League | Yes |
| `mls` | MLS | Yes |
| `pga` | PGA Tour | No, response only |
| `wc` | World Cup | No, response only |

Which leagues are offered right now comes from [`GET /sub_categories`](https://docs.splashsports.com/predictions/reference/sub-categories/list-sub-categories).

## Market group types (`type`)

Accepted by `type` on `GET /prediction_markets` and `GET /prediction_markets/promoted`, and by
`type` on `GET /events/{event_id}/details` (`gameline` and `player_prop` only). Returned as `type` on
every market group.

| Value | One group is… | Markets inside |
| - | - | - |
| `gameline` | one game | its spread, total and moneyline markets |
| `future_team_champion` | one futures title (a championship) | one market per team |
| `player_prop` | one player in one game | one lead market per prop type, each with its ladder |

When `type` is omitted on a listing, only `gameline` and `future_team_champion` are returned. Take
the values from a sub-category's `filters[].types` rather than hardcoding them.

## Market statuses (`status`)

Accepted by `status` on every market-returning endpoint. Returned as `status` on every market.

| Value | Meaning |
| - | - |
| `active` | Tradeable now |
| `settled` | Resolved; the market carries a `result` |
| `expired` | Closed without settling |

Omitted, `status` means `active` only, except on `GET /prediction_markets/{id}` where it means all
statuses so a finished game's page still renders.

## Market results (`result`)

Present on a market once it settles.

| Value | Meaning |
| - | - |
| `yes` | YES resolved true |
| `no` | NO resolved true |
| `scalar` | Resolved to a value rather than a side |

## Market types (`type` on a market)

Each market's `type` selects its shape.

| Value | Shape |
| - | - |
| `spread` | `SpreadMarket`: a line and both team ids |
| `total` | `TotalMarket`: an over/under line, no team |
| `moneyline` | `MoneylineMarket`: see moneyline types below |
| `future_team_champion` | `FutureTeamChampionMarket`: one team |
| `player_prop` | `PlayerPropMarket`: one player, one prop type, a ladder |

### Moneyline types (`moneyline_type`)

| Value | Meaning |
| - | - |
| `two_way` | One market with both teams: YES is `yes_team_id`, NO is `no_team_id` |
| `one_way` | One leg of a three-way match (soccer), for `team_id` only |
| `draw` | The draw leg of a three-way match; carries no team |

## Player prop types (`prop_type`)

Accepted by `prop_type` on `GET /prediction_markets` and `GET /events/{event_id}/details`. Returned
as `prop_type` on every player prop market and section, with the display title in
`prop_type_display`. The values are per league; a game's tabs
([`GET /prediction_markets/{id}`](https://docs.splashsports.com/predictions/reference/markets/get-a-market-group)) say which it
carries.

A **ladder** has several lines (`alternate_lines`); a **pool** is one Yes/No leg per player with no
line.

### Football (`nfl`, `ncaaf`)

| Value | Display title | Kind |
| - | - | - |
| `touchdowns` | Anytime TD | Ladder |
| `first_touchdown` | Player to score first TD | Pool |
| `team_first_touchdown` | First touchdown for `<team>` | Pool, one section per team |
| `passing_yards` | Passing Yards | Ladder |
| `passing_touchdowns` | Passing Touchdowns | Ladder |
| `passing_completions` | Passing Completions | Ladder |
| `passing_attempts` | Passing Attempts | Ladder |
| `interceptions_thrown` | Interceptions thrown | Ladder |
| `most_passing_yards` | Most Passing Yards | Pool |
| `receiving_yards` | Receiving Yards | Ladder |
| `receptions` | Receptions | Ladder |
| `longest_reception` | Longest Reception | Ladder |
| `rushing_yards` | Rushing Yards | Ladder |
| `rushing_attempts` | Rushing Attempts | Ladder |
| `scrimmage_yards` | Rush + Rec Yards | Ladder |
| `fantasy_points_ppr` | Fantasy points PPR | Ladder |

### Basketball (`nba`, `wnba`)

| Value | Display title | Kind |
| - | - | - |
| `points` | Points | Ladder |
| `rebounds` | Rebounds | Ladder |
| `assists` | Assists | Ladder |
| `points_rebounds_assists` | Pts + Reb + Asts | Ladder |
| `three_points_made` | 3-PT Made | Ladder |
| `steals` | Steals | Ladder |
| `blocks` | Blocks | Ladder |
| `double_double` | Double Double | Ladder |

### Hockey (`nhl`)

| Value | Display title | Kind |
| - | - | - |
| `goals` | Goals | Ladder |
| `assists` | Assists | Ladder |
| `points` | Points | Ladder |

### Baseball (`mlb`)

| Value | Display title | Kind |
| - | - | - |
| `hits` | Hits | Ladder |
| `total_bases` | Total Bases | Ladder |
| `hits_runs_rbis` | Hits + Runs + RBIs | Ladder |
| `home_runs` | Home Runs | Ladder |
| `rbis` | RBIs | Ladder |
| `stolen_bases` | Stolen Bases | Ladder |
| `strikeouts` | Pitcher Ks | Ladder |
| `outs` | Outs | Ladder |
| `earned_runs_allowed` | Earned Runs | Ladder |
| `hits_allowed` | Allowed Hits | Ladder |
| `walks_allowed` | Pitcher Walks | Ladder |

### Soccer (`epl`, `mls`)

| Value | Display title | Kind |
| - | - | - |
| `goals` | Goals | Ladder |
| `assists` | Assists | Ladder |
| `goals_plus_assists` | Goals + Assists | Ladder |
| `first_goal` | Player to score first goal | Pool |

## Grouping (`group_by`)

Accepted by `group_by` on `GET /events/{event_id}/details`. Each belongs to one `type`.

| Value | With `type=` | Returns |
| - | - | - |
| `prop_type` | `player_prop` | One section per prop type |
| `market_type` | `gameline` | One section per market type: Win by, Totals, Winner |

### Game line section types (`market_type`)

Returned on each section of a `group_by=market_type` response, in this order.

| Value | Section title |
| - | - |
| `spread` | Win by |
| `total` | Totals |
| `moneyline` | Winner |

## Game status (`status` on a game)

| Value | Meaning |
| - | - |
| `SCHEDULED` | Not started |
| `IN_PROGRESS` | Live |
| `FINISHED` | Over, result not yet final |
| `FINALIZED` | Over, result final |
| `CANCELED` | Will not be played |

## Soccer match status (`state.match_status`)

`not_started`, `1st_half`, `halftime`, `2nd_half`, `1st_extra`, `extra_time_halftime`, `2nd_extra`,
`penalties`, `interrupted`, `ended`.

## Game phase (`state.phase`)

Football, basketball and hockey: `pregame`, `regulation`, `overtime`. Hockey also `shootout`.

## Error codes (`error`)

| Value | HTTP status |
| - | - |
| `BAD_REQUEST` | 400 |
| `NOT_FOUND` | 404 |
| `INTERNAL_ERROR` | 500 |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.