Get Extended Balance

POST 
/private/BalanceEx

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 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).

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

API Key Permissions Required: Funds permissions - Query

Request

application/json

Body

required

nonce int64required

Nonce used in construction of API-Sign header

Responses

200

Extended account balances retrieved.

application/json

Schema

Schema

result object

Extended Balance

asset object

Extended Balance

balance string

Total balance amount for an asset

credit string

Total credit amount (only applicable if account has a credit line)

credit_used string

Used credit amount (only applicable if account has a credit line)

hold_trade string

Total held amount for an asset

error string[]

Example (from schema)

{
  "error": [],
  "result": {
    "ZUSD": {
      "balance": 25435.21,
      "hold_trade": 8249.76
    },
    "XXBT": {
      "balance": 1.2435,
      "hold_trade": 0.8423
    }
  }
}

Loading...