Skip to main content

Any market. type says which shape it is; each shape has its own page: SpreadMarket, TotalMarket, MoneylineMarket, FutureTeamChampionMarket, PlayerPropMarket. Fields marked with a type are present only on that type.

id
string
required

The market id: the instrument to trade and to follow for price updates.

title
string
required
sub_category
enum<string>
required

A league id.

Available options:
nfl,
ncaaf,
nba,
wnba,
ncaab,
mlb,
nhl,
epl,
mls,
pga,
wc
price_yes
MarketPrice · object
required

One side's price in every display form. numeric_price is the per-share price between 0 and 1; the strings are ready to render.

price_no
MarketPrice · object
required

One side's price in every display form. numeric_price is the per-share price between 0 and 1; the strings are ready to render.

volume
number
required

Dollars traded, rounded to cents.

liquidity
number
required

Dollars resting in the book, rounded to cents.

yes_liquidity
number
required
no_liquidity
number
required
status
enum<string>
required

active is tradeable. expired closed without settling. settled has a result.

Available options:
active,
expired,
settled
updated_at
integer<int64>
required

Epoch milliseconds.

rules
string
required

The market's resolution rules.

market_group_id
string
required
type
enum<string>
required
Available options:
spread,
total,
moneyline,
future_team_champion,
player_prop
event_start
integer<int64>
required

Epoch milliseconds.

yes_line_display
string
required
no_line_display
string
required
orderbook
Orderbook · object

The book Splash holds for the market, at most ten levels a side. Present only on single-group responses.

last_price_yes
number

Last trade as a YES price, 4 decimal places. Absent until the market has traded.

last_price_no
number

The NO complement of last_price_yes. Absent until the market has traded.

result
enum<string>

Present once a market settles.

Available options:
yes,
no,
scalar
event_id
string

All but future_team_champion.

line
number

Spread, total, and a player prop ladder rung (19.5 for "20+"). Absent on a moneyline, a future and a pool leg.

team_id
string

Spread, moneyline (not a draw leg), future and player prop.

yes_team_id
string

Spread, and two_way moneyline.

no_team_id
string

Spread, and two_way moneyline.

moneyline_type
enum<string>

Moneyline only.

Available options:
two_way,
one_way,
draw
prop_type
enum<string>

Player prop only.

Available options:
touchdowns,
receiving_yards,
receptions,
rushing_yards,
passing_yards,
first_touchdown,
team_first_touchdown,
passing_touchdowns,
fantasy_points_ppr,
passing_completions,
passing_attempts,
rushing_attempts,
scrimmage_yards,
longest_reception,
interceptions_thrown,
most_passing_yards,
points,
rebounds,
assists,
points_rebounds_assists,
three_points_made,
steals,
blocks,
double_double,
goals,
goals_plus_assists,
first_goal,
hits,
total_bases,
hits_runs_rbis,
home_runs,
rbis,
stolen_bases,
strikeouts,
outs,
earned_runs_allowed,
hits_allowed,
walks_allowed
prop_type_display
string

Player prop only. Heading for prop_type, e.g. Anytime TD.

entity_id
string

Player prop only. Resolve through included.entities.

live_stat_key
string

Player prop only. Present when a live in-game stat streams for this prop type; its value is the key to read from the player-activity-{event_id}-{entity_id} channel payload.

live_stat
number

Player prop only. The current value of live_stat_key. Present exactly when live_stat_key is.

alternate_lines
PlayerPropLine · object[]

Player prop only. The whole ladder, this market included. Absent when there is a single line.