GET
/
v1
/
entities
/
{entity_id}
/
balances
List Entity Balances
curl --request GET \
  --url https://api.prime.coinbase.com/v1/entities/{entity_id}/balances
{
  "balances": [
    {
      "symbol": "BTC",
      "long_amount": "109.42",
      "long_notional": "109.42",
      "short_amount": "109.42",
      "short_notional": "109.42"
    }
  ],
  "pagination": {
    "next_cursor": "<string>",
    "sort_direction": "DESC",
    "has_next": true
  }
}

Path Parameters

​
entity_id
string
required

The entity ID

Query Parameters

​
symbols
string

A list of symbols by which to filter the response

​
cursor
string

Id to retrieve additional results strictly after

​
limit
integer

Number of items to retrieve

​
aggregation_type
enum<string>

A type by which to filter aggregated balances, defaults to "TOTAL"

  • 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.

The response is of type object.