Get Address Book

Get Address Book

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

import requests

url = "https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/address_book"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/address_book', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/address_book",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/address_book"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/address_book")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/address_book")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "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",
      "counterparty_id": "<string>"
    }
  ],
  "pagination": {
    "next_cursor": "<string>",
    "sort_direction": "DESC",
    "has_next": true
  }
}

GET

portfolios

{portfolio_id}

address_book

Get Address Book

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

import requests

url = "https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/address_book"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/address_book', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/address_book",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/address_book"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/address_book")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/address_book")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

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

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.

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.

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.

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.

primectl get-address-book --help

For more information, please visit the Prime CLI.

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

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

List Entity Activities

Create Address Book Entry

⌘I

REST API

Websocket Feed

FIX 4.2 API

FIX 5.0 API

Path Parameters

Query Parameters

Response