Skip to main content
GET
Inspect potential liquidation exposure by price

Authorizations

X-API-Key
string
header
required

Create an API key at https://developers.coinversa.ai/keys. REST limits are shared across keys by account; access uses the effective tier of the presented key.

Path Parameters

coin
string
required

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

Query Parameters

buckets
integer<int32>
default:50

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

range
integer<int32>
default:30

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

Response

OK

buckets
object[] | null
required

Price buckets ordered ascending; empty if no positions were found or bucket count is nonpositive.

coin
string
required

Market symbol queried.

currentPrice
number<double>
required

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

timestamp
integer<int64>
required

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

totalLongAtRisk
number<double>
required

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

totalShortAtRisk
number<double>
required

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

$schema
string<uri>
read-only

A URL to the JSON Schema for this object.

Example:

"https://api.coinversa.ai/schemas/LiquidationHeatmapBody.json"