Skip to main content
GET
/
api
/
v1
/
portfolios
/
{portfolio}
/
summary
Get portfolio summary
curl --request GET \
  --url https://api.international.coinbase.com/api/v1/portfolios/{portfolio}/summary \
  --header 'CB-ACCESS-KEY: <api-key>' \
  --header 'CB-ACCESS-PASSPHRASE: <api-key>' \
  --header 'CB-ACCESS-SIGN: <api-key>' \
  --header 'CB-ACCESS-TIMESTAMP: <api-key>'
{
  "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
}
  • Java
  • .NET
  • Go
  • Python
  • TS/JS
  • CLI
PortfoliosService portfoliosService = IntxServiceFactory.createPortfoliosService(client);
GetPortfolioSummaryRequest request = new GetPortfolioSummaryRequest.Builder()
    .portfolio("portfolio_id")
    .build();
GetPortfolioSummaryResponse response = portfoliosService.getPortfolioSummary(request);
For more information, please visit the INTX Java SDK.

Authorizations

​
CB-ACCESS-KEY
string
header
required
​
CB-ACCESS-PASSPHRASE
string
header
required
​
CB-ACCESS-SIGN
string
header
required
​
CB-ACCESS-TIMESTAMP
string
header
required

Path Parameters

​
portfolio
string
required

Response

​
collateral
string
Example:
​
unrealized_pnl
string
Example:
​
unrealized_pnl_percent
string
Example:
​
position_notional
string
Example:
​
open_position_notional
string
Example:
​
pending_fees
string
Example:
​
borrow
string
Example:
​
accrued_interest
string
Example:
​
rolling_debt
string
Example:
​
balance
string
Example:
​
buying_power
string
Example:
​
portfolio_initial_margin
number
Example:
​
portfolio_current_margin
number
Example:
​
portfolio_maintenance_margin
number
Example:
​
portfolio_close_out_margin
number
Example:
​
in_liquidation
boolean
​
portfolio_initial_margin_notional
number
Example:
​
portfolio_current_margin_notional
number
Example:
​
portfolio_maintenance_margin_notional
number
Example:
​
portfolio_close_out_margin_notional
number
Example:
​
margin_override
number
Example:
​
lock_up_initial_margin
number
Example:
​
loan_collateral_requirement
string
Example:
​
position_offset_notional
number
Example: