Skip to main content
GET
Get Perp DEX Protocol timeseries

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.

Path Parameters

granularity
enum<string>
required

Data granularity.

Available options:
1d
id
string
required

The Project ID identifying the series. A key no series has is not an error: the response carries an empty points array.

Query Parameters

timeframe
string

Time window, one of: to-date (ytd, qtd, mtd, dtd, htd); relative, followed by m, h, d or w (30d, 12h, 4w; 1y and 1M are not accepted, use 365d, 52w, ytd or a calendar year); a calendar day (YYYY-MM-DD), month (YYYY-MM) or year (YYYY); or an RFC3339 instant, which runs from then to now. Mutually exclusive with start/end. Default: everything retained, up to now.

start
string

Window start, inclusive (RFC3339, unix seconds, or YYYY-MM-DD). Default: unbounded.

end
string

Window end, exclusive (RFC3339, unix seconds, or YYYY-MM-DD). Default: now.

bounds
boolean

If true, return only the first and last point of the resolved time window instead of every point in it.

selections
enum<string>[]

Comma-separated metric fields to return; defaults to every metric. A point always leads with its timestamp, and the values that follow are described by point_schema in catalog order regardless of the order requested here.

Available options:
volumeUSD,
openInterestUSD,
tradeCount,
liquidationVolumeUSD,
liquidationCount,
marketCount,
marketLevelVolumeUSD,
marketLevelOpenInterestUSD,
marketLevelTradeCount,
marketLevelLiquidationVolumeUSD,
marketLevelLiquidationCount,
hip3VolumeUSD,
hip3OpenInterestUSD,
hip3TradeCount,
hip3LiquidationVolumeUSD,
hip3LiquidationCount,
coreVolumeUSD,
coreOpenInterestUSD,
coreTradeCount,
coreLiquidationVolumeUSD,
coreLiquidationCount,
categoryBondVolumeUSD,
categoryCommodityVolumeUSD,
categoryCryptoVolumeUSD,
categoryFXVolumeUSD,
categoryIndexVolumeUSD,
categoryPreIPOVolumeUSD,
categoryStockVolumeUSD,
categoryRWAVolumeUSD,
categoryBondOpenInterestUSD,
categoryCommodityOpenInterestUSD,
categoryCryptoOpenInterestUSD,
categoryFXOpenInterestUSD,
categoryIndexOpenInterestUSD,
categoryPreIPOOpenInterestUSD,
categoryStockOpenInterestUSD,
categoryRWAOpenInterestUSD,
categoryBondTradeCount,
categoryCommodityTradeCount,
categoryCryptoTradeCount,
categoryFXTradeCount,
categoryIndexTradeCount,
categoryPreIPOTradeCount,
categoryStockTradeCount,
categoryRWATradeCount,
categoryBondLiquidationVolumeUSD,
categoryCommodityLiquidationVolumeUSD,
categoryCryptoLiquidationVolumeUSD,
categoryFXLiquidationVolumeUSD,
categoryIndexLiquidationVolumeUSD,
categoryPreIPOLiquidationVolumeUSD,
categoryStockLiquidationVolumeUSD,
categoryRWALiquidationVolumeUSD,
categoryBondLiquidationCount,
categoryCommodityLiquidationCount,
categoryCryptoLiquidationCount,
categoryFXLiquidationCount,
categoryIndexLiquidationCount,
categoryPreIPOLiquidationCount,
categoryStockLiquidationCount,
categoryRWALiquidationCount,
pairBitcoinUSDVolumeUSD,
pairEthereumUSDVolumeUSD,
pairSolanaUSDVolumeUSD,
pairHyperliquidUSDVolumeUSD,
pairBNBUSDVolumeUSD,
pairXRPUSDVolumeUSD,
pairAvalancheUSDVolumeUSD,
pairBitcoinUSDOpenInterestUSD,
pairEthereumUSDOpenInterestUSD,
pairSolanaUSDOpenInterestUSD,
pairHyperliquidUSDOpenInterestUSD,
pairBNBUSDOpenInterestUSD,
pairXRPUSDOpenInterestUSD,
pairAvalancheUSDOpenInterestUSD,
pairBitcoinUSDTradeCount,
pairEthereumUSDTradeCount,
pairSolanaUSDTradeCount,
pairHyperliquidUSDTradeCount,
pairBNBUSDTradeCount,
pairXRPUSDTradeCount,
pairAvalancheUSDTradeCount,
pairBitcoinUSDLiquidationVolumeUSD,
pairEthereumUSDLiquidationVolumeUSD,
pairSolanaUSDLiquidationVolumeUSD,
pairHyperliquidUSDLiquidationVolumeUSD,
pairBNBUSDLiquidationVolumeUSD,
pairXRPUSDLiquidationVolumeUSD,
pairAvalancheUSDLiquidationVolumeUSD,
pairBitcoinUSDLiquidationCount,
pairEthereumUSDLiquidationCount,
pairSolanaUSDLiquidationCount,
pairHyperliquidUSDLiquidationCount,
pairBNBUSDLiquidationCount,
pairXRPUSDLiquidationCount,
pairAvalancheUSDLiquidationCount
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

Timeseries points for the series.

data
object
required
error
string | null