List Portfolio Wallets

List all wallets associated with a given portfolio.

GET /v1/portfolios/{portfolio_id}/wallets

List Portfolio Wallets

cURL

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

200

{
  "wallets": [
    {
      "id": "<string>",
      "name": "<string>",
      "symbol": "<string>",
      "type": "VAULT",
      "created_at": "2023-11-07T05:31:56Z",
      "address": "<string>",
      "visibility": "WALLET_VISIBILITY_UNSPECIFIED",
      "network": {
        "id": "<string>",
        "type": "<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

WalletsService walletsService = PrimeServiceFactory.createWalletsService(client);

ListWalletsRequest request = new ListWalletsRequest.Builder()
    .portfolioId("PORTFOLIO_ID_HERE")
    .type(WalletType.VAULT)
    .build();

ListWalletsResponse response = walletsService.listWallets(request);

For more information, please visit the Prime Java SDK.

.NET

var walletsService = new WalletsService(client);

var request = new ListWalletsRequest("PORTFOLIO_ID_HERE")
{
    Type = WalletType.VAULT,
}

var response = walletsService.ListWallets(request);

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

Go

walletsService := users.NewWalletsService(client)

request := &users.ListWalletsRequest{
    PortfolioId: "PORTFOLIO_ID_HERE",
    Type: "VAULT",
}

response, err := walletsService.ListWallets(context.Background(), request)

For more information, please visit the Prime Go SDK.

Python

prime_client = PrimeClient(credentials)

request = ListWalletsRequest(
    portfolio_id="PORTFOLIO_ID_HERE",
    type="VAULT",
)

response = prime_client.list_wallets(request)

For more information, please visit the Prime Python SDK.

CLI

primectl list-wallets --help

For more information, please visit the Prime CLI.

TS/JS

const walletsService = new WalletsService(client);

walletsService.listWallets({
    portfolioId: 'PORTFOLIO_ID_HERE',
    type: WalletType.VAULT,
}).then(async (response) => {
    console.log('Wallets: ', response);
})

For more information, please visit the Prime TS SDK.

Path Parameters

portfolio_id · string · required

The portfolio ID

Query Parameters

type · enum<string> · required

The wallet type

• VAULT: A crypto vault
• TRADING: A trading wallet
• WALLET_TYPE_OTHER: Other wallet types (like consumer, etc)
• QC: A QC Wallet
• ONCHAIN: An Onchain wallet

Available options: VAULT, TRADING, WALLET_TYPE_OTHER, QC, ONCHAIN

cursor · string

Cursor used for pagination (last consumed record)

limit · integer<int32>

Number of wallets to retrieve

sort_direction · enum<string> · default: DESC

Sorting order

Available options: DESC, ASC

symbols · string[]

The wallet symbol

get_network_unified_wallets · boolean

Flag to request retrieval of all wallets across all networks for a given symbol

Response

200 - application/json

A successful response.

wallets · object[]

Show child attributes

pagination · object

Show child attributes