TESTNET
Connect

Accounts & balances

Use client.balances and account-scoped services to reconcile funding, trading, held amounts, and subaccount state.

Funding vs trading

Ledger balances have separate funding and trading buckets per asset.

  • An external deposit can stop in funding or continue to trading, depending on its route
  • Spot orders spend trading
  • Move funding → trading on-chain (or via the Polyester UI), not through a ConnectRPC balance call

Rust balances takes an explicit GetBalancesRequest (not keyword-only args).

use polyester::proto::ledger::read::v1::GetBalancesRequest;

let balances = client.balances.list(GetBalancesRequest::default()).await?;
for b in &balances.balances {
    println!(
        "{} funding={} trading={}",
        b.asset_id,
        polyester::codecs::scalars::format_ledger_u128(&b.funding, 18)?,
        polyester::codecs::scalars::format_ledger_u128(&b.trading, 18)?,
    );
}

These fields are raw ledger u128 strings at ledger scale 18. Format once for display and retain the raw strings for exact accounting.

Held amounts come from each Asset's reserved balance in client.balances.list (GetBalances). Individual hold IDs and expiry times have no replacement.

Also: history helpers and balances.subscribe (recv_result()). See Balances.

Account scope

Set default_sub_account_id / default_account_id on Config, or pass per-call ids where the service accepts them. Private streams need Account ID.

Subaccounts & policies

The SDK exposes subaccount reads plus private subaccount streams. client.policies is subscribe-only. Create/update/delete and membership or policy administration require the Polyester app/TypeScript session client.

A subaccount-scoped API key also needs its own attached API-key policy. Permit ledger reads for balance reads/streams and add the required trading actions for mutations. The API-key policy and subaccount policy are distinct and both constrain the request.

Profile & API keys

client.auth and client.api_keys cover identity and key metadata. Key-metadata reads (list, get) need an interactive session and refuse an API key with Error::SessionRequired; the private administration stream works with an API key that has the API-key administration permission. Creating keys is JWT/session-only.

Transfer history

client.transfers (and balances list helpers where exposed) for history. Mutations: Deposits & withdrawals.

Authentication Configure Ed25519 API keys, Account ID, and env-based wiring for bots. 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. 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

Streaming
Next

Deposits & withdrawals