Balances

Reading what each account group holds, per currency, and what part of it is free to trade or withdraw.

What each account group holds, per currency, and how much of it is free.

POST /api/3/account

One call returns every account group your credential can see. Unlike most reads, this one is not primarily scoped by accountGroupUuid — omit it and you get them all, each with its own per-currency accounts. Send it to narrow.

Read Account_Groups, not Wallets. The response still carries Wallets and Secondary_Wallets from an earlier shape of this API. They are untyped in source and superseded; everything you need is under Account_Groups.

Request

Sent as a signed body, like every /api/3 call. See making requests.

Field	Type	Required	Notes
`nonce`	string		A counter that must increase with each request. An alternative to `tonce`
`tonce`	string		The current Unix time in microseconds. Send this or `nonce`
`userUuid`	string		The user the credentials act for. Set automatically from the API key; sending it has no effect
`filterZeroBalanceAccounts`	boolean	Optional	Send `true` to leave out accounts holding nothing. Omitted, empty accounts are included
`accountGroupUuid`	string	Optional	Restrict the answer to one account group. Omitted, every group your credential can see is returned

Response

Carries the resultCode, description and timestamp fields common to every /api/3 response.

Field	Type	Notes
`data`	object	The balances, described below. Untyped in source, hence `object`
`userUuid`	string	The user the answer was assembled for

Info

The body of data. Most of it predates this API being used for brokerage and is retained for compatibility.

Field	Type	Notes
`Created`	string	When the account was created
`Id`	string	Your identifier on the platform
`Index`	string	Retained for compatibility. Not meaningful to a client
`Language`	string	The account's configured language
`Last_Login`	string	When it last signed in
`Login`	string	The account's login name
`Monthly_Volume`	string	Traded volume for the current month
`Trade_Fee`	string	The fee rate applied to trades
`Rights`	object	The permissions attached to the credential
`Wallets`	object	Legacy, and untyped in source. Superseded by `Account_Groups` — do not build against it
`Secondary_Wallets`	object	Legacy, on the same terms as `Wallets`
`Account_Groups`	AccountGroupInfo[]	The part to read. One entry per account group, each holding its own per-currency accounts

AccountGroupInfo

One account group and its accounts.

Field	Type	Notes
`AccountGroup_Uuid`	string	What you send as `accountGrpUuid` when subscribing or ordering, and as `accountGroupUuid` on REST reads
`AccountGroup_Name`	string	The group's label, for display
`Owner_Uuid`	string	The entity the group belongs to
`Owner_Name`	string	That entity's name
`Owner_Shortcode`	string	That entity's short code
`Natural`	boolean	Whether the owner is a natural person rather than an organisation
`Accounts`	{ string: AccountInfo }	The group's accounts, keyed by currency code — one entry per currency, not an array

AccountInfo

One currency's account within a group. Every balance is a CurrencyValue.

Field	Type	Notes
`Balance`	CurrencyValue	Everything the account holds, including what is committed elsewhere
`Available_Balance`	CurrencyValue	The part free to withdraw or move. This is the figure to check before a transfer
`Brokerage_Available_Balance`	CurrencyValue	The part committed to brokerage and therefore tradeable. Move funds here with an internal transfer
`Unsettled_Sell_Balance`	CurrencyValue	Sold and not yet settled
`Unsettled_Buy_Balance`	CurrencyValue	Bought and not yet settled
`ccy`	string	The currency this account holds, repeating the key it sits under
`Owner_Uuid`	string	The entity the account belongs to
`Uuid`	string	The account's identifier

CurrencyValue

An amount, rendered several ways. Every field is a string, and value is already rounded to a fixed number of decimal places — 5 for cash currencies, 8 otherwise. Parse value for arithmetic and accept that precision, or use valueInt.

Field	Type	Notes
`displayShort`	string	`display` rounded to two decimal places. Never use it for arithmetic
`valueInt`	string	The same amount scaled to an integer by the currency's decimal places, so no fractional part is lost
`currency`	string	The currency code the amount is in
`display`	string	`value` with thousands separators and the currency appended, for showing to a person
`value`	string	The amount, formatted to the currency's decimal places without grouping. Empty string when there is no amount rather than `0`