Get Orderbook Heatmap
Get historical orderbook depth snapshots for a specific exchange and trading pair. Returns bid/ask price levels and quantities over time for heatmap visualization. Ideal for: liquidity visualization, support/resistance identification, order flow analysis, market depth charting.
Catalog action Blockchain Data
Get historical orderbook depth snapshots for a specific exchange and trading pair. Returns bid/ask price levels and quantities over time for heatmap visualization. Ideal for: liquidity visualization, support/resistance identification, order flow analysis, market depth charting.
At a Glance
| Field | Value |
|---|---|
| Action ID | coinglass-get-orderbook-heatmap |
| Category | Blockchain Data |
| Connector | Not required |
| Requires gas | No |
| Funds movement | None declared |
| Tags | coinglass, liquidity, futures, derivatives, read |
Payload Schema
| Field | Type | Required | Description |
|---|---|---|---|
exchange | string | Yes | Futures exchange name (e.g., 'Binance', 'OKX', 'Bybit'). Use the supported-exchange-pair API to get valid exchanges. |
symbol | string | Yes | Trading pair symbol (e.g., 'BTCUSDT', 'ETHUSDT'). Check supported pairs via the supported-exchange-pair API. |
limit | number | No | Maximum number of snapshots to return (default: 100). |
startTime | number | No | Start timestamp in milliseconds (e.g., 1641522717000). |
endTime | number | No | End timestamp in milliseconds (e.g., 1641522717000). |
Result Schema
| Field | Type | Required | Description |
|---|---|---|---|
exchange | string | Yes | Exchange name. |
symbol | string | Yes | Trading pair symbol. |
entries | array | Yes | Array of orderbook depth snapshots for heatmap visualization |
Examples
json{ "type": "coinglass-get-orderbook-heatmap", "payload": { "exchange": "example-exchange", "symbol": "ETH" }, "children": []}
bashcurl -X POST "https://api.b3os.org/v1/actions/coinglass-get-orderbook-heatmap/test" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "inputs": { "exchange": "example-exchange", "symbol": "ETH" }}'
Payload fields can use workflow expressions such as {{$trigger.body.amount}}, {{$nodes.fetch.result.price}}, and {{$props.asset}} when the value should come from a trigger, prior node, or reusable workflow prop.