Request
string
required
Your Finrock API key.
string
required
Your JWT bearer token in the format
Bearer {JWT}.string
required
The asset for which to generate an address. Use the
asset_name value from the Supported Assets list (e.g. ETH, BTC, USDT_ETH).string
required
A descriptive label that identifies the purpose of this address (e.g.
customer-42, hot-wallet, treasury). Labels make it easier to reconcile deposits without storing raw addresses in your system.boolean
default:"false"
Determines whether this address is part of the shared omnibus pool.
false— creates an isolated address; funds stay at this address until explicitly swept.true— creates an omnibus address; incoming funds are pooled with other omnibus deposits.
boolean
default:"false"
When set to
true, Finrock automatically tops up this address with gas from your Gas Tank whenever the native token balance is too low to cover transaction fees. This is always true for omnibus addresses.Example Request
cURL
Response
A successful request returns HTTP200 with the newly generated address object.
string
The newly generated blockchain deposit address.
string
Destination tag or memo for the address, populated only for assets that require one (e.g. XRP, XLM).
null for most assets.string
The label you provided at creation time.
boolean
true if this address was added to the omnibus pool; false if it is isolated.boolean
true if automatic gas refilling from the Gas Tank is enabled.Sample 200 Response
object
Returned when the
x-api-key or Authorization header is missing or invalid.Sample 401 Response