Add, view, and remove your withdrawal addresses. If enabled, add, view, and remove source addresses so only funds originating from them are credited to your account.
Headers
All requests will require the following headers
Name
Type
Description
x-api-key*
String
{{x-api-key}}
API Auth Key
x-signature*
String
Signature created using your API secret
x-nonce*
String
Timestamp in millisecond
Add Crypto Address
Add a crypto address to your address book. This endpoint is used for adding the client's withdrawal address.
If enabled for the feature, it can also be used to add a source address (the origin address from where the funds are coming from). When a source address is designated, only funds originating from that specific address will be credited to the client.
POSThttps://api.aquanow.io/users/v2/addressBook
Payload
Parmeter Name
Data Type
Required?
Description
currencyType
string
required
Must be “crypto”; specifies that this is a crypto address entry.
currency
string
optional
Crypto currency (e.g. “BTC”). If omitted, the address applies to all currencies supported on the specified network;
networkSymbol
string
required
Network identifier for the address
address
string
required
Destination/source address string.
addressTagMemo
string
optional
Tag/memo if supported by the network (e.g., destination tag for XRP, memo for XLM).
externalReferenceId
string
optional
Client-defined reference/alias for the saved address.
acceptTerms
boolean
required
Must be true; confirms legal and beneficial ownership/control.
addressType
array
required
Array of values: "sourceAddress", "withdrawalAddress". Indicates usage for incoming funds, withdrawals, or both.
walletType
string
required
One of: “SELF_HOSTED”, “VASP”, “OTHER_VASP”. Where the wallet is hosted.
Fetch a list of all addresses matching the query parameters. If currencyType is not specified, it will fetch Bank Instructions and Crypto Addresses.
Query Parameters
Parameter Name
Data Type
Required?
currencyType
string
optional
currency
string
optional
network
string
optional
address
string
optional
addressTagMemo
string
optional
addressType
string
optional
externalReferenceId
string
optional
addressBookId
string
optional
Examples
Filter by the unique identifier addressBookId
GET https://api.aquanow.io/users/v2/addressBook??addressBookId={addressBookId}
Response
Filter by addressType
GET https://api.aquanow.io/users/v2/addressBook?addressType=sourceAddress
Filter by multiple query search parameters
GET https://api.aquanow.io/users/v2/addressBook?addressType=sourceAddress¤cy=ALL&networkSymbol=SOL
Note: When querying by currency , it will also return addresses that support all currencies in that network. Some addresses returned will have currency: ALLFor example: GET https://api.aquanow.io/users/v2/addressBook?addressType=sourceAddress¤cy=ETH