Skip to content

Market list

GET
/api/markets/markets/list
curl --request GET \
--url https://example.com/api/markets/markets/list

The newest markets and the name of every series, as the stream’s snapshot holds them. version grows with every change to the list. The answer is gzip when the client accepts it, carries an ETag of the version, and may be cached for 2 seconds. A matching If-None-Match answers 304. 503 with Retry-After while the list is loading.

if-none-match
Any of:
string

The ETag of a list you hold.

accept-encoding
Any of:
string

Send gzip to get the list compressed.

Successful Response

Media typeapplication/json
MarketListSnapshot
object
version
required
Version

Grows with every change to the list. Pass it as after to /markets/stream to hear only what changed since.

integer
series
required
Series

Every series, including one with no windows listed.

Array<string>
markets
required
Markets

The newest markets, newest window first.

Array<object>
Market
object
market_id
required
Market Id
integer
slug
required
Slug
string
title
required
Title
string
asset
required
Asset
string
category
required
Category
string
duration
required
Duration

Window length, e.g. ‘5m’.

string
series
required
Series

The line of windows this one belongs to, e.g. ‘btc-updown-5m’: the slug without its time.

string
open_ms
required
Open Ms

Window start, epoch ms.

integer
event_ms
required
Event Ms
integer
expiry_ms
required
Expiry Ms

Window end, epoch ms.

integer
status
required
Status

‘open’, then ‘live’ once the window has started and has a strike. ‘halted’ instead of either while trading is halted: orders and changes are refused and cancels taken. ‘closed’ when trading ends: at expiry, or earlier if an operator closes it. ‘settled’ once its outcome is recorded.

string
strike
required
Any of:
number
settlement
required
Any of:
number
winning_outcome
required
Any of:
string
Allowed values: up down void
venue
required
Any of:
string
symbol
required
Any of:
string
candle
required
Any of:
string
taker_fee_rate_bps
required
Taker Fee Rate Bps

The taker’s rate on the fee curve, in basis points. Fixed when the market is listed.

integer
maker_fee_rate_bps
required
Maker Fee Rate Bps

The maker’s rate on the fee curve, in basis points. Fixed when the market is listed.

integer
maker_rebate_share_bps
required
Maker Rebate Share Bps

The part of each fill’s taker fee that the maker gets back, in basis points of that fee. Fixed when the market is listed.

integer
Example
{
"markets": [
{
"winning_outcome": "up"
}
]
}

If-None-Match is the current version.

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}