Skip to main content
GET
/
v1
/
portfolios
/
{portfolio_id}
/
address_book
Get Address Book
curl --request GET \
  --url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/address_book
{
  "addresses": [
    {
      "id": "<string>",
      "name": "<string>",
      "state": "<string>",
      "added_by": {
        "id": "<string>",
        "name": "<string>",
        "avatar_url": "<string>"
      },
      "currency_symbol": "<string>",
      "address": "<string>",
      "account_identifier": "<string>",
      "account_identifier_name": "<string>",
      "explorer_link": "<string>",
      "last_used_at": "2023-11-07T05:31:56Z",
      "added_at": "2023-11-07T05:31:56Z",
      "type": "ADDRESS_BOOK_TYPE_UNSPECIFIED",
      "counterparty_id": "<string>"
    }
  ],
  "pagination": {
    "next_cursor": "<string>",
    "sort_direction": "DESC",
    "has_next": true
  }
}
Use the Prime SDK or CLI to test this endpoint by following the quickstart guide and running with the following examples
  • Java
  • .NET
  • Go
  • Python
  • CLI
  • TS/JS
AddressBookService addressBookService = PrimeServiceFactory.createAddressBookService(client);

GetPortfolioAddressBookRequest request = new GetPortfolioAddressBookRequest.Builder("portfolio_id").build();

GetPortfolioAddressBookResponse response = addressBookService.getAddressBook(request);
For more information, please visit the Prime Java SDK.

Path Parameters

​
portfolio_id
string
required

Portfolio ID

Query Parameters

​
currency_symbol
string

Cryptocurrency symbol -- if nothing is passed, all addresses are returned

​
search
string

Query string that matches the address name

​
cursor
string

ID marking the point after which additional results should be retrieved

​
limit
integer<int32>

Number of addresses to retrieve

​
sort_direction
enum<string>
default:DESC

Sorting order

Available options:
DESC,
ASC

Response

200 - application/json

A successful response.

​
addresses
object[]
required

List of addresses added to Address Book

​
pagination
object
required