Get portfolio summary

GET

api

portfolios

{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
}

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.

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.

var portfoliosService = new PortfoliosService(client);
var request = new GetPortfolioSummaryRequest(
    Portfolio: "portfolio_id",
);
var response = portfoliosService.GetPortfolioSummary(request);

For more information, please visit the INTX .NET SDK.

portfoliosSvc := portfolios.NewPortfoliosService(client)
request := &portfolios.GetPortfolioSummaryRequest{
    Portfolio: "portfolio_id",
}
response, err := portfoliosSvc.GetPortfolioSummary(context.Background(), request)

For more information, please visit the INTX Go SDK.

client = IntxClient()
request = GetPortfolioSummaryRequest(
    portfolio="portfolio_id",
)
response = client.get_portfolio_summary(request)

For more information, please visit the INTX Python SDK.

const portfoliosService = new PortfoliosService(client);

portfoliosService.getPortfolioSummary({
    portfolio: 'PORTFOLIO_ID_HERE',
}).then(async (response) => {
    console.log('Portfolio Summary: ', response);
})

For more information, please visit the INTX TS SDK.

intxctl get-portfolio-summary --help

For more information, please visit the INTX CLI.

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.

Get portfolio margin call status

Get position for portfolio/instrument

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
}

REST API

FIX API

WEBSOCKET FEED

Get portfolio summary

Authorizations

Path Parameters

Response