List Portfolio Balances

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

{
  "balances": [
    {
      "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"
    }
  ],
  "type": "TRADING_BALANCES",
  "trading_balances": {
    "total": "<string>",
    "holds": "<string>"
  },
  "vault_balances": {
    "total": "<string>",
    "holds": "<string>"
  },
  "prime_custody_balances": {
    "total": "<string>",
    "holds": "<string>"
  }
}

GET

portfolios

{portfolio_id}

balances

List Portfolio Balances

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

{
  "balances": [
    {
      "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"
    }
  ],
  "type": "TRADING_BALANCES",
  "trading_balances": {
    "total": "<string>",
    "holds": "<string>"
  },
  "vault_balances": {
    "total": "<string>",
    "holds": "<string>"
  },
  "prime_custody_balances": {
    "total": "<string>",
    "holds": "<string>"
  }
}

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

Java
.NET
Go
Python
CLI
TS/JS

BalancesService balancesService = PrimeServiceFactory.createBalancesService(client);

ListPortfolioBalancesRequest request = new ListPortfolioBalancesRequest.Builder("PORTFOLIO_ID_HERE").build();

ListPortfolioBalancesResponse response = balancesService.listPortfolioBalances(request);

For more information, please visit the Prime Java SDK.

Path Parameters

portfolio_id

string

required

The portfolio ID

Query Parameters

symbols

string

A list of symbols by which to filter the response

balance_type

enum<string>

A type by which to filter balances

UNKNOWN_BALANCE_TYPE: nil
TRADING_BALANCES: Trading balances
VAULT_BALANCES: Vault balances
TOTAL_BALANCES: Total balances (The sum of vault and trading + prime custody)
PRIME_CUSTODY_BALANCES: Prime custody balances
UNIFIED_TOTAL_BALANCES: Unified total balance across networks and wallet types (vault + trading + prime custody)

Available options:

TRADING_BALANCES,

VAULT_BALANCES,

TOTAL_BALANCES,

PRIME_CUSTODY_BALANCES,

UNIFIED_TOTAL_BALANCES

Response

200 - application/json

A successful response.

balances

object[]

A list of balances.

Show child attributes

balances.symbol

string

The display symbol for the asset

Example:

"BTC"

balances.amount

string

The total amount in whole units with full precision. Includes the holds amount.

Example:

"109.42"

balances.holds

string

Amount that is currently held in obligation to an open order's position or a pending withdrawal

Example:

"2"

balances.bonded_amount

string

Amount that is currently locked due to bonding/staking, potentially subject to an unbonding period, in whole units

Example:

"109.42"

balances.reserved_amount

string

Amount that must remain in the wallet due to the protocol, in whole units

Example:

"109.42"

balances.unbonding_amount

string

Amount that is in the process of unbonding, in whole units

Example:

"109.42"

balances.unvested_amount

string

Unrealized amount subject to a vesting schedule, in whole units

Example:

"109.42"

balances.pending_rewards_amount

string

Pending bonding/staking rewards that have not yet been realized, in whole units

Example:

"109.42"

balances.past_rewards_amount

string

Previously realized bonding/staking rewards, in whole units

Example:

"109.42"

balances.bondable_amount

string

Amount available for bonding/staking, in whole units

Example:

"109.42"

balances.withdrawable_amount

string

Amount available to withdraw, in whole units

Example:

"109.42"

balances.fiat_amount

string

The total amount in fiat unit

Example:

"109.42"

balances.unbondable_amount

string

Amount available for unbonding/unstaking, in whole units

Example:

"109.42"

type

enum<string>

Available options:

TRADING_BALANCES,

VAULT_BALANCES,

TOTAL_BALANCES,

PRIME_CUSTODY_BALANCES,

UNIFIED_TOTAL_BALANCES

trading_balances

object

Show child attributes

trading_balances.total

string

trading_balances.holds

string

vault_balances

object

Show child attributes

vault_balances.total

string

vault_balances.holds

string

prime_custody_balances

object

Show child attributes

prime_custody_balances.total

string

prime_custody_balances.holds

string

List Onchain Wallet Balances

Get Portfolio Commission

⌘I

REST API

FIX API

Websocket Feed

Path Parameters

Query Parameters

Response