The concept of a wallet is central to Prime’s architecture. Each wallet has a unique Wallet ID, and there are three main types:
- Trading Balance: A wallet that is part of an omnibus account, directly available for trading. Each asset within a portfolio has exactly one Trading Balance Wallet ID.
- Custodial Vault Wallet: A wallet maintained within Coinbase Custody, where assets are held offline and segregated. Multiple vault wallets may be created for each asset by calling Create Wallet. Each vault wallet has its own Wallet ID.
- Onchain Wallet: To learn more about this wallet type, visit Onchain Wallet
The Wallet ID is required in many Prime API requests, such as those for querying balances, initiating transactions, and retrieving deposit instructions.
Creating a Wallet
Trading Balance Wallets are automatically created under one of the following conditions:
- When a user first navigates to an asset in the Prime UI
- When a user places a trade for that asset
- After calling Create Wallet with the
TRADING wallet type
To create a Vault Wallet, the Create Wallet endpoint must be called with the VAULT type. Below are examples of this process.
After a wallet creation request for a vault wallet is submitted, the response will include an Activity ID. Since most actions within Prime require consensus approval, a review step in the UI must be completed. Once the wallet creation is approved, the new wallet’s details, including its Wallet ID, can be looked up.
WalletsService walletsService = PrimeServiceFactory.createWalletsService(client);
CreateWalletRequest request = new CreateWalletRequest.Builder()
.portfolioId("PORTFOLIO_ID_HERE")
.type(WalletType.VAULT)
.name("PRIME_API_EXAMPLE")
.symbol("ETH")
.build();
CreateWalletResponse response = walletsService.createWallet(request);
To learn more about this SDK, please visit the Prime Java SDK.
WalletsService walletsService = PrimeServiceFactory.createWalletsService(client);
CreateWalletRequest request = new CreateWalletRequest.Builder()
.portfolioId("PORTFOLIO_ID_HERE")
.type(WalletType.VAULT)
.name("PRIME_API_EXAMPLE")
.symbol("ETH")
.build();
CreateWalletResponse response = walletsService.createWallet(request);
To learn more about this SDK, please visit the Prime Java SDK.
var walletsService = new WalletsService(client);
var request = new CreateWalletRequest("PORTFOLIO_ID_HERE")
{
Type = WalletType.VAULT,
Name = "PRIME_API_EXAMPLE",
Symbol = "ETH",
}
var response = walletsService.CreateWallet(request);
To learn more about this SDK, please visit the Prime .NET SDK.
walletsService := users.NewWalletsService(client)
request := &users.CreateWalletRequest{
PortfolioId: "PORTFOLIO_ID_HERE",
Type: "VAULT",
Name: "PRIME_API_EXAMPLE",
Symbol: "ETH",
}
response, err := walletsService.CreateWallet(context.Background(), request)
To learn more about this SDK, please visit the Prime Go SDK.
prime_client = PrimeClient(credentials)
request = CreateWalletRequest(
portfolio_id="PORTFOLIO_ID_HERE",
name="PRIME_API_EXAMPLE",
symbol="ETH",
wallet_type="VAULT",
)
response = prime_client.create_wallet(request)
To learn more about this SDK, please visit the Prime Python SDK.
primectl create-wallet --help
const walletsService = new WalletsService(client);
walletsService.getWalletDepositInstructions({
portfolioId: 'PORTFOLIO_ID_HERE',
type: WalletType.VAULT,
name: "PRIME_API_EXAMPLE",
symbol: "ETH",
}).then(async (response) => {
console.log('Wallet: ', response);
})
To learn more about this SDK, please visit the Prime TS SDK.
Finding a Wallet ID
Use the List Portfolio Wallets endpoint to retrieve all wallets for a portfolio, optionally filtering by wallet type or other parameters. If preferred, wallets may be located by name using a utility script, such as the Get Wallet by Name example from the Coinbase Samples scripts repository.
Below is an example of how to list all vault wallets for a portfolio.
WalletsService walletsService = PrimeServiceFactory.createWalletsService(client);
ListWalletsRequest request = new ListWalletsRequest.Builder()
.portfolioId("PORTFOLIO_ID_HERE")
.type(WalletType.VAULT)
.build();
ListWalletsResponse response = walletsService.listWallets(request);
To learn more about this SDK, please visit the Prime Java SDK.
WalletsService walletsService = PrimeServiceFactory.createWalletsService(client);
ListWalletsRequest request = new ListWalletsRequest.Builder()
.portfolioId("PORTFOLIO_ID_HERE")
.type(WalletType.VAULT)
.build();
ListWalletsResponse response = walletsService.listWallets(request);
To learn more about this SDK, please visit the Prime Java SDK.
var walletsService = new WalletsService(client);
var request = new ListWalletsRequest("PORTFOLIO_ID_HERE")
{
Type = WalletType.VAULT,
}
var response = walletsService.ListWallets(request);
To learn more about this SDK, please visit the Prime .NET SDK.
walletsService := users.NewWalletsService(client)
request := &users.ListWalletsRequest{
PortfolioId: "PORTFOLIO_ID_HERE",
Type: "VAULT",
}
response, err := walletsService.ListWallets(context.Background(), request)
To learn more about this SDK, please visit the Prime Go SDK.
prime_client = PrimeClient(credentials)
request = ListWalletsRequest(
portfolio_id="PORTFOLIO_ID_HERE",
type="VAULT",
)
response = prime_client.list_wallets(request)
To learn more about this SDK, please visit the Prime Python SDK.
const walletsService = new WalletsService(client);
walletsService.listWallets({
portfolioId: 'PORTFOLIO_ID_HERE',
type: WalletType.VAULT,
}).then(async (response) => {
console.log('Wallets: ', response);
})
To learn more about this SDK, please visit the Prime TS SDK.
primectl list-wallets --help
Please note: All requests discussed above require proper authentication. For more information, visit REST API Authentication.
