Skip to main content

Get account balance details

Required scopes:

  • partner.balances.read
Responses
200

OK

Schema — OPTIONAL
object[]
currency string

Possible values: [BTC, USD, EUR, USDT, GBP, AUD]

The currency of the balance

current string

The balance that is currently available for trading (currency conversion). Includes settled and any non spent pending amount. Does not include funds in Stacks.

pending string

The balance of all deposits, in all currencies, that are pending settlement denominated in this currency. This number impacts the available balance and can cause the available balance to be lower than the current balance

outgoing string

The balance currently being withdrawn

reserved string

The balance that is reserved to be spent. E.g. for pending withdrawals, target orders, etc.

available string

The balance that is available to be spent and sent out without any restrictions. Available balance might be lower than the current because of the pending deposits. Does not include funds in Stacks.

total string

The sum of the available and outgoing balance

stacks object[] — OPTIONAL

The account's Stacks. Present on the BTC row only. Funds in Stacks are not included in any other field on this row.

name string

The name that the account owner gave the Stack. It is unique among the account's open Stacks. Treat it as user text.

amount string

The bitcoin held in the Stack, including any that is not settled yet or is locked by a reversal. It is read separately from the other figures on the row, so the two can briefly disagree while funds move.

401

Unauthorized

403

Forbidden