Skip to main content
GET
zones

Authorizations

X-Api-Key
string
header
required

API Key authentication. Include your API key in the X-Api-Key header for all requests.

Query Parameters

asset
string | null

Cryptocurrency asset identifier (e.g. btc, eth, ada). Use lowercase ticker symbol.

timeframe
string | null

Bucket timeframe: 1m, 5m, 15m, 30m, 1h, 4h, 6h, 12h, 1d.

lookback
string | null

History window. Defaults to the canonical window of the timeframe.

scope
string | null

Aggregation scope: 'all' (default) or 'exchange'.

exchange
string | null

Exchange id, required when scope=exchange.

maxClustersPerSide
integer<int32> | null

Max clusters returned per side (long/short). Defaults to 12, capped at 50.

Response

200 - application/json

OK

asset
string | null
lastBucketTime
string<date-time>
currentPrice
number<double>
longPct
number<double>
shortPct
number<double>
dominantSide
string | null
totalLongUsd
number<double>
totalShortUsd
number<double>
nearest
object
clusters
object[] | null
timeframe
string | null
lookback
string | null
scope
string | null
exchange
string | null
updatedAt
string<date-time>