Skip to main content
GET
Returns what one wallet holds of one token inside a custody contract, split into what is free and what is committed to resting orders. Amounts are on-chain base units in the token’s own decimals, not order book units. Convert before comparing against an order’s quantity or price. The contract is read live. If the read fails, the endpoint answers with zeros rather than an error, so a zero balance and an unreachable node look alike. Treat a sudden zero as suspect if the wallet was funded.

Path Parameters

string
required
Custody contract address. Which flavour it is decides how the balance is read, resolved from your instance’s network.
string
required
Wallet to read.
string
required
Token to read. Either side of a pair.

Response Fields

object
Off-chain books hold no custody contract. Balances for off-chain trading live in your instance’s custody ledger and are keyed by customerRef, not by wallet.

Error Codes