Hyperscale docs Sign in Start building

Retrieve an account balance

account.balance.retrieve

Reads the account's live posted and pending counters from the ledger and returns settled and available balances without persisting balance truth outside the ledger.

GET /v1/accounts/{accountId}/balance

Scopes: account:read

Input

FieldTypeDescription
accountId requiredstringHyperscale account ID
productIdstringHyperscale product ID

Request sample

curl --request GET 'https://console.hyperscale0.ai/v1/accounts/{accountId}/balance' \
  --header "Authorization: Bearer $HYPERSCALE_API_KEY" \
  --header 'X-Hyperscale-Environment: sandbox'

All operations