heatmap

Retrieve liquidation levels data for /liquidation_levels/heatmap. Returns relevant metrics and indicators.

GET /liquidation_levels/heatmap

heatmap

cURL

curl --request GET \
  --url https://api.alphractal.com/liquidation_levels/heatmap \
  --header 'X-Api-Key: <api-key>'

200

{
  "asset": "<string>",
  "timeframe": "<string>",
  "lookback": "<string>",
  "scope": "<string>",
  "exchange": "<string>",
  "version": "2023-11-07T05:31:56Z",
  "priceSource": "<string>",
  "x": [
    "2023-11-07T05:31:56Z"
  ],
  "y": [
    123
  ],
  "z": [
    [
      123
    ]
  ],
  "df": [
    {
      "date": "2023-11-07T05:31:56Z",
      "open": 123,
      "high": 123,
      "low": 123,
      "close": 123
    }
  ],
  "topTraderLsr": [
    {
      "date": "2023-11-07T05:31:56Z",
      "value": 123
    }
  ]
}

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: 12h, 24h, 3d, 7d, 14d, 30d, 90d, 180d, 365d, 2y, 4y, 6y. Defaults to the canonical window of the timeframe (e.g. 30m → 30d).

scope · string | null

Aggregation scope: 'all' (default, aggregated across exchanges) or 'exchange'.

exchange · string | null

Exchange id, required when scope=exchange (e.g. binance).

Response

200 - application/json

OK

asset · string | null

timeframe · string | null

lookback · string | null

scope · string | null

exchange · string | null

version · string<date-time> | null

priceSource · string | null

x · string<date-time>[] | null

y · number<double>[] | null

z · number<float>[][] | null

df · object[] | null

Show child attributes

topTraderLsr · object[] | null

Show child attributes