Skip to main content
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 balance. Pass the optional address query parameter to narrow the response to a single address — useful for checking the state of a specific deposit destination.

​
Request

​
string
required
Your Finrock API key.
​
string
required
Your JWT bearer token in the format Bearer {JWT}.
​
string
required
The asset name for which to list addresses (e.g. ETH, BTC). Must match a value from the Supported Assets list.
​
string
Optional. Filter the response to a single address. When provided, the API returns only the record matching this exact address string.

​
Example Request

cURL

​
Response

A successful request returns HTTP 200 with an array of address objects. When the address filter is applied, the array contains at most one element.
​
string
The blockchain deposit address string.
​
string
Destination tag or memo associated with the address, where applicable (e.g. XRP, XLM).
​
string
The human-readable label assigned to this address at creation time.
​
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.
Sample 200 Response
​
object
Returned when the x-api-key or Authorization header is missing or invalid.
Sample 401 Response