COcoinversa
Liquidation risk

Inspect potential liquidation exposure by price

Changed on

Group currently indexed positions by liquidation price around the current mark. Risk notional is potential exposure in USD, not realized liquidations or a price forecast. The timestamp is when the heatmap was computed, including when served from cache. Empty buckets with currentPrice zero mean no matching input positions. Numeric query parameters must be integers; buckets <= 0 returns an empty heatmap under the existing contract.

get/api/public/v1/live/liquidation-heatmap/{coin}

Request

Path parameters

coinstring required

Exact market symbol as indexed; for example BTC or xyz:GOLD.

Query parameters

bucketsinteger

Number of equal price buckets. Values at or below zero return an empty heatmap; use 50 for the standard example.

rangeinteger

Percentage distance below and above current mark, not a fraction: 30 means +/-30 percent.

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

coinstring required

Market symbol queried.

currentPricenumber double required

Mark price used to construct buckets, USD per unit; zero if there are no input positions.

timestampinteger required

Time this heatmap was computed, Unix milliseconds. Preserved on cache hits; not a source ingestion timestamp.

totalLongAtRisknumber double required

Total long position notional inside the requested price range, USD.

totalShortAtRisknumber double required

Total short position notional inside the requested price range, USD.

Example response

{
  "$schema": "https://api.coinversa.ai/schemas/LiquidationHeatmapBody.json"
}

Changes

  • f2eba29805e5Revision changes
    • info

      api tag Liquidation risk added

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status