Client configuration

Build a client with Client::new(Config { ... }). Defaults target API-key trading applications on devnet. Unary ConnectRPC responses are limited to 4 MiB after decompression.

Recommended constructor

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
    // api_url / ws_url default to api-devnet.polyester.ai
    // hydrate_catalogs: true,
    // timeout: Duration::from_secs(10),
    ..Default::default()
})?;
client.wait_for_catalogs().await?;

Config fields

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. 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_API_URL (optional override)
• POLYESTER_WS_URL (optional override)

Unlike Python/Go from_env / FromEnv, Rust does pick up API and WebSocket URL env vars. Prefer explicit Config in production.

Related

• Authentication
• Catalog
• Realtime

Related Topics