Reference
Metadata
What there is to ask for: every dataset with its fields, and the symbols each exchange has, in Atlas names. Use them to build requests and channel names.
List Available Metrics
GET/api/v1/metadata/catalog
Returns the full catalog of available datasets with their fields. Use this endpoint to discover which metrics are available, understand their fields, and determine the correct :bucket value to use in /data/:bucket requests.
Parameters
No parameters.
Responses
200 response
{
"metrics": [
{
"id": "flow",
"name": "Flow Metrics",
"description": "Directional order flow split by taker buy vs. sell, broken into small/medium/large notional segments, with a flow toxicity score.",
"category": "Trades",
"fields": [
{
"name": "taker_buy_volume",
"label": "Taker Buy Volume",
"description": "Total buy-side traded notional in the interval"
},
{
"name": "taker_sell_volume",
"label": "Taker Sell Volume",
"description": "Total sell-side traded notional in the interval"
}
],
"liveIntervals": [
"15s",
"30s",
"1m",
"5m",
"15m",
"30m",
"1h",
"4h",
"1d"
]
}
]
}| Status | Meaning |
|---|---|
200 | Successful response with the full metrics catalog |
401 | Unauthorized - missing or invalid API key, or insufficient subscription |
Try it
Authentication
An API key is required to send requests.Sign up
GET
/api/v1/metadata/catalogResponse will appear here
List Available Symbols
GET/api/v1/metadata/symbols
Returns all available trading pair symbols for a given exchange. Use this endpoint to discover which symbols have data before making data requests.
Parameters
| Parameter | Values | Meaning |
|---|---|---|
exchangequery · required | binance-futuresokx-perpshyperliquid-perps | Exchange to list symbols for. |
Responses
200 response
{
"symbols": [
"perpetual-BTC-USDT:USDT",
"perpetual-ETH-USDT:USDT"
],
"exchange": "binance-futures"
}| Status | Meaning |
|---|---|
200 | Successful response with list of available symbols |
400 | Bad request - missing or invalid exchange parameter |
401 | Unauthorized - missing or invalid API key, or insufficient subscription |
500 | Server error - failed to list symbols |
Try it
Authentication
An API key is required to send requests.Sign up
GET
/api/v1/metadata/symbols?exchange=binance-futuresResponse will appear here