Heatmap

client.heatmap reads historical L2 heatmap buckets and streams live buckets. It is a visualization/analytics surface, not an authoritative local order book.

await client.wait_for_catalogs()

history = await client.heatmap.get(
    symbol="BTC-USDT",
    interval="1s",
    depth=50,
    limit=100,
    quantity_mode="close",
)
print(history.raw)

symbol or symbol_id is required. start_time / end_time accept datetime; from_ts_sec is an alternate cursor. Interval, depth, and quantity-mode labels are validated by the SDK.

sub = await client.heatmap.subscribe_live(
    symbol="BTC-USDT",
    interval="1s",
)
async with sub:
    async for bucket in sub:
        print(bucket.raw)
        break

The live channel is public, but symbol-name use depends on a hydrated catalog. Responses are ApiData forward-compatible trees.

For executable price levels and sequence recovery use Order book.

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 Read ledger balances, history, holds, and stream live balance updates. Candles Read and stream public spot OHLCV candles via market data (candles alias). Catalog Spot and Zipper catalog hydration, symbol lookups, and quantity scales used by decimal order writes. Chain helpers On-chain Funding → Trading and Funding withdraw helpers. Chain analytics Chain analytics read APIs. Client configuration Constructor options, URLs, catalogs, wire format, and from_env behavior. Deposit Create and list per-account chain deposit addresses for funding your Polyester account. Errors Python SDK error types, MFA auth codes, realtime overflow, and retry guidance. 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 optional attached take-profit, stop-loss, and trailing-stop risk. 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 WebSocket client, subscription contract, 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 automations that place a child order when a market condition fires. 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.

Related Topics

Guard signer

Internal transfers