GET
/
api
/
v1
/
portfolios
/
{portfolio}
/
detail
curl --request GET \
  --url https://api.international.coinbase.com/api/v1/portfolios/{portfolio}/detail \
  --header 'CB-ACCESS-KEY: <api-key>' \
  --header 'CB-ACCESS-PASSPHRASE: <api-key>' \
  --header 'CB-ACCESS-SIGN: <api-key>' \
  --header 'CB-ACCESS-TIMESTAMP: <api-key>'
{
  "summary": {
    "collateral": 14750.53,
    "unrealized_pnl": 2953.01,
    "unrealized_pnl_percent": 0,
    "position_notional": 1050.32,
    "open_position_notional": 3010.02,
    "pending_fees": 120.31,
    "borrow": 4111.32,
    "accrued_interest": 10.02,
    "rolling_debt": 311.02,
    "balance": 15751.6,
    "buying_power": 14964.02,
    "portfolio_initial_margin": 0.05,
    "portfolio_current_margin": 0.05,
    "portfolio_maintenance_margin": 0.033,
    "portfolio_close_out_margin": 0.01665,
    "in_liquidation": true,
    "portfolio_initial_margin_notional": 1571.5345,
    "portfolio_current_margin_notional": 1571.5345,
    "portfolio_maintenance_margin_notional": 1023.3081,
    "portfolio_close_out_margin_notional": 482.6651,
    "margin_override": 0.2,
    "lock_up_initial_margin": 0.3,
    "loan_collateral_requirement": 0,
    "position_offset_notional": 3010.02
  },
  "balances": [
    {
      "asset_id": "14thr7fc-1-1",
      "asset_name": "BTC",
      "asset_uuid": "d92669ba-8a04-46d8-9b28-a2bbaeee3b9a",
      "quantity": 1.75,
      "hold": 0.5,
      "hold_available_for_collateral": 0.5,
      "transfer_hold": 0.25,
      "collateral_value": 0.9,
      "max_withdraw_amount": 0.9,
      "loan": 1,
      "loan_collateral_requirement": 0,
      "pledged_collateral_quantity": 0.5,
      "loan_initial_margin_contribution": 0.07,
      "collateral_backed_overdraft_loan": 100.5,
      "user_requested_loan": 548.5
    }
  ],
  "positions": [
    {
      "id": "1tvrktwe-1-457",
      "symbol": "BTC-PERP",
      "instrument_id": "14thr7ft-1-0",
      "instrument_uuid": "8ca6c040-48df-426b-bb4e-74413909da26",
      "vwap": 31011.75,
      "net_size": 1.75,
      "buy_order_size": 2.65,
      "sell_order_size": 1.2,
      "im_contribution": 0.07,
      "unrealized_pnl": 2953.01,
      "mark_price": 20000.63,
      "entry_vwap": 34021.45
    }
  ]
}
PortfoliosService portfoliosService = IntxServiceFactory.createPortfoliosService(client);
GetPortfolioDetailRequest request = new GetPortfolioDetailRequest.Builder()
    .portfolio("portfolio_id")
    .build();
GetPortfolioDetailResponse response = portfoliosService.getPortfolioDetail(request);

For more information, please visit the INTX Java SDK.

Authorizations

​
CB-ACCESS-KEY
string
header
required

The Client ID that owns the API Key for the request

​
CB-ACCESS-PASSPHRASE
string
header
required

The pass phrase affiliated with the API Key

​
CB-ACCESS-SIGN
string
header
required

A HMAC SHA-256 signature using the API Key secret on the string TIMESTAMP, METHOD, REQUEST_PATH, BODY

​
CB-ACCESS-TIMESTAMP
string
header
required

The timestamp of when the request is being made

Path Parameters

​
portfolio
string
required

Identifies the portfolio by UUID (e.g., 892e8c7c-e979-4cad-b61b-55a197932cf1) or portfolio ID (e.g., 5189861793641175)

Response

200
application/json

Portfolio information

The response is of type object.