Account Data

Get Extended Balance

Retrieve all extended account balances, including credits and held amounts. Balance available for trading is calculated as: available balance = balance + credit - credit_used - hold_trade

Note that held amounts only include spot non margin orders.

Note on Staking/Earn assets: We have begun to migrate assets from our legacy Staking system over to a new Earn system. As such, the following assets may appear in your balances and ledger. Please see our Support article for more details. Note that these assets are "read-only", to interact with your balances in them please use the base asset (e.g. USDT to transact with your USDT and USDT.F balances).

Symbol Extensions:

  • .B: balances in new yield-bearing products, similar to .S (staked) and .M (opt-in rewards) balances
  • .F: balances earning automatically in Kraken Rewards
  • .T: tokenized assets.

API Key Permissions Required: Funds permissions - Query

post/private/BalanceEx

Request

  • Base URL: https://api.kraken.com/0
  • URL: https://api.kraken.com/0/private/BalanceEx
  • Auth: API key in header API-Key and API key in header API-Sign

Query parameters

account_idstring

Public wallet account ID. Omit to use the authenticated user's default wallet. See List Wallet Accounts.

Request body

nonceinteger required

Nonce used in construction of API-Sign header

rebase_multiplier'rebased' | 'base' nullable

Optional parameter for viewing xStocks data.

  • rebased: Display in terms of underlying equity.
  • base: Display in terms of SPV tokens.

Response

Extended account balances retrieved.

resultobject

Extended balances keyed by asset. An empty object is returned when the account holds no assets.

errorstring[]

Example response

{
  "error": [
    "EGeneral:Invalid arguments"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.