Get portfolio summary

Retrieves the high level overview of a portfolio.

Java

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

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

collateral · string

The total collateral value in USDC for the portfolio

Example:

14750.53

unrealized_pnl · string

The profit or loss of all open positions (resets to 0 after settlement)

Example:

2953.01

unrealized_pnl_percent · string

The profit or loss percentage of all open positions (resets to 0 after settlement)

Example:

0

position_notional · string

The position value in USDC of all positions

Example:

1050.32

open_position_notional · string

The notional value of all open orders and positions

Example:

3010.02

pending_fees · string

Accrued fees that haven't been paid yet

Example:

120.31

borrow · string

Total borrow amount in USDC (nets the USDC balance, position PNL, held USDC, accrued interest and rolling debt)

Example:

4111.32

accrued_interest · string

Interest charged for borrowed USDC balances

Example:

10.02

rolling_debt · string

Amount of settled transactions that haven't been paid

Example:

311.02

balance · string

The net balance available in the portfolio (collateral + unrealized_pnl - pending_fees - accrued_interest - rolling_debt)

Example:

15751.6

buying_power · string

The amount of buying power available in the portfolio (balance - (open_position_notional * portfolio_initial_margin))

Example:

14964.02

portfolio_initial_margin · number

The weighted average of all the position's initial margin utilization

Example:

0.05

portfolio_current_margin · number

The current margin level of the portfolio

Example:

0.05

portfolio_maintenance_margin · number

The maintenance margin of the portfolio

Example:

0.033

portfolio_close_out_margin · number

The close out margin of the portfolio

Example:

0.01665

in_liquidation · boolean

Indicates whether the portfolio is in process of liquidation

portfolio_initial_margin_notional · number

The notional initial margin of the portfolio

Example:

1571.5345

portfolio_current_margin_notional · number

The notional current margin level of the portfolio

Example:

1571.5345

portfolio_maintenance_margin_notional · number

The notional maintenance margin of the portfolio

Example:

1023.3081

portfolio_close_out_margin_notional · number

The notional close out margin of the portfolio

Example:

482.6651

margin_override · number

The margin override value for the portfolio, indicating notional requirement to hold futures positions

Example:

0.2

lock_up_initial_margin · number

The effective margin requirement value for the portfolio (max(portfolio_initial_margin, margin_override))

Example:

0.3

loan_collateral_requirement · string

Example:

0

position_offset_notional · number

The notional value of margin relief provided by position offsets

Example:

3010.02