Skip to main content
GET
List Perpetual Market Funding Rates

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 open to everyone need no key.

Query Parameters

perpetualMarketIDEq
string

Perpetual Market ID equals.

perpetualMarketIDIsOneOf
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).

exchangeSlugEq
string

Exchange Slug equals.

exchangeSlugIsOneOf
string[]

Exchange Slug is one of (comma-separated).

exchangeEq
string

Exchange equals.

exchangeIsOneOf
string[]

Exchange is one of (comma-separated).

exchangeSubEq
string

Sub-venue equals.

exchangeSubIsOneOf
string[]

Sub-venue is one of (comma-separated).

symbolEq
string

Symbol equals.

symbolIsOneOf
string[]

Symbol is one of (comma-separated).

symbolContains
string

Symbol contains (case-insensitive substring).

baseAssetEq
string

Base Asset equals.

baseAssetIsOneOf
string[]

Base Asset is one of (comma-separated).

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).

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).

exchangeSerialIDEq
integer<int64>

Exchange Serial ID equals.

exchangeSerialIDIsOneOf
integer<int64>[]

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

intervalHoursEq
integer<int64>

Interval Hours equals.

intervalHoursIsOneOf
integer<int64>[]

Interval Hours is one of (comma-separated).

sortBy
enum<string>
default:name

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

Available options:
name,
exchangeSlug,
exchange,
exchangeSub,
symbol,
baseAsset,
baseAssetName,
baseAssetSlug,
baseAssetSymbol
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:
perpetualMarketID,
name,
exchangeSlug,
exchange,
exchangeSub,
symbol,
baseAsset,
baseAssetID,
baseAssetName,
baseAssetSlug,
baseAssetSymbol,
baseAssetSerialID,
exchangeID,
exchangeName,
exchangeSerialID,
intervalHours
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