Get Wallet Balance

Query balance for a specific wallet.

GET /v1/portfolios/{portfolio_id}/wallets/{wallet_id}/balance

Get Wallet Balance

cURL

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

200

{
  "balance": {
    "symbol": "BTC",
    "amount": "109.42",
    "holds": "2",
    "bonded_amount": "109.42",
    "reserved_amount": "109.42",
    "unbonding_amount": "109.42",
    "unvested_amount": "109.42",
    "pending_rewards_amount": "109.42",
    "past_rewards_amount": "109.42",
    "bondable_amount": "109.42",
    "withdrawable_amount": "109.42",
    "fiat_amount": "109.42",
    "unbondable_amount": "109.42",
    "claimable_rewards_amount": "0.241437903"
  }
}

Use the Prime SDK or CLI to test this endpoint by following the quickstart guide and running with the following examples

Java

BalancesService balancesService = PrimeServiceFactory.createBalancesService(client);

GetWalletBalanceRequest request = new GetWalletBalanceRequest.Builder()
    .portfolioId("PORTFOLIO_ID_HERE")
    .walletId("WALLET_ID_HERE")
    .build();

GetWalletBalanceResponse response = balancesService.getWalletBalance(request);

For more information, please visit the Prime Java SDK.

.NET

var balancesService = new BalancesService(client);

var request = new GetWalletBalanceRequest("PORTFOLIO_ID_HERE", "WALLET_ID_HERE");
var response = balancesService.GetWalletBalance(request);

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

Go

balancesService := balances.NewBalancesService(client)

request := &balances.GetWalletBalance{
    PortfolioId: "PORTFOLIO_ID_HERE",
    WalletId: "WALLET_ID_HERE",
}

response, err := balancesService.GetWalletBalance(context.Background(), request)

For more information, please visit the Prime Go SDK.

Python

prime_client = PrimeClient(credentials)

request = GetWalletBalanceRequest(
        portfolio_id="PORTFOLIO_ID_HERE",
        wallet_id="WALLET_ID_HERE",
)

response = prime_client.get_wallet_balance(request)

For more information, please visit the Prime Python SDK.

CLI

primectl get-wallet-balance --help

For more information, please visit the Prime CLI.

TS/JS

const balancesService = new BalancesService(client);

balancesService.getWalletBalance({
    portfolioId: 'PORTFOLIO_ID_HERE',
    walletId: 'WALLET_ID_HERE'
}).then(async (response) => {
    console.log('Balances: ', response);
})

For more information, please visit the Prime TS SDK.

Path Parameters

portfolio_id · string · required

Portfolio ID

wallet_id · string · required

Wallet ID

Response

200 - application/json

A successful response.

balance · object

Show child attributes