Liquidation Heatmap

Get liquidation heatmap of a specific token

get

Retrieve liquidation heatmap data, namely potential liquidation at different price buckets over time. Returns most recent records in descending order. Defaults to the last 5 records.

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

tokenstringRequired

Query parameters

timeframestringOptionalDefault: 10min

limitinteger · min: 1 · max: 10000Optional

Number of records to return

Default: 5

start_timestampany ofOptional

Start timestamp in Unix epoch milliseconds (optional filter). Defaults to timestamp of 24 hours ago

integerOptional

or

nullOptional

end_timestampany ofOptional

End timestamp in Unix epoch milliseconds (optional filter)

integerOptional

or

nullOptional

min_liquidation_pxany ofOptional

Minimum liquidation price (optional_filter)

numberOptional

or

nullOptional

max_liquidation_pxany ofOptional

Maximum liquidation price (optional_filter)

numberOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/liquidation/heatmap/{token}

HTTPcURLJavaScriptPython

GET /v1/liquidation/heatmap/{token} HTTP/1.1
Host: data.blockliquidity.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "timestamp": 1,
      "log_liq_px_bucket_id": 1,
      "liq_px_bucket_floor": 1,
      "liq_px_bucket_middle": 1,
      "liq_px_bucket_ceil": 1,
      "liq_size_usdc": 1
    }
  ]
}