TESTNET
Connect

Authentication

Programmatic access uses Ed25519 API keys. The SDK signs authenticated ConnectRPC requests and fetches private realtime tokens for you.

from polyester import AsyncPolyester

async with AsyncPolyester(
    api_key_id="ak_...",
    api_private_key="...",  # 64-char hex from key creation
    default_account_id="...",  # Profile → Account ID
) as client:
    await client.wait_for_catalogs()

Environment variables

Read secrets in your process and pass them in:

import os
from polyester import AsyncPolyester

client = AsyncPolyester(
    api_key_id=os.environ["POLYESTER_API_KEY_ID"],
    api_private_key=os.environ["POLYESTER_API_PRIVATE_KEY"],
    default_account_id=os.environ["POLYESTER_ACCOUNT_ID"],
)

For scripts only, AsyncPolyester.from_env() / Polyester.from_env() load credentials and Account ID. They do not load API/WebSocket URL overrides, pass api_url / ws_url to the constructor. Prefer explicit config in production.

Variable Purpose
POLYESTER_API_KEY_ID API key id
POLYESTER_API_PRIVATE_KEY 64-char hex private key
POLYESTER_ACCOUNT_ID Profile Account ID
POLYESTER_API_URL / POLYESTER_WS_URL Not loaded by from_env, pass constructor kwargs

Generate a keypair

pair = client.api_keys.generate_keypair()
# pair.public_key_hex / pair.secret_key_hex, persist secret yourself

Local key material only via generate_keypair(). Listing and subscribing use client.api_keys. Creating API keys is JWT/session-only (TypeScript / browser), not exposed on this SDK. See API keys.

Public vs private

  • Public market data works with no key.
  • Private RPCs and private WebSocket channels need a key and Account ID.

Subaccount scope

Set default_sub_account_id for default scoping, or pass per-call account / sub_account_id where the service supports it.

Concept: Authentication model. Config: Client configuration.

Market data Read candles, public trades, order books, and market overview, no credentials required. Trading Place, modify, cancel, and batch spot orders; use triggers and risk attachments. Streaming Subscribe to public and private WebSocket Protobuf channels with async iterators, handshake-before-return, and fail-closed overflow. Accounts & balances Funding vs trading balances, holds, subaccounts, policies, and transfer history. Deposits & withdrawals Deposit addresses, trading withdraws, internal transfers, lifecycle, and chain helpers. Server-side usage Long-running bots, process lifecycle, catalogs, and configuration tips. Error handling Classify failures, retry safely with idempotency keys, and handle realtime overflow. Production trading operations Operate, test, troubleshoot, and upgrade an automated Python trading system safely.
Previous

Limitations & non-features
Next

Market data