TESTNET
Connect

Client configuration

Build a client with Client::new(Config { ... }). Always pass POLYESTER_TESTNET_ENVIRONMENT on environment, because an unset environment does not target testnet; other defaults suit API-key trading applications. Unary ConnectRPC responses are limited to 4 MiB after decompression.

use polyester::{Client, Config};

let client = Client::new(Config {
    environment: Some(polyester::POLYESTER_TESTNET_ENVIRONMENT.clone()),
    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
    // api_url / ws_url come from environment (api.testnet.polyester.com)
    // hydrate_catalogs: true,
    // timeout: Duration::from_secs(10),
    ..Default::default()
})?;
client.wait_for_catalogs().await?;

Config fields

  • environment: API, WebSocket, RPC, and contract pins. Pass Some(POLYESTER_TESTNET_ENVIRONMENT.clone()).
  • api_key_id / api_private_key: Required for private RPCs / private WS. Default: None.
  • api_url: ConnectRPC base override. Default: from environment (https://api.testnet.polyester.com).
  • ws_url: Centrifugo WebSocket override. Default: from environment (wss://api.testnet.polyester.com).
  • default_account_id: Private channel scoping. Default: None.
  • default_sub_account_id: Default trading scope. Default: None.
  • timeout: Connect and realtime-token deadline. Default: 10s.
  • wire_format: Transport wire format. Default: binary.
  • hydrate_catalogs: Fail-closed spot + Zipper hydrate. Default: true.
  • allow_insecure_http: Allow remote http:// / ws://. Default: false.

default_sub_account_id is the client configuration field and must reuse the canonical public base58 string returned by subaccount APIs. Canonical base58 can be all digits, such as "5", so never reinterpret the string as decimal. Use a numeric subaccount_id only in request or proto fields that are actually typed as an integer and only when you already have that typed value. An explicit sub-account ID of 0 (subaccount_id: Some(0) in any params, options or request, or sub_accounts.get(0, ..)) returns Error::Validation before sending, because 0 on the wire means no sub-account. Pass None to act on the main account, or on default_sub_account_id where a method applies the configured default. The root default_account_id is a different string identifier used for private realtime channels.

Config.api_key_id is the ak_... credential handle used for request signing. It is not the base58 public ID reported by auth.me().api_key_id; do not compare or substitute those values.

There is no client.candles alias, use client.market_data. Withdraw lives on client.withdraw.

From environment

Client::from_env() loads:

  • POLYESTER_API_KEY_ID
  • POLYESTER_API_PRIVATE_KEY
  • POLYESTER_ACCOUNT_ID
  • POLYESTER_ENV (always set it to testnet)
  • POLYESTER_API_URL (optional override)
  • POLYESTER_WS_URL (optional override)

Prefer explicit Config in production.

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 List ledger balances via GetBalancesRequest, read held amounts and history, and subscribe to private updates. Candles Read and stream public spot OHLCV candles via market_data. Catalog Spot/Zipper catalog hydration with hydrate_catalogs and wait_for_catalogs. Chain helpers On-chain Funding → Trading and Funding withdraw helpers. Chain analytics Chain analytics read APIs. Deposit Create and list per-account chain deposit addresses for funding your Polyester account. Errors Rust Error enum variants, API-key refusals, MFA auth codes, and queue overflow. Fees Read effective, reserve, and post-only reserve spot fee rates with the Rust FeeService. Guard signer Guard signer approval helpers. Heatmap L2 order book heatmap reads. Internal transfers Move trading balances between Polyester accounts without touching a chain. 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 the Rust OrdersService. Policies Realtime API-key and subaccount-policy updates. Profile Profile identity reads and subscribe helpers. Public trades Public trade tape reads and subscribe via market_data. Realtime Shared Centrifugo client, observable failures, 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 triggers with the Rust TriggersService. Withdrawals Trading withdraw intents to funding or external chain destinations (signed payload). Zipper Deposit/withdraw config and related Zipper reads.
Previous

Chain analytics
Next

Deposit