GET /v1/orderbook/heatmap

#`GET /v1/orderbook/heatmap`getOrderbookHeatmap

Recorded resting liquidity per bar

Scope	market:read
Lowest tier	sandbox
Weight (units)	10 up to 300 columns, 20 above (up to 1,500)
History each tier may read	Sandbox: 1 days; Starter: 1 days; Elite (included): 1 days; Developer: 14 days; Business: 180 days
SDK	Python client.market.orderbook_heatmap · JavaScript cd.market.orderbookHeatmap

Parameters

Parameter	In	Type	Description
`venue` required	query	`string`	Venue id (see /v1/venues), lower case.
`symbol` required	query	`string`	The venue's symbol (BTCUSDT; see /v1/markets).
`res` required	query	`string`	Resolution: minutes (1 ... 720), 1D, 1W, 1M; seconds (1S ... 45S) and ticks (10T ...) from Developer.
`from`	query	`string`	Start, inclusive: unix seconds or RFC 3339.
`to`	query	`string`	End, exclusive: unix seconds or RFC 3339. Default now.

Errors

400 invalid_param, invalid_cursor
401 unauthorized: missing, unknown, revoked or expired key
403 insufficient_scope, tier_required
404 not_found, not_available, not_in_sandbox
422 window_too_large
429 rate_limited (per minute) or quota_exhausted (month; X-Quota-* headers, Retry-After = seconds to the next month); see Retry-After
503 api_disabled, overloaded

Example

Shell

curl "https://api.chartdeck.trade/v1/orderbook/heatmap?venue=binance&symbol=BTCUSDT&res=60" \
  -H "Authorization: Bearer $CHARTDECK_API_KEY"

Python

from chartdeck import Client

client = Client()  # reads CHARTDECK_API_KEY
r = client.market.orderbook_heatmap(venue="binance", symbol="BTCUSDT", res="60")
print(r.data, r.meta["attribution"])

JavaScript

import { ChartDeck } from '@chartdeck/api';

const cd = new ChartDeck();  // reads CHARTDECK_API_KEY
const r = await cd.market.orderbookHeatmap({ venue: "binance", symbol: "BTCUSDT", res: "60" });
console.log(r.data, r.meta.attribution);

GET /v1/orderbook/heatmap

#GET /v1/orderbook/heatmapgetOrderbookHeatmap

#`GET /v1/orderbook/heatmap`getOrderbookHeatmap