client.heatmap reads recent L2 heatmap buckets and streams live buckets. It is an analytics
surface, not an authoritative local order book.
Methods
| Method | Summary |
|---|---|
get | Recent buckets for symbol, interval, depth, limit, and mode. |
subscribe_live | Live public buckets for a symbol and interval. |
client.wait_for_catalogs().await?;
let history = client
.heatmap
.get("BTC-USDT", "1s", 50, 100, "close")
.await?;
println!("{}", history.raw);The positional arguments are symbol, interval, depth, limit, and quantity_mode. get resolves the symbol from catalogs and requests the most recent five-minute window.
Interval, depth, and quantity-mode labels are validated.
let mut sub = client.heatmap.subscribe_live("BTC-USDT", "1s").await?;
if let Some(bucket) = sub.recv_result().await? {
println!("{}", bucket.raw);
}The stream is public, but symbol resolution requires hydrated catalogs.
For executable levels and sequence recovery use Order book.
Related Topics
Address book Saved destinations and whitelist views. API keys List, get, subscribe, and generate local API key material (no create on API-key SDKs). Auth Auth service helpers including nested profile access. Balances List ledger balances via GetBalancesRequest, history, holds, and private subscribe. Candles Read and stream public spot OHLCV candles via market_data. Catalog Spot/Zipper catalog hydration with hydrate_catalogs and wait_for_catalogs. Chain helpers On-chain Funding → Trading and Funding withdraw helpers. Chain analytics Chain analytics read APIs. Client configuration Config fields, URLs, catalogs, wire format, and from_env behavior. Deposit Create and list per-account chain deposit addresses for funding your Polyester account. Errors Rust Error enum variants, MFA auth codes, and queue overflow. Guard signer Guard signer approval helpers. Internal transfers Move trading balances between Polyester accounts without touching a chain. Layout Layout collaboration APIs (reference-only). Lifecycle Deposit/withdraw lifecycle flows and subscribe. Market overview List and subscribe to per-market stats with optional snapshot-then-stream merge. Order book Depth snapshots and a stateful live order book that reconstructs the book for you. Orders Place, modify, cancel, batch, and stream spot orders with the Rust OrdersService. Policies Realtime API-key and subaccount-policy updates. Polychart Polychart collaboration APIs (reference-only). Profile Profile identity reads and subscribe helpers. Public trades Public trade tape reads and subscribe via market_data. Realtime Shared Centrifugo client, observable failures, handshake-before-return, and fail-closed overflow. Social verification Social verification APIs (reference-only). Subaccounts Subaccount reads, members, invites, activity. User trades List and stream your private spot fills (not the public tape). Transfers Transfer history reads. Triggers Create, manage, pause/resume, and stream standalone triggers with the Rust TriggersService. Whiteboard Whiteboard collaboration APIs (reference-only). Withdrawals Trading withdraw intents to funding or external chain destinations (signed payload). Zipper Deposit/withdraw config and related Zipper reads.