Create Address Book Entry

POST

portfolios

{portfolio_id}

address_book

curl --request POST \
  --url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/address_book \
  --header 'Content-Type: application/json' \
  --data '{
  "address": "<string>",
  "currency_symbol": "<string>",
  "name": "<string>",
  "account_identifier": "<string>"
}'

{
  "activity_type": "ACTIVITY_TYPE_UNKNOWN",
  "num_approvals_remaining": 123,
  "activity_id": "<string>"
}

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);

CreateAddressBookEntryRequest request = new CreateAddressBookEntryRequest.Builder("portfolio_id")
        .accountIdentifier("account_identifier")
        .address("address")
        .currencySymbol("currency_symbol")
        .name("name")
        .build();

CreateAddressBookEntryResponse response = addressBookService.createAddressBookEntry(request);

For more information, please visit the Prime Java SDK.

AddressBookService addressBookService = PrimeServiceFactory.createAddressBookService(client);

CreateAddressBookEntryRequest request = new CreateAddressBookEntryRequest.Builder("portfolio_id")
        .accountIdentifier("account_identifier")
        .address("address")
        .currencySymbol("currency_symbol")
        .name("name")
        .build();

CreateAddressBookEntryResponse response = addressBookService.createAddressBookEntry(request);

For more information, please visit the Prime Java SDK.

var addressBookService = new AddressBookService(client);

var request = new CreateAddressBookEntryRequest("portfolio_id")
{
    Address = "address",
    CurrencySymbol = "currency_symbol",
    Name = "name",
    AccountIdentifier = "account_identifier",
};

var response = addressBookService.CreateAddressBookEntry(request);

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

addressBookService := addressbook.NewAddressBookService(client)

request := &addressbook.CreateAddressBookEntryRequest{
    PortfolioId: "portfolio-id",
    Address: "address",
    Symbol: "currency_symbol",
    Name: "name",
    AccountIdentifier: "account_identifier",
}

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

For more information, please visit the Prime Go SDK.

prime_client = PrimeClient(credentials)

request = CreateAddressBookEntryRequest(
    portfolio_id="portfolio_id",
    address="address",
    currency_symbol="currency_symbol",
    name="name",
    account_identifier="account_identifier",
)

response = prime_client.get_address_book(request)

For more information, please visit the Prime Python SDK.

primectl create-address-book-entry --help

For more information, please visit the Prime CLI.

const addressBooksService = new AddressBooksService(client);

addressBooksService.createAddressBook({
    portfolioId: 'PORTFOLIO_ID_HERE',
    address: 'ADDRESS_HERE',
    currencySymbol: 'ETH',
    name: 'XYZ Address',
}).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

Body

application/json

Response

200

application/json

A successful response.

The response is of type object.

List Entity Activities

Get Address Book

curl --request POST \
  --url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/address_book \
  --header 'Content-Type: application/json' \
  --data '{
  "address": "<string>",
  "currency_symbol": "<string>",
  "name": "<string>",
  "account_identifier": "<string>"
}'

{
  "activity_type": "ACTIVITY_TYPE_UNKNOWN",
  "num_approvals_remaining": 123,
  "activity_id": "<string>"
}

REST API

FIX API

Websocket Feed

Create Address Book Entry

Path Parameters

Body

Response