GET
/
api
/
v3
/
brokerage
/
portfolios
/
{portfolio_uuid}
Get Portfolio Breakdown
curl --request GET \
  --url https://api.coinbase.com/api/v3/brokerage/portfolios/{portfolio_uuid} \
  --header 'Authorization: Bearer <token>'
{
  "breakdown": {
    "portfolio": {
      "name": "<string>",
      "uuid": "<string>",
      "type": "UNDEFINED",
      "deleted": true
    },
    "portfolio_balances": {
      "total_balance": {
        "value": "<string>",
        "currency": "<string>"
      },
      "total_futures_balance": {
        "value": "<string>",
        "currency": "<string>"
      },
      "total_cash_equivalent_balance": {
        "value": "<string>",
        "currency": "<string>"
      },
      "total_crypto_balance": {
        "value": "<string>",
        "currency": "<string>"
      },
      "futures_unrealized_pnl": {
        "value": "<string>",
        "currency": "<string>"
      },
      "perp_unrealized_pnl": {
        "value": "<string>",
        "currency": "<string>"
      }
    },
    "spot_positions": [
      {
        "asset": "<string>",
        "account_uuid": "<string>",
        "total_balance_fiat": 123,
        "total_balance_crypto": 123,
        "available_to_trade_fiat": 123,
        "allocation": 123,
        "cost_basis": {
          "value": "<string>",
          "currency": "<string>"
        },
        "asset_img_url": "<string>",
        "is_cash": true,
        "average_entry_price": {
          "value": "<string>",
          "currency": "<string>"
        },
        "asset_uuid": "<string>",
        "available_to_trade_crypto": 123,
        "unrealized_pnl": 123,
        "available_to_transfer_fiat": 123,
        "available_to_transfer_crypto": 123,
        "asset_color": "<string>",
        "account_type": "ACCOUNT_TYPE_UNKNOWN_UNSPECIFIED",
        "funding_pnl": 123
      }
    ],
    "perp_positions": [
      {
        "product_id": "<string>",
        "product_uuid": "<string>",
        "symbol": "<string>",
        "asset_image_url": "<string>",
        "vwap": {
          "userNativeCurrency": {
            "value": "<string>",
            "currency": "<string>"
          },
          "rawCurrency": {
            "value": "<string>",
            "currency": "<string>"
          }
        },
        "position_side": "FUTURES_POSITION_SIDE_UNSPECIFIED",
        "net_size": "<string>",
        "buy_order_size": "<string>",
        "sell_order_size": "<string>",
        "im_contribution": "<string>",
        "unrealized_pnl": {
          "userNativeCurrency": {
            "value": "<string>",
            "currency": "<string>"
          },
          "rawCurrency": {
            "value": "<string>",
            "currency": "<string>"
          }
        },
        "mark_price": {
          "userNativeCurrency": {
            "value": "<string>",
            "currency": "<string>"
          },
          "rawCurrency": {
            "value": "<string>",
            "currency": "<string>"
          }
        },
        "liquidation_price": {
          "userNativeCurrency": {
            "value": "<string>",
            "currency": "<string>"
          },
          "rawCurrency": {
            "value": "<string>",
            "currency": "<string>"
          }
        },
        "leverage": "<string>",
        "im_notional": {
          "userNativeCurrency": {
            "value": "<string>",
            "currency": "<string>"
          },
          "rawCurrency": {
            "value": "<string>",
            "currency": "<string>"
          }
        },
        "mm_notional": {
          "userNativeCurrency": {
            "value": "<string>",
            "currency": "<string>"
          },
          "rawCurrency": {
            "value": "<string>",
            "currency": "<string>"
          }
        },
        "position_notional": {
          "userNativeCurrency": {
            "value": "<string>",
            "currency": "<string>"
          },
          "rawCurrency": {
            "value": "<string>",
            "currency": "<string>"
          }
        },
        "margin_type": "MARGIN_TYPE_UNSPECIFIED",
        "liquidation_buffer": "<string>",
        "liquidation_percentage": "<string>",
        "asset_color": "<string>"
      }
    ],
    "futures_positions": [
      {
        "product_id": "<string>",
        "contract_size": "<string>",
        "side": "FUTURES_POSITION_SIDE_UNSPECIFIED",
        "amount": "<string>",
        "avg_entry_price": "<string>",
        "current_price": "<string>",
        "unrealized_pnl": "<string>",
        "expiry": "<string>",
        "underlying_asset": "<string>",
        "asset_img_url": "<string>",
        "product_name": "<string>",
        "venue": "<string>",
        "notional_value": "<string>",
        "asset_color": "<string>",
        "last_traded_at": "<string>"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

A JWT signed using your CDP API Key Secret, encoded in base64. Refer to the Creating API Keys section of our Coinbase App Authentication docs for information on how to generate your Bearer Token.

Path Parameters

portfolio_uuid
string
required

The portfolio UUID.

Query Parameters

currency
string

The currency symbol (e.g. USD).

Response

A successful response.

breakdown
object

PortfolioBreakdown is a breakdown of a portfolio, all balances, and all positions within the portfolio.