TESTNET
Connect

Authentication

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

use polyester::{Client, Config};

let client = Client::new(Config {
    api_key_id: Some("ak_...".into()),
    api_private_key: Some("...".into()), // 64-char hex from key creation
    default_account_id: Some("...".into()), // Profile → Account ID
    ..Default::default()
})?;
client.wait_for_catalogs().await?;

Environment variables

Read secrets in your process and pass them in:

use std::env;
use polyester::{Client, Config};

let client = Client::new(Config {
    api_key_id: env::var("POLYESTER_API_KEY_ID").ok(),
    api_private_key: env::var("POLYESTER_API_PRIVATE_KEY").ok(),
    default_account_id: env::var("POLYESTER_ACCOUNT_ID").ok(),
    ..Default::default()
})?;

For scripts only, Client::from_env() loads credentials, Account ID, and optional POLYESTER_API_URL / POLYESTER_WS_URL. 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 Optional API base override (from_env)
POLYESTER_WS_URL Optional WebSocket URL override (from_env)

Unlike Python/Go, Rust from_env does load API and WebSocket URL env vars.

Generate a keypair

let pair = client.api_keys.generate_keypair();

Local key material only. Listing and subscribing to keys uses client.api_keys with an API key. Creating API keys is JWT/session-only (TypeScript / browser), not exposed on this SDK.

See API keys.

Configure trading permissions

After creating a key in the Polyester app, open that key's Permissions page:

  1. Enable Spot trading.
  2. Select the markets the bot may trade.
  3. Set the maximum order size and any transfer or withdrawal limits.
  4. Save the policy and confirm it is assigned to the key.

The Rust API-key SDK uses the assigned policy but cannot create or assign one. Policy administration requires an interactive JWT/session.

Public vs private

  • Public market data works with no key.
  • Private RPCs and private WebSocket channels need a key and Account ID.
  • Realtime support is always included. The legacy realtime Cargo feature is a no-op compatibility flag.

Subaccount scope

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

Market data Read candles, public trades, order books, and market overview, no credentials required. Trading Place, modify, cancel, and batch spot orders; use triggers with the Rust SDK. Streaming Subscribe with observable errors, handshake-before-return, fail-closed overflow, and private Account ID requirements. Accounts & balances Funding vs trading balances, holds, subaccounts, policies, and transfer history. Deposits & withdrawals Deposit addresses, trading withdraws, internal transfers, and funding flows. Server-side usage Long-running bots, process lifecycle, catalogs, and configuration tips. Error handling Classify errors with is_retryable and mutation_outcome_unknown, then retry with stable identities. Production trading operations Operate, test, troubleshoot, and upgrade an automated Rust trading system safely.
Previous

Limitations & non-features
Next

Market data