Skip to main content
POST
/
api
/
coinglass
/
liquidations
/
heatmap
/coinglass/liquidations/heatmap
curl --request POST \
  --url https://api.anysite.io/api/coinglass/liquidations/heatmap \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "symbol": "<string>",
  "timeout": 300
}
'
[
  {
    "symbol": "<string>",
    "@type": "@coinglass_liquidation_heatmap",
    "image": "<string>",
    "price": 123,
    "long_risk": 123,
    "short_risk": 123,
    "max_long_liquidation_price": 123,
    "max_long_liquidation_level": 123,
    "max_short_liquidation_price": 123,
    "max_short_liquidation_level": 123,
    "longs": [],
    "shorts": []
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
symbol
string
required

Coin ticker symbol

Minimum string length: 1
Example:

"BTC"

timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

symbol
string
required
@type
string
default:@coinglass_liquidation_heatmap
image
string | null
price
number | null
long_risk
number | null
short_risk
number | null
max_long_liquidation_price
number | null
max_long_liquidation_level
number | null
max_short_liquidation_price
number | null
max_short_liquidation_level
number | null
longs
CoinglassLiquidationLevel · object[]
shorts
CoinglassLiquidationLevel · object[]