GET /v1/strata/heatmap
#GET /v1/strata/heatmapgetStrataHeatmap
The modelled liquidation field over time
| Scope | strata:read |
|---|---|
| Lowest tier | sandbox |
| Weight (units) | 10 (7d window), 20 (30d) |
| History each tier may read | Sandbox: 7 days; Starter: 7 days; Elite (included): 7 days; Developer: 30 days; Business: 30 days |
| SDK | Python client.strata.heatmap ยท JavaScript cd.strata.heatmap |
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
coin required | query | string | Coin ticker, upper case (BTC). |
venue | query | string | Pin one venue (default: every venue the model uses for the coin). |
window | query | "7d" | "30d"default "7d" | Model look-back window (30d from Developer). |
from | query | string | Start, inclusive: unix seconds or RFC 3339. |
to | query | string | End, exclusive: unix seconds or RFC 3339. Default now. |
resolution | query | string | Column width. |
side | query | "long" | "short" | "both" | Position side. |
format | query | "sqrt8" | "usd" | sqrt8 = base64 bytes (byte q means about max_usd * (q / 255)^2); usd = decoded numbers. |
at | query | string | Compute as of a past time (unix seconds or RFC 3339) instead of now. |
Errors
400invalid_param, invalid_cursor401unauthorized: missing, unknown, revoked or expired key403insufficient_scope, tier_required404not_found, not_available, not_in_sandbox422window_too_large429rate_limited (per minute) or quota_exhausted (month; X-Quota-* headers, Retry-After = seconds to the next month); see Retry-After503api_disabled, overloaded
Example
curl "https://api.chartdeck.trade/v1/strata/heatmap?coin=BTC" \
-H "Authorization: Bearer $CHARTDECK_API_KEY"from chartdeck import Client
client = Client() # reads CHARTDECK_API_KEY
r = client.strata.heatmap(coin="BTC")
print(r.data, r.meta["attribution"])import { ChartDeck } from '@chartdeck/api';
const cd = new ChartDeck(); // reads CHARTDECK_API_KEY
const r = await cd.strata.heatmap({ coin: "BTC" });
console.log(r.data, r.meta.attribution);