REST API
curl --request POST \
--url https://api.exchange.coinbase.com/address-book \
--header 'Content-Type: application/json' \
--header 'cb-access-key: <api-key>' \
--header 'cb-access-passphrase: <api-key>' \
--header 'cb-access-sign: <api-key>' \
--header 'cb-access-timestamp: <api-key>' \
--data '
{
"addresses": [
{
"label": "my wallet",
"to": {
"address": "1JmYrFBLMSCLBwoL87gdQ5Qc9MLvb2egKk"
},
"currency": "BTC"
},
{
"label": "my XRP wallet",
"to": {
"address": "rEb8TK3gBgk5auZkwc6sHnwrGVJH8DuaLh",
"destination_tag": "123"
},
"currency": "XRP"
}
]
}
'{
"body": [
{
"id": "1",
"address": "1JmYrFBLMSCLBwoL87gdQ5Qc9MLvb2egKk",
"display_address": "1JmYrFBLMSCLBwoL87gdQ5Qc9MLvb2egKk",
"address_info": {
"address": "1JmYrFBLMSCLBwoL87gdQ5Qc9MLvb2egKk",
"display_address": "1JmYrFBLMSCLBwoL87gdQ5Qc9MLvb2egKk"
},
"currency": "BTC",
"label": "my wallet",
"address_booked": true,
"address_book_added_at": "2019-02-06T22:27:50.221Z"
}
]
}Add addresses
Add new addresses to address book
curl --request POST \
--url https://api.exchange.coinbase.com/address-book \
--header 'Content-Type: application/json' \
--header 'cb-access-key: <api-key>' \
--header 'cb-access-passphrase: <api-key>' \
--header 'cb-access-sign: <api-key>' \
--header 'cb-access-timestamp: <api-key>' \
--data '
{
"addresses": [
{
"label": "my wallet",
"to": {
"address": "1JmYrFBLMSCLBwoL87gdQ5Qc9MLvb2egKk"
},
"currency": "BTC"
},
{
"label": "my XRP wallet",
"to": {
"address": "rEb8TK3gBgk5auZkwc6sHnwrGVJH8DuaLh",
"destination_tag": "123"
},
"currency": "XRP"
}
]
}
'{
"body": [
{
"id": "1",
"address": "1JmYrFBLMSCLBwoL87gdQ5Qc9MLvb2egKk",
"display_address": "1JmYrFBLMSCLBwoL87gdQ5Qc9MLvb2egKk",
"address_info": {
"address": "1JmYrFBLMSCLBwoL87gdQ5Qc9MLvb2egKk",
"display_address": "1JmYrFBLMSCLBwoL87gdQ5Qc9MLvb2egKk"
},
"currency": "BTC",
"label": "my wallet",
"address_booked": true,
"address_book_added_at": "2019-02-06T22:27:50.221Z"
}
]
}Authorizations
Body
List of addresses to add to the address book
Show child attributes
Show child attributes
Asset symbol for the saved address (e.g., BTC, ETH, USDC). Use _ALL_ASSETS_ to indicate that this address is stored globally for all assets, rather than a specific one. When currency is set to _ALL_ASSETS_, the network field is required to define the applicable blockchain network.
Label/nickname for address book entry
Flag indicating whether the crypto address was digitally signed and verified when added in the Address Book UI. This is mandatory for crypto withdrawals in jurisdictions governed by travel rules.
VASP identifier for addresses owned by supported Virtual Asset Service Providers. Required for crypto withdrawals in jurisdictions governed by travel rules.
Coinbase, Anchorage, Balance, bitFlyer, BitGo, Bittrex, Circle, Coinhako, Fidelity, Gemini, Kraken, Paxos, PayPal, Robinhood, Shakepay, Standard Custody, Tradestation, Zero Hash Business name
The country code (ISO 3166-1 alpha-2) of the originator's account location.
Flag to indicate if the user owns the crypto address
Blockchain network of the address. If null or not provided, the address will be available on all supported networks compatible with the asset (e.g., both ethereum and arbitrum for an ERC-20 token). When currency is set to _ALL_ASSETS_, the network field is required to define the applicable blockchain network.
Blockchain network used to verify ownership of the wallet address. Required for self-hosted wallets in jurisdictions governed by travel rules.
Response
A successful response.
Show child attributes
Show child attributes
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.
Flag to indicate if the crypto addresses has previously been digitally signed and verified when added in the Address Book UI tab
The VASP identifier if the address is owned by one of the supported Virtual Asset Service Providers
Business name of the originator's account
The country code (ISO 3166-1 alpha-2) of the originator's account location.
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).
Was this page helpful?