Get Address Book

Gets a list of address book addresses.

GET /v1/portfolios/{portfolio_id}/address_book

Get Address Book

cURL

curl --request GET \
  --url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/address_book

200

{
  "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

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.

.NET

var addressBookService = new AddressBookService(client);

var request = new GetPortfolioAddressBookRequest("portfolio_id");

var response = addressBookService.GetPortfolioAddressBook(request);

For more information, please visit the Prime .NET SDK.

Go

addressBookService := addressbook.NewAddressBookService(client)

request := &addressbook.GetAddressBookRequest{
    PortfolioId: "portfolio-id",
}

response, err := addressBookService.GetAddressBook(context.Background(), request)

For more information, please visit the Prime Go SDK.

Python

prime_client = PrimeClient(credentials)

request = GetAddressBookRequest(
        portfolio_id="portfolio_id",
)

response = prime_client.get_address_book(request)

For more information, please visit the Prime Python SDK.

CLI

primectl get-address-book --help

For more information, please visit the Prime CLI.

TS/JS

const addressBooksService = new AddressBooksService(client);

addressBooksService.listAddressBooks({
    portfolioId: 'PORTFOLIO_ID_HERE'
}).then(async (response) => {
    console.log('Address Book: ', response);
})

For more information, please visit the Prime TS 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

Show child attributes

pagination · object · required

Show child attributes