TESTNET
Connect

Market overview

client.market_overview returns one row per spot market (last price, 24h stats, and related fields). Public, no authentication required.

Methods

Method Summary
list Paginated / filtered overview rows.
create_subscription Snapshot-then-stream merged rows (preferred).
subscribe Raw Centrifugo batches (no snapshot merge).

List

overview = await client.market_overview.list(
    symbols=["BTC-USDT"],
    limit=50,
    include_sparklines=False,
)
for market in overview.markets:
    print(market.symbol_id, market.symbol, market.last_price, market.change_24h_bp)
Field Notes
symbols Optional filter list
limit Default 50
page_token Opaque cursor
include_sparklines Heavier payload when true

Create subscription

Fetches a REST snapshot, then merges live updates by symbol_id. Prefer this over raw subscribe for dashboards.

sub = await client.market_overview.create_subscription(
    symbols=["BTC-USDT"],
    limit=50,
)
async with sub:
    async for rows in sub:
        for m in rows:
            print(m.symbol, m.last_price)
        break

Subscribe

Raw batches on public:spot:market_overview:updates:proto without snapshot merge.

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. Heatmap L2 order book heatmap reads. 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. 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.
Previous

Lifecycle
Next

Order book