Sign in

v3

latestOpenAPI 3.0.02026-07-311784111.3 MB
Wallet
Private

Retrieves the address book entries of the given type. Returns all saved addresses that can be used for withdrawals, along with their labels and beneficiary information if available.

📖 Related Article: Managing Withdrawals

Scope: wallet:read

Try in API console

get/private/get_address_book

Query parameters

currency'BTC' | 'ETH' | 'STETH' | 'ETHW' | 'USDC' | 'USDT' | 'EURR' | 'SOL' | 'XRP' | 'USYC' | 'PAXG' | 'BNB' | 'USDE' required

Currency, i.e "BTC", "ETH", "USDC"

The currency symbol

type'transfer' | 'withdrawal' | 'deposit_source' required

Address book type

Address book type

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

Example response

{
  "result": [
    {
      "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
      "creation_timestamp": 1536569522277,
      "label": "Main address",
      "beneficiary_vasp_name": "Money's Gone",
      "beneficiary_vasp_did": "did:example:123456789abcdefghi",
      "beneficiary_first_name": "John",
      "beneficiary_last_name": "Doe",
      "beneficiary_company_name": "Company Name",
      "beneficiary_address": "NL, Amsterdam, Street, 1",
      "agreed": true,
      "personal": true,
      "info_required": true,
      "waiting_timestamp": true,
      "requires_confirmation": true,
      "requires_confirmation_change": true
    }
  ]
}