GET
/
address-book
Get address book
curl --request GET \
  --url https://api.exchange.coinbase.com/address-book \
  --header 'cb-access-key: <api-key>' \
  --header 'cb-access-passphrase: <api-key>' \
  --header 'cb-access-sign: <api-key>' \
  --header 'cb-access-timestamp: <api-key>'
[
  {
    "id": "e9c483b8-c502-11ec-9d64-0242ac120002",
    "address": "1JmYrFBLMSCLBwoL87gdQ5Qc9MLvb2egKk",
    "currency": "ETH",
    "label": "my wallet",
    "address_book_added_at": "2019-02-06T22:27:50.221Z",
    "is_verified_self_hosted_wallet": false,
    "business_name": "Example Business",
    "business_country_code": "US"
  }
]

Authorizations

​
cb-access-key
string
header
required
​
cb-access-passphrase
string
header
required
​
cb-access-sign
string
header
required
​
cb-access-timestamp
string
header
required

Response

​
id
string
required
​
address
string
required
​
currency
string
required

Asset symbol for the saved address (e.g., BTC, ETH, USDC). _ALL_ASSETS_ indicates that this address is stored globally for all assets, rather than a specific one. The network field determines which blockchain network the address applies to.

​
label
string
required
​
address_book_added_at
string<date-time>
required
​
destination_tag
string
​
is_verified_self_hosted_wallet
boolean

Flag to indicate if the crypto addresses has previously been digitally signed and verified when added in the Address Book UI tab

​
vasp_id
string

The VASP identifier if the address is owned by one of the supported Virtual Asset Service Providers

​
business_name
string

Business name of the originator's account - only populated for travel rules regions

​
business_country_code
string

The country code (ISO 3166-1 alpha-2) of the originator's account location - only populated for travel rules regions

​
network
string

Blockchain network of the address. If null or not provided, the address is available on all supported networks compatible with the asset (e.g., both ethereum and arbitrum for an ERC-20 token).