Skip to content

Get a market

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

Pass exactly one of slug or id.

slug
Any of:
string

The market’s slug.

id
Any of:
integer
>= -9223372036854776000 <= 9223372036854776000

The market’s id.

Successful Response

Media typeapplication/json
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
{
"winning_outcome": "up"
}

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": {}
}
]
}