TESTNET
Connect

Catalog

client.catalogs is a CatalogManager holding venue reference data (spot pairs and Zipper / deposit-withdraw config). Services consult it to resolve symbols to ids and decimal quantities to scaled integers.

This is not the TypeScript client.catalog.market / .orders / .zipper reader surface. Python exposes hydration helpers and lookup methods on CatalogManager. Design notes live in Catalog & precision.

Lifecycle

By default (hydrate_catalogs=True) the client starts background hydration of spot config and deposit-withdraw config. Await readiness before decimal writes:

await client.wait_for_catalogs()
API Behavior
wait_for_catalogs() Await hydration; raises when the attempt fails
catalogs_last_error Most recent hydration error, if any
client.market_data.get_spot_config() Fetch the public raw spot-pair catalog
catalogs.hydrate_spot_config(raw) Replace spot snapshot
catalogs.hydrate_zipper_config(config) / typed Replace Zipper / DW snapshot (typed preferred)
catalogs.hydrate_deposit_withdraw_config(config) Alias of zipper hydrate

Hydration is fail-closed: wait_for_catalogs raises when spot/zipper fetch or parse fails, including invalid scales/IDs, empty names, and duplicate/conflicting identities. Empty catalogs after a soft skip are not treated as success. A rejected refresh leaves the previous valid snapshot intact. Scale 0 is valid for whole-unit assets and is distinct from a missing scale.

Lookups

await client.wait_for_catalogs()

symbol_id = client.catalogs.symbol_id_for_symbol("BTC-USDT")
scale = client.catalogs.base_quantity_scale_for_symbol("BTC-USDT")
buckets = client.catalogs.orderbook_price_buckets_for_symbol("BTC-USDT")

ledger_id = client.catalogs.ledger_id_for_asset("USDT")
asset_scale = client.catalogs.quantity_scale_for_asset("USDT")
Method Returns
symbol_id_for_symbol(symbol) int | None
base_quantity_scale_for_symbol(symbol) int | None
base_quantity_scale_for_symbol_id(symbol_id) int | None
orderbook_price_buckets_for_symbol(symbol) list[str]
ledger_id_for_asset(asset_symbol) int | None
quantity_scale_for_asset(asset_symbol) int | None
quantity_scale_for_zipped_asset_id(id) int | None
patch_zipper_supply(updates) bool if supply patched

There is no validateSpotOrderDecimalInput / getSpotOrderConstraints helper in Python like TypeScript. Invalid precision or constraints typically fail at encode time or as an API error.

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). 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. 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.
Previous

Candles
Next

Chain helpers