Skip to main content
GET
MCP scope: dac.read The List Addresses endpoint returns all deposit addresses generated for a given asset in your sub-account. Each record includes the address string, its label, omnibus flag, auto-refill setting, and current balances. Pass the optional index, address, or label query parameters to narrow the response.

Query Parameters

string
required
The asset name for which to list addresses (e.g. BTC, ETH). Must match a value from the Supported Assets list.
string
Optional. Filter the response to the address at this index (e.g. 0).
string
Optional. Filter the response to a single address. When provided, the API returns only the record matching this exact address string.
string
Optional. Filter the response by address label.

Response

A successful request returns HTTP 200 with an array of address objects.
integer
Index of the address within the wallet. The main address has index 0.
string
The blockchain deposit address string.
string
The same address in legacy format, where applicable (e.g. a 1... address for BTC).
string
Destination tag or memo associated with the address, where applicable (e.g. XRP, XLM). Empty string when not used.
string
The human-readable label assigned to this address.
boolean
true if this address belongs to the shared omnibus pool; false if it is an isolated address.
boolean
true if gas is automatically funded from the Gas Tank when the address balance is insufficient.
number
Current asset balance held at this address, in the asset’s native unit.
number
Unconfirmed balance from incoming transactions not yet confirmed on-chain.
number
Frozen balance at this address.
boolean
Whether the address is frozen.
boolean
Whether the address is blacklisted.
boolean
Whether the address balance is considered dust.