Liquidation heatmap (token × exchange)

GET 
/api/v1/liquidation/heatmap

Aggregated long/short liquidation USD by (token, exchange) over a rolling window. Result is cached for ~10s. Sub-1h windows are not supported (in-memory buckets are 30min); use the WS feed for finer granularity.

Request

Query Parameters

window string
Possible values: [1h, 4h, 24h]
Rolling window
Default value: 1h
topN integer
Top N tokens by total
Default value: 10

Header Parameters

X-DTMX-APIKEY stringrequired

Your DataMaxi+ API key

Responses

200

OK

application/json

Schema

Schema

cells

object[]

(top tokens) × (all exchanges with data)

Array [

base string

exchange string

longUsd number

shortUsd number

tokenId string

totalUsd number

]

exchanges

object[]

sorted desc, includes only venues with data

Array [

exchange string

longUsd number

shortUsd number

totalUsd number

]

generatedAt integer

ms

grandTotal number

tokens

object[]

top N by TotalUsd desc

Array [

base string

longUsd number

name string

shortUsd number

symbol string

tokenId string

totalUsd number

]

window string

"1h" | "4h" | "24h"

Example (from schema)

{
  "cells": [
    {
      "base": "string",
      "exchange": "string",
      "longUsd": 0,
      "shortUsd": 0,
      "tokenId": "string",
      "totalUsd": 0
    }
  ],
  "exchanges": [
    {
      "exchange": "string",
      "longUsd": 0,
      "shortUsd": 0,
      "totalUsd": 0
    }
  ],
  "generatedAt": 0,
  "grandTotal": 0,
  "tokens": [
    {
      "base": "string",
      "longUsd": 0,
      "name": "string",
      "shortUsd": 0,
      "symbol": "string",
      "tokenId": "string",
      "totalUsd": 0
    }
  ],
  "window": "string"
}

400

Bad Request

application/json

Schema

Schema

error string

error specifies the error message

Example (from schema)

{
  "error": "string"
}

500

Internal Server Error

application/json

Schema

Schema

error string

error specifies the error message

Example (from schema)

{
  "error": "string"
}

Loading...