Skip to main content
GET
Get market

Path Parameters

outcome_id
string
required

HIP-4 outcome ID of the market, as a decimal string.

Maximum string length: 10
Pattern: ^(0|[1-9][0-9]{0,8}|[1-3][0-9]{9}|4[01][0-9]{8}|42[0-8][0-9]{7}|429[0-3][0-9]{6}|4294[0-8][0-9]{5}|42949[0-5][0-9]{4}|429496[0-6][0-9]{3}|4294967[0-1][0-9]{2}|42949672[0-8][0-9]|429496729[0-5])$

Query Parameters

contract
enum<string>

Browse contract of the detail. 4 adds game, the market's game with up to 256 current members, estimated_live_until and scoreboard, the in-play window end and live game reading of the market's matchup, and series_id for IPO ladder members; 2, 3 or omitted return the earlier detail. Only this query parameter selects it, so a browser read needs no CORS preflight; the X-Totalis-Browse-Contract header is ignored on this route. Repeated, malformed or other values return 400 UNSUPPORTED_BROWSE_CONTRACT.

Available options:
2,
3,
4

Response

The market with its YES and NO sides, product details, current round and 24-hour stats.

catalog_generation
string<positive-int64-decimal>
required

Catalog generation the market, question and metadata were read from.

Maximum string length: 19
Pattern: ^[1-9][0-9]*$
market
object
required

The market with its current references, eligibility and result.

question
object | null
required

Parent question with all of its markets; null for a standalone market.

series_id
string | null
required

Key of the series this standalone market belongs to, the series_id of the series read; set even while it is the only listed member. A binaryPrice or priceTouch market carries it unless it is a round of a recurring template stream, which recurring_round describes instead; a companyIpoFirstDayMarketCap market only when the contract=4 query parameter selects browse contract 4. Null for every other market.

Pattern: ^[0-9a-f]{16}$
metadata
object
required

Display title and rules of the market, its sides and its parent question, read at the same catalog generation as market.

recurring_round
object | null
required

The recurring round the market belongs to, with its recorded neighbours: a native recurring round or a round of a template stream whose cadence recorded history proved. Null for a market outside a recurring series or a round whose recorded definition is withheld.

stats
object | null
required

This market's 24h volume and open interest; null until a current stats snapshot has a row for it.

updated_at
string<date-time>
required

Latest change to the market's catalog record, native result or reference prices, RFC 3339 UTC.

Maximum string length: 30
Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}([.][0-9]{1,9})?Z$
game
object | null

Present only when the contract=4 query parameter selects browse contract 4: the game this standalone market belongs to with up to 256 current members, or null when it has none, is its only current member or has more active members than 256. Absent otherwise.

estimated_live_until
string<date-time> | null

Present only when the contract=4 query parameter selects browse contract 4: end of the in-play window of the market's matchup, as the browse card of its question, else of its game, else of the market as a standalone contest shows it. The window starts at the scheduled start (dates.scheduled_event_at; game.scheduled_start for a game) and lasts its league's reviewed usual game length, unless the live game feed shows the game in play (then at least 15 minutes past the read, extended until it ends) or over (then the moment it was first seen over, or the start if that was earlier). Never a trading cutoff, closure or settlement. Present before the contest starts. Null for anything else: tournaments, series, leagues without a reviewed length, or markets that disagree on the start. Absent otherwise.

Maximum string length: 30
Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}([.][0-9]{1,9})?Z$
scoreboard
object | null

Present only when the contract=4 query parameter selects browse contract 4: the game of the market's matchup (its question's, else its game's, else its own) as the live game feed last read it, for display only. Null when estimated_live_until is null, the feed does not cover or could not match the game, or its last reading of an unfinished game is stale. Absent otherwise.