TESTNET
Connect

Withdrawals

client.withdraw (alias client.trading_withdraws) creates durable, signed withdrawal intents out of the trading venue: to funding or to an external chain via Zipper.

API-key bots can use the SDK's prepare/sign/persist flow. It builds the deadline and nonce once, serializes the payload deterministically, signs those exact protobuf bytes with the configured Ed25519 API key, and returns an immutable PreparedTradingWithdraw. Persist it before the first submission and reuse it unchanged after an ambiguous timeout.

Methods (API-key surface)

Method Summary
prepare_api_key_to_funding Build and sign Trading → funding once.
prepare_api_key_to_external_chain Build and sign Trading → external once.
submit_prepared Submit persisted bytes without rebuilding.
create_api_key_to_funding One-call prepare, sign, and submit.
create_api_key_to_external_chain One-call prepare, sign, and submit.
create_to_funding / create_to_external_chain Advanced precomputed-signature paths.

Wallet-authorized create_wallet_trading_withdraw exists for session/custody products, market makers typically use the payload-signature helpers above.

Prepare, persist, and submit

from pathlib import Path

from polyester import PreparedTradingWithdraw, new_trading_withdraw_idempotency_key

prepared = client.withdraw.prepare_api_key_to_funding(
    asset_id=2,
    quantity="100.00",
    idempotency_key=new_trading_withdraw_idempotency_key(),
)

# Persist before first submission. Protect this record like other mutation state.
Path("withdraw-request.pb").write_bytes(prepared.request_bytes)
result = await client.withdraw.submit_prepared(prepared)

# After restart or an outcome-unknown failure, restore and submit unchanged.
restored = PreparedTradingWithdraw.from_request_bytes(
    Path("withdraw-request.pb").read_bytes()
)
assert restored.deterministic_payload_bytes == prepared.deterministic_payload_bytes
assert restored.payload_signature == prepared.payload_signature
# retry = await client.withdraw.submit_prepared(restored)

deadline_ts_sec and nonce are optional on prepare methods. When omitted, they are generated once during preparation and become part of the persisted signed request. The one-call create_api_key_to_* methods are convenient when the caller does not need durable retry state.

Create to external chain

Requires destination_chain_id and destination_address. Amount is gross (fees taken from it).

from polyester import new_trading_withdraw_idempotency_key

result = await client.withdraw.create_api_key_to_external_chain(
    asset_id=2,
    quantity="50.00",
    destination_chain_id=1,
    destination_address="0x...",
    idempotency_key=new_trading_withdraw_idempotency_key(),
)

Exact amount scaling

The wire field is always amount_e18. amount_scale declares the input scale; the SDK then rescales exactly to 18 with checked overflow and no rounding. For example, AssetAmount.from_scaled(125, scale=2) becomes 1_250_000_000_000_000_000 (1.25e18). An inexact downscale is rejected.

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. 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). Zipper Deposit/withdraw config and related Zipper reads.
Previous

Whiteboard
Next

Zipper