List markets

GET

/api/markets/markets

curl --request GET \
  --url 'https://example.com/api/markets/markets?limit=100'

Newest listed first. Name at least one of series, status or asset.

Parameters

Query Parameters

series

Any of:

string

string

null

null

One series, such as btc-updown-5m.

status

Any of:

string

string

null

null

One status, such as open.

asset

Any of:

string

string

null

null

One asset, such as btc.

duration

Any of:

string

string

null

null

Only windows this long, such as 5m. Name it with series, status or asset.

limit

Limit

integer

default: 100

Page size, up to 1,000. 100 if not given.

before

Any of:

integer

integer

>= -9223372036854776000 <= 9223372036854776000

null

null

Only markets listed before this one: the last page’s next_before.

since_open_timestamp

Any of:

integer

integer

>= -9223372036854776000 <= 9223372036854776000

null

null

Only markets listed at or after this time.

since_event_start_timestamp

Any of:

integer

integer

>= -9223372036854776000 <= 9223372036854776000

null

null

Only windows starting at or after this time.

Responses

200

Successful Response

Media typeapplication/json

MarketsPage

object

markets

required

Markets

Newest listed 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

number

null

null

settlement

required

Any of:

number

number

null

null

winning_outcome

required

Any of:

string

string

Allowed values: up down void

null

null

venue

required

Any of:

string

string

null

null

symbol

required

Any of:

string

string

null

null

candle

required

Any of:

string

string

null

null

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

next_before

required

Any of:

integer

integer

null

null

Example

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

422

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

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}