Skip to main content

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​

OK

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"

Loading...