TESTNET
Connect

ledger.read.v1.LedgerReadService

GetBalances

Retrieve the latest balances for an account. Supports optional subaccount scoping and returns asset symbols with decimal amounts on REST.

POST
ledger.read.v1.LedgerReadService/GetBalances

Request

Testnet 
curl --request POST \ \
  --url 'https://api.testnet.polyester.com/ledger.read.v1.LedgerReadService/GetBalances' \
  --header 'Content-Type: application/json' \
  --header 'Connect-Protocol-Version: 1' \
  --data '{
  "subaccountId": "6789012345678"
}'

Responses

{
  "balances": [
    {
      "assetId": 100,
      "available": {
        "hi": "1",
        "lo": "1"
      },
      "funding": {
        "hi": "1",
        "lo": "1"
      },
      "fundingRevision": "1",
      "reserved": {
        "hi": "1",
        "lo": "1"
      },
      "trading": {
        "hi": "1",
        "lo": "1"
      },
      "tradingRevision": "1"
    }
  ]
}
Request
ledger.read.v1.GetBalancesRequest
Response
ledger.read.v1.GetBalancesResponse
subaccountId string (fixed64)

Optional public subaccount ID. When omitted, subaccount-scoped API keys use their bound subaccount; other callers use their authenticated root account.

7 fields
Possible errors: 30
KeyHTTP statusConnect codeErrorWhen
api-key-action-deny403permission_deniedAPI Key Policy DeniedAPI key policy does not allow this read action.
api-key-policy-not-found403permission_deniedAPI Key Policy Not FoundAPI key policy was not found.
api-key-policy-required403permission_deniedAPI Key Policy RequiredAPI key policy is required for ledger reads.
api-key-root-scope-only403permission_deniedAPI Key Root Scope OnlyThis API key is scoped to the root account and cannot read sub-accounts.
api-key-subaccount-mismatch403permission_deniedAPI Key Sub-account MismatchThis API key is bound to a different sub-account.
api-key-unknown403permission_deniedAPI Key UnknownThe authenticated API key has no metadata entry in the API key store.
auth-authentication-required401unauthenticatedAuthentication RequiredAuthentication is required.
auth-session-kind-not-allowed403permission_deniedInteractive Session RequiredThis read accepts only an interactive session; API keys are refused.
bad-request400invalid_argumentBad Request—
invalid-account-id400invalid_argumentInvalid Account ID—
invalid-argument400invalid_argumentBad Request—
invalid-subaccount-id400invalid_argumentInvalid Sub-account ID—
ip-not-allowed401unauthenticatedAPI Key IP Not AllowedAPI key is not authorized from this IP address.
key-disabled401unauthenticatedAPI Key DisabledAPI key is disabled.
key-expired401unauthenticatedAPI Key ExpiredAPI key has expired.
missing-account-id400invalid_argumentMissing Account ID—
missing-headers400invalid_argumentMissing API Key HeadersMissing required API key authentication headers.
missing-wallet400invalid_argumentMissing Wallet—
not-found404not_foundNot Found—
permission-denied403permission_deniedPermission Denied—
role-action-deny403permission_deniedRole DeniedYour role does not allow this read action.
server-error500internalServer Error—
signature-invalid401unauthenticatedInvalid API Key SignatureAPI key signature is invalid.
subaccount-policy-deny403permission_deniedSub-account Policy DeniedSub-account policy does not allow this read action.
subaccount-read-forbidden403permission_deniedSub-account Read ForbiddenYou do not have permission to read this sub-account.
timestamp-skew400invalid_argumentAPI Key Timestamp SkewAPI key timestamp is outside the allowed skew window.
unauthenticated401unauthenticatedUnauthenticatedLedger reads require a valid bearer JWT or signed API-key request.
upstream-error502unavailableUpstream Error—
wallet-not-found404not_foundWallet Not Found—
wallet-resolution-unavailable502unavailableWallet Resolution Unavailable—