Skip to main content
GET
cURL

Authorizations

Authorization
string
header
default:ApiKey <key>
required

Scoped API key with required prefix "ApiKey ". Available scopes: metrics:read, reported_metrics:write and mm_metrics:read.

Query Parameters

assets
string[]

Comma-separated asset symbols, e.g. BTC,ETH_PERP. Only assets of your organizations are allowed (see /v1/organizations/). Defaults to all of them.

Maximum array length: 100
filename
string
default:chart.csv

File name of the download.

Minimum string length: 1
filter_exchange
string[]

Keep only these exchange slugs. Repeatable.

filter_organization
string[]

Keep only these organization slugs. Repeatable.

filter_quote
string[]

Keep only pairs with these quote currencies. Repeatable.

group_by
enum<string>
required

One series per pair, exchange, asset or organization, or one for all.

  • pair - pair
  • all - all
  • exchange - exchange
  • asset - asset
  • organization - organization
Available options:
pair,
all,
exchange,
asset,
organization
Minimum string length: 1
Example:

"pair"

interval
enum<string>
required
  • 1M - Aggregated in 1 month periods.
  • 1w - Aggregated in 1 week periods.
  • 1d - Aggregated in 1 day periods.
  • 4h - Aggregated in 4 hour periods.
  • 1h - Aggregated in 1 hour periods.
  • 30m - Aggregated in 30 minute periods.
  • 15m - Aggregated in 15 minute periods.
  • 5m - Aggregated in 5 minute periods.
  • 1m - Aggregated in 1 minute periods.
  • c - Will return all the data for the specified time range using the biggest periods possible.
  • a - Will return the aggregate of the data for the specified time range.
Available options:
1M,
1w,
1d,
4h,
1h,
30m,
15m,
5m,
1m,
c,
a
Minimum string length: 1
Example:

"1h"

lookback
enum<string>

Relative window ending now. Can't be combined with time_start/time_end.

  • 30-minutes - 30-minutes
  • 1-hour - 1-hour
  • 3-hours - 3-hours
  • 6-hours - 6-hours
  • 12-hours - 12-hours
  • 1-day - 1-day
  • 7-days - 7-days
  • 1-month - 1-month
  • 3-months - 3-months
  • 6-months - 6-months
  • 1-year - 1-year
Available options:
30-minutes,
1-hour,
3-hours,
6-hours,
12-hours,
1-day,
7-days,
1-month,
3-months,
6-months,
1-year
Minimum string length: 1
Example:

"1-day"

market_hours_days
string

Days to include, as comma-separated week:day pairs such as this:1,last:5, or a JSON array of {"week", "day"} objects. week is this or last; day is 0 (Sunday) to 6 (Saturday).

market_hours_preset
enum<string>

Trading session to restrict the window to. Requires market_hours_days; can't be combined with time_start/time_end or lookback.

  • pre-market - pre-market
  • opening-bell - opening-bell
  • market-hours - market-hours
  • closing-bell - closing-bell
  • after-hours - after-hours
  • blue-ocean - blue-ocean
  • weekend-hours - weekend-hours
Available options:
pre-market,
opening-bell,
market-hours,
closing-bell,
after-hours,
blue-ocean,
weekend-hours
Minimum string length: 1
market_hours_timezone
string
default:America/New_York

Time zone of the market-hours sessions.

Minimum string length: 1
selected_label
string[]

Keep only the series with these labels. Repeatable.

specific_metric
enum<string>
required
  • volume - volume
  • twap - twap
  • vwap - vwap
  • rollingVolume - rollingVolume
  • rollingTwap - rollingTwap
  • rollingVwap - rollingVwap
  • spreadAbs - spreadAbs
  • spreadBps - spreadBps
  • midPrice - midPrice
  • midPriceMovement - midPriceMovement
  • topOfBookBidPrice - topOfBookBidPrice
  • topOfBookBidAmount - topOfBookBidAmount
  • topOfBookBidAmountUsd - topOfBookBidAmountUsd
  • topOfBookAskPrice - topOfBookAskPrice
  • topOfBookAskAmount - topOfBookAskAmount
  • topOfBookAskAmountUsd - topOfBookAskAmountUsd
  • depthBid - depthBid
  • depthAsk - depthAsk
  • countBid - countBid
  • countAsk - countAsk
  • slippageBuy - slippageBuy
  • slippageSell - slippageSell
  • spreadUptime - spreadUptime
  • depthUptime - depthUptime
  • volumeContribution - volumeContribution
  • fundingRate8h - fundingRate8h
  • fundingRateAnnualized - fundingRateAnnualized
  • oiWeightedFundingRate8h - oiWeightedFundingRate8h
  • oiWeightedFundingRateAnnualized - oiWeightedFundingRateAnnualized
  • openInterestUsd - openInterestUsd
  • openInterestBase - openInterestBase
  • perpSpotArbitrage - perpSpotArbitrage
  • marketMakerVolume - marketMakerVolume
  • marketMakerDepthBid - marketMakerDepthBid
  • marketMakerDepthAsk - marketMakerDepthAsk
  • marketMakerSpreadBps - marketMakerSpreadBps
  • marketMakerVolumeCoverage - marketMakerVolumeCoverage
  • marketMakerDepthCoverageBid - marketMakerDepthCoverageBid
  • marketMakerDepthCoverageAsk - marketMakerDepthCoverageAsk
  • reportedVolume - reportedVolume
  • reportedVolumeCoverage - reportedVolumeCoverage
  • reportedSpreadBps - reportedSpreadBps
  • reportedSpreadUptime - reportedSpreadUptime
  • reportedDepthBid - reportedDepthBid
  • reportedDepthAsk - reportedDepthAsk
  • reportedDepthUptimeBid - reportedDepthUptimeBid
  • reportedDepthUptimeAsk - reportedDepthUptimeAsk
  • reportedDepthCoverageBid - reportedDepthCoverageBid
  • reportedDepthCoverageAsk - reportedDepthCoverageAsk
Available options:
volume,
twap,
vwap,
rollingVolume,
rollingTwap,
rollingVwap,
spreadAbs,
spreadBps,
midPrice,
midPriceMovement,
topOfBookBidPrice,
topOfBookBidAmount,
topOfBookBidAmountUsd,
topOfBookAskPrice,
topOfBookAskAmount,
topOfBookAskAmountUsd,
depthBid,
depthAsk,
countBid,
countAsk,
slippageBuy,
slippageSell,
spreadUptime,
depthUptime,
volumeContribution,
fundingRate8h,
fundingRateAnnualized,
oiWeightedFundingRate8h,
oiWeightedFundingRateAnnualized,
openInterestUsd,
openInterestBase,
perpSpotArbitrage,
marketMakerVolume,
marketMakerDepthBid,
marketMakerDepthAsk,
marketMakerSpreadBps,
marketMakerVolumeCoverage,
marketMakerDepthCoverageBid,
marketMakerDepthCoverageAsk,
reportedVolume,
reportedVolumeCoverage,
reportedSpreadBps,
reportedSpreadUptime,
reportedDepthBid,
reportedDepthAsk,
reportedDepthUptimeBid,
reportedDepthUptimeAsk,
reportedDepthCoverageBid,
reportedDepthCoverageAsk
Minimum string length: 1
Example:

"volume"

time_end
string<date-time>

Window end, ISO 8601. UTC when no offset is given.

time_start
string<date-time>

Window start, ISO 8601. UTC when no offset is given.

Response

CSV file download.

The response is of type string.