Balances

Subscribe to client asset balances and account ledger transactions

WSSws-auth.kraken.com/v2balances

The balances channel streams client asset balances and transactions from the account ledger.

This channel contains account specific data, an authentication token is required in the request.

Subscribe

Request

method · string · required

Value: subscribe

params · object · required

Hide properties

channel · string · required

Value: balances

snapshot · boolean

One of: true, false
Default: true

Request a snapshot after subscribing.

token · string · required

Authentication token. See authentication guide for details.

rebased · boolean

One of: true, false
Default: true
Condition: Effective for viewing xstocks only

If true, display in terms of underlying equity, otherwise display in terms of SPV tokens.

users · string

One of: all
Condition: Available on master accounts only

If all, events for master and subaccounts are streamed, otherwise only master account events are published. No snapshot is provided.

req_id · integer

Optional client originated request identifier sent as acknowledgment in the response.

Response

method · string · required

Value: subscribe

result · object

Hide properties

channel · string · required

Value: balances

snapshot · boolean

Indicates if a snapshot is requested.

warnings · string[]

An advisory message, highlighting deprecated fields or upcoming changes to the channel.

success · boolean

Indicates if the request was successfully processed by the engine. One of: true, false

error · string

Error message. Condition: if success is false.

time_in · string

The timestamp when the subscription was received on the wire, just prior to parsing data. Format: RFC3339. Example: 2022-12-25T09:30:59.123456Z

time_out · string

The timestamp when the acknowledgement was sent on the wire, just prior to transmitting data. Format: RFC3339. Example: 2022-12-25T09:30:59.123456Z

req_id · integer

Optional client originated request identifier sent as acknowledgment in the response.

Snapshot

The snapshot provides the value of each asset held in this account.

channel · string

Value: balances

type · string

One of: snapshot

data · object[]

A list of assets held on account.

Hide properties

asset · string

The asset symbol code.

asset_class · string

One of: currency

The asset class. A placeholder for future expansion.

balance · float

The total amount of asset held across all wallet types.

wallets · object[]

A list of wallets for each asset.

Hide properties

balance · float

Balance of asset in wallet.

type · string

One of: spot, earn

Wallet type.

id · string

One of: main, flex, bonded, flexible, liquid, locked, closed

Wallet identifier.

sequence · integer

The subscription message sequence number.

Update

An update will be streamed on each completed transaction to the client account.

channel · string

Value: balances

type · string

One of: update

data · object[]

A list of account ledger transactions for each asset.

Hide properties

asset · string

The asset symbol code.

asset_class · string

One of: currency

The asset class. A placeholder for future expansion.

amount · float

The amount of asset change in this event.

balance · float

The total amount of this asset held in account.

fee · float

The fee paid on the transaction.

ledger_id · string

The identifier for this account ledger entry.

ref_id · string

A reference identifier in the context of this balance event. For example, ref_id will be the trade_id for a trade event.

timestamp · string

Format: RFC3339
Example: 2022-12-25T09:30:59.123456Z

The time of the balance change.

type · string

One of: deposit, withdrawal, trade, margin, adjustment, rollover, credit, transfer, settled, staking, sale, reserve, conversion, dividend, reward, creator_fee

The broad type of the balance event.

subtype · string

One of: spotfromfutures, spottofutures, stakingfromspot, spotfromstaking, stakingtospot, spottostaking

The specific subtype of the balance event.

category · string

One of: deposit, withdrawal, trade, margin-trade, margin-settle, margin-conversion, conversion, credit, marginrollover, staking-rewards, instant, equity-trade, airdrop, equity-dividend, reward-bonus, nft, block-trade

The categorization of the balance event.

wallet_type · string

One of: spot, earn

Wallet type.

wallet_id · string

One of: main, bonded, flexible, liquid, locked

Wallet identifier.

The following combinations of wallet types and wallet identifiers are available:

Wallet type spot:

• main: Primary spot pairs trading wallet.

Wallet type earn:

• bonded: earn on-chain product with lockup period.
• flexible: earn product without lockup period.
• liquid: kraken rewards program.
• locked: earn product (may or may not have a lockup period).

user · string

Example: AA96N74GCGEFN8KI
Condition: Published when request parameters have ‘users=all’

The Kraken generated identifier for a user / sub-account.

sequence · integer

The subscription message sequence number.

Unsubscribe

Request

method · string · required

Value: unsubscribe

params · object · required

Hide properties

channel · string · required

Value: balances

token · string · required

Authentication token. See authentication guide for details.

req_id · integer

Optional client originated request identifier sent as acknowledgment in the response.

Response

method · string · required

Value: unsubscribe

result · object

Hide properties

channel · string · required

Value: balances

success · boolean

Indicates if the request was successfully processed by the engine. One of: true, false

error · string

Error message. Condition: if success is false.

time_in · string

The timestamp when the subscription was received on the wire, just prior to parsing data. Format: RFC3339. Example: 2022-12-25T09:30:59.123456Z

time_out · string

The timestamp when the acknowledgement was sent on the wire, just prior to transmitting data. Format: RFC3339. Example: 2022-12-25T09:30:59.123456Z

req_id · integer

Optional client originated request identifier sent as acknowledgment in the response.