Skip to main content
POST
Retrieve wallet balances

Headers

submitter-id
string
required

Email of API user submitting the request

Example:

"api-maker@zodia.io"

Body

application/json

Request payload to retrieve the balances for a wallet.

walletId
string
required

Id of the wallet

Example:

"ZTEST-NOBENF-W5NZ2XCZMF"

hideZeroBalance
boolean
required

Hide addresses when their balances is 0. (Only available for UTXO wallets.)

Response

OK

address
string
required

Address of the wallet.

Example:

"1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa"

balance
string
required

Fixed-point representation of the balance.

Example:

"100"

currency
string

Display the symbol of the currency when the wallet has multiple associated assets. ( eg. eth wallets that also hold erc 20 )

Example:

"ETH"