TESTNET
Connect

Balances

client.Balances reads ledger balances. Amounts are already scaled integer decimal strings (ledger u128). Format once for display with codecs.FormatLedgerU128(raw, codecs.LedgerScale) (scale 18). Do not multiply by 1e18 again.

Methods

Method Signature notes
List List(ctx, account, subAccountID)
GetBalanceHistory range key + optional account codes
GetEquityHistory range + groupBy
ListHolds limit + reversed
Subscribe private stream → Messages()

List

Unlike TypeScript/Python request objects, Go takes explicit scope args:

import "github.com/Fabric-Labs/polyester-sdk-go/codecs"

list, err := client.Balances.List(ctx, nil, nil)
if err != nil { log.Fatal(err) }
for _, b := range list.Balances {
    available, err := codecs.FormatLedgerU128(b.Available, codecs.LedgerScale)
    if err != nil { log.Fatal(err) }
    trading, err := codecs.FormatLedgerU128(b.Trading, codecs.LedgerScale)
    if err != nil { log.Fatal(err) }
    funding, err := codecs.FormatLedgerU128(b.Funding, codecs.LedgerScale)
    if err != nil { log.Fatal(err) }
    fmt.Println(b.AssetID, available, trading, funding)
}

subID := "123"
subList, err := client.Balances.List(ctx, nil, &subID)

AssetBalance fields: AssetID, Trading, Funding, Reserved, Available, TradingRevision, FundingRevision.

History / holds

hist, err := client.Balances.GetBalanceHistory(ctx, nil, "30d", nil, 0, nil)
eq, err := client.Balances.GetEquityHistory(ctx, nil, "90d", nil, nil, "asset")
holds, err := client.Balances.ListHolds(ctx, nil, nil, 50, false)

Ranges: 1d, 7d, 30d, 90d, 180d, 365d. groupBy: "account" or "asset". BalanceHistorySeries.BalanceQ is []uint64, matching the unsigned protobuf field across its full range. AccountCode is the raw signed int32 enum value, so an unknown future code cannot wrap into a large unsigned value.

ListHolds may be unmounted in a given environment. In that case the SDK returns *errors.RouteNotFoundError; do not classify that deployment routing state as an empty holds list or an SDK decode failure.

Subscribe

sub, err := client.Balances.Subscribe(ctx, accountID)
defer sub.Close()
for bal := range sub.Messages() {
    available, err := codecs.FormatLedgerU128(bal.Available, codecs.LedgerScale)
    if err != nil { log.Fatal(err) }
    fmt.Println(bal.AssetID, available)
    break
}
if err := sub.Err(); err != nil { log.Printf("balance stream ended: %v", err) }
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. Candles Read and stream public spot OHLCV candles via MarketData (Candles alias). Catalog Spot/Zipper catalog hydration via HydrateCatalogs and WaitForCatalogs, plus Manager lookups. Chain helpers On-chain Funding → Trading and Funding withdraw helpers. Chain analytics Chain analytics read APIs. Client configuration Config fields, URLs, catalogs, wire format, and FromEnv behavior. Deposit Create and list per-account chain deposit addresses for funding your Polyester account. Errors Go SDK error types, sentinel ErrPolyester, MFA auth codes, and queue overflow. Guard signer Guard signer approval helpers. Heatmap L2 order book heatmap reads. Internal transfers Move trading balances between Polyester accounts without touching a chain. Layout Layout collaboration APIs (reference-only). 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 Go OrdersService. Policies Realtime API-key and subaccount-policy updates. Polychart Polychart collaboration APIs (reference-only). Profile Profile identity reads and subscribe helpers. Public trades Public trade tape reads and subscribe via MarketData. Realtime Shared Centrifugo client, Messages() delivery, 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 trigger automations with the Go TriggersService. Whiteboard Whiteboard collaboration APIs (reference-only). Withdrawals Trading withdraw intents to funding or external chain destinations (signed payload). Zipper Deposit/withdraw config and related Zipper reads.
Previous

Auth
Next

Candles