Skip to main content
GET
List Perpetual Markets

Authorizations

X-Blockworks-API-Key
string
header
required

API key sent in the X-Blockworks-API-Key header; x-messari-api-key is accepted for existing integrations. The catalog endpoints and models on the public access tier need no key.

Query Parameters

idEq
string

Perpetual Market ID equals.

idIsOneOf
string[]

Perpetual Market ID is one of (comma-separated).

nameEq
string

Name equals.

nameIsOneOf
string[]

Name is one of (comma-separated).

nameContains
string

Name contains (case-insensitive substring).

slugEq
string

Slug equals.

slugIsOneOf
string[]

Slug is one of (comma-separated).

exchangeEq
string

Exchange equals.

exchangeIsOneOf
string[]

Exchange is one of (comma-separated).

symbolEq
string

Symbol equals.

symbolIsOneOf
string[]

Symbol is one of (comma-separated).

symbolContains
string

Symbol contains (case-insensitive substring).

symbolNormalizedEq
string

Normalized Symbol equals.

symbolNormalizedIsOneOf
string[]

Normalized Symbol is one of (comma-separated).

symbolNormalizedContains
string

Normalized Symbol contains (case-insensitive substring).

baseAssetIDEq
string

Base Asset ID equals.

baseAssetIDIsOneOf
string[]

Base Asset ID is one of (comma-separated).

baseAssetNameEq
string

Base Asset Name equals.

baseAssetNameIsOneOf
string[]

Base Asset Name is one of (comma-separated).

baseAssetNameContains
string

Base Asset Name contains (case-insensitive substring).

baseAssetSlugEq
string

Base Asset Slug equals.

baseAssetSlugIsOneOf
string[]

Base Asset Slug is one of (comma-separated).

baseAssetSymbolEq
string

Base Asset Symbol equals.

baseAssetSymbolIsOneOf
string[]

Base Asset Symbol is one of (comma-separated).

baseAssetSymbolContains
string

Base Asset Symbol contains (case-insensitive substring).

baseAssetSerialIDEq
integer<int64>

Base Asset Serial ID equals.

baseAssetSerialIDIsOneOf
integer<int64>[]

Base Asset Serial ID is one of (comma-separated).

quoteAssetSerialIDEq
integer<int64>

Quote Asset Serial ID equals.

quoteAssetSerialIDIsOneOf
integer<int64>[]

Quote Asset Serial ID is one of (comma-separated).

settleAssetSerialIDEq
integer<int64>

Settle Asset Serial ID equals.

settleAssetSerialIDIsOneOf
integer<int64>[]

Settle Asset Serial ID is one of (comma-separated).

exchangeSerialIDEq
integer<int64>

Exchange Serial ID equals.

exchangeSerialIDIsOneOf
integer<int64>[]

Exchange Serial ID is one of (comma-separated).

quoteCurrencyEq
string

Quote Currency equals.

quoteCurrencyIsOneOf
string[]

Quote Currency is one of (comma-separated).

settleCurrencyEq
string

Settle Currency equals.

settleCurrencyIsOneOf
string[]

Settle Currency is one of (comma-separated).

contractTypeEq
string

Contract Type equals.

contractTypeIsOneOf
string[]

Contract Type is one of (comma-separated).

marginTypeEq
string

Margin Type equals.

marginTypeIsOneOf
string[]

Margin Type is one of (comma-separated).

exchangeIDEq
string

Exchange ID equals.

exchangeIDIsOneOf
string[]

Exchange ID is one of (comma-separated).

exchangeNameEq
string

Exchange Name equals.

exchangeNameIsOneOf
string[]

Exchange Name is one of (comma-separated).

exchangeNameContains
string

Exchange Name contains (case-insensitive substring).

sortBy
enum<string>
default:name

Field to sort by; defaults to the model's default sort column.

Available options:
name,
slug,
exchange,
symbol,
baseAssetName,
baseAssetSlug,
baseAssetSymbol,
quoteCurrency
sortDirection
enum<string>
default:asc

Sort direction.

Available options:
asc,
desc
page
integer

1-based page number.

pageSize
integer

Rows per page (max 1000, default 100).

selections
enum<string>[]

Comma-separated fields to return; defaults to all fields.

Available options:
id,
name,
slug,
exchange,
symbol,
symbolNormalized,
baseAssetID,
baseAssetName,
baseAssetSlug,
baseAssetSymbol,
baseAssetSerialID,
quoteAssetSerialID,
settleAssetSerialID,
exchangeSerialID,
quoteCurrency,
settleCurrency,
contractType,
marginType,
exchangeID,
exchangeName
acceptFormat
enum<string>
default:json

Response format, overriding the Accept header: json (default), csv, or jsonl (NDJSON). csv and jsonl return the rows as a downloadable file.

Available options:
json,
csv,
jsonl

Response

One page of matching rows, with the totals for the whole filtered set.

data
object[]
required
metadata
object
required

Pagination totals for the full filtered result set, independent of the current page.

error
string | null