Skip to main content
GET
Returns what one wallet can actually trade of one token, in that token’s base units. Nothing is escrowed on this venue, so these are not custody holdings. For the security they describe the holder’s own unfrozen balance; for the settlement asset they describe the lesser of balance and the allowance granted to the custody contract. Both are then reduced by everything this venue has reserved against the wallet’s own resting orders. That last subtraction is the point. The chain cannot see an off-chain reservation, so publishing the raw number would overstate inventory by exactly the trader’s own quotes and then refuse their next order. This endpoint answers with the same figure the order gate uses.

Path Parameters

string
required
Custody contract address. Use the address from Get Custody Contract.
string
required
Wallet to read.
string
required
Token to read. Either side of a pair.

Response Fields

object
A read that fails answers with zeros rather than an error. Treat an unexpected zero as suspect if the wallet is known to be funded, and use Get Trade Readiness, which surfaces a chain failure explicitly.

Error Codes