Get portfolio details

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,
      "unreconciled_amount": 10.5,
      "max_undelegate_amount": 15
    }
  ],
  "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,
      "index_price": 20001.45
    }
  ]
}

GET

api

portfolios

{portfolio}

detail

Get portfolio details

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,
      "unreconciled_amount": 10.5,
      "max_undelegate_amount": 15
    }
  ],
  "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,
      "index_price": 20001.45
    }
  ]
}

Java
.NET
Go
Python
TS/JS
CLI

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

Portfolio information

summary

object

Show child attributes

summary.collateral

string

The total collateral value in USDC for the portfolio

Example:

14750.53

summary.unrealized_pnl

string

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

Example:

2953.01

summary.unrealized_pnl_percent

string

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

Example:

0

summary.position_notional

string

The position value in USDC of all positions

Example:

1050.32

summary.open_position_notional

string

The notional value of all open orders and positions

Example:

3010.02

summary.pending_fees

string

Accrued fees that haven't been paid yet

Example:

120.31

summary.borrow

string

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

Example:

4111.32

summary.accrued_interest

string

Interest charged for borrowed USDC balances

Example:

10.02

summary.rolling_debt

string

Amount of settled transactions that haven't been paid

Example:

311.02

summary.balance

string

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

Example:

15751.6

summary.buying_power

string

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

Example:

14964.02

summary.portfolio_initial_margin

number<double>

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

Example:

0.05

summary.portfolio_current_margin

number<double>

The current margin level of the portfolio

Example:

0.05

summary.portfolio_maintenance_margin

number<double>

The maintenance margin of the portfolio

Example:

0.033

summary.portfolio_close_out_margin

number<double>

The close out margin of the portfolio

Example:

0.01665

summary.in_liquidation

boolean

Indicates whether the portfolio is in process of liquidation

summary.portfolio_initial_margin_notional

number<double>

The notional initial margin of the portfolio

Example:

1571.5345

summary.portfolio_current_margin_notional

number<double>

The notional current margin level of the portfolio

Example:

1571.5345

summary.portfolio_maintenance_margin_notional

number<double>

The notional maintenance margin of the portfolio

Example:

1023.3081

summary.portfolio_close_out_margin_notional

number<double>

The notional close out margin of the portfolio

Example:

482.6651

summary.margin_override

number<double>

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

Example:

0.2

summary.lock_up_initial_margin

number<double>

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

Example:

0.3

summary.loan_collateral_requirement

string

Example:

0

summary.position_offset_notional

number<double>

The notional value of margin relief provided by position offsets

Example:

3010.02

balances

object[]

Show child attributes

balances.asset_id

string

The unique identifier of the asset

Example:

"14thr7fc-1-1"

balances.asset_name

string

Name of the asset

Example:

"BTC"

balances.asset_uuid

string<uuid>

The UUID of the asset

Example:

"d92669ba-8a04-46d8-9b28-a2bbaeee3b9a"

balances.quantity

string

The total amount of the asset in the portfolio

Example:

1.75

balances.hold

string

The amount of the balance held from trading activity

Example:

0.5

balances.hold_available_for_collateral

string

The amount of the held balance eligible for collateral

Example:

0.5

balances.transfer_hold

string

The amount of the balance held from a pending transfer

Example:

0.25

balances.collateral_value

string

The collateral value provided by this asset balance

Example:

0.9

balances.max_withdraw_amount

string

The maximum amount of this asset that can be withdrawn on-chain at this time given margin requirement constraints

Example:

0.9

balances.loan

string

The total quantity of the asset borrowed by the portfolio

Example:

1

balances.loan_collateral_requirement

string

The notional collateral requirement to hold the loan

Example:

0

balances.pledged_collateral_quantity

string

The amount of the asset pledged as collateral

Example:

0.5

balances.loan_initial_margin_contribution

string<string>

The notional amount this loan contributes to the portfolio initial margin notional value

Example:

0.07

balances.collateral_backed_overdraft_loan

string

The quantity of the asset automatically borrowed by the portfolio to cover USDC deficits

Example:

100.5

balances.user_requested_loan

string

The quantity of the asset borrowed by the portfolio upon explicit request

Example:

548.5

balances.unreconciled_amount

string

The difference between the portfolio's exchange and external balance that has not yet been reconciled, for external collateral clients only

Example:

10.5

balances.max_undelegate_amount

string

The maximum amount that can be undelegated from the exchange, for external collateral clients only

Example:

15

positions

object[]

Show child attributes

positions.id

string

The unique identifier of the position

Example:

"1tvrktwe-1-457"

positions.symbol

string

Name of the instrument the position is in

Example:

"BTC-PERP"

positions.instrument_id

string

The unique identifier of the instrument the position is in

Example:

"14thr7ft-1-0"

positions.instrument_uuid

string<uuid>

The UUID of the instrument the position is in

Example:

"8ca6c040-48df-426b-bb4e-74413909da26"

positions.vwap

string

The price of your position based on the last settlement period. During each settlement period (5 minute interval), the VWAP is set to equal the mark_price.

Example:

31011.75

positions.net_size

string

The size of the position with positive values reflecting a long position and negative values reflecting a short position

Example:

1.75

positions.buy_order_size

string

Cumulative size of all the open buy orders

Example:

2.65

positions.sell_order_size

string

Cumulative size of all the open sell orders

Example:

1.2

positions.im_contribution

number<double>

The amount this position contributes to the initial margin

Example:

0.07

positions.unrealized_pnl

string

The profit or loss of this position (resets to 0 after settlement)

Example:

2953.01

positions.mark_price

string

The current mark price value for the instrument of this position used in risk and margin calculations

Example:

20000.63

positions.entry_vwap

string

Volume weighted entry price of the position (not reset to the last funding price)

Example:

34021.45

positions.index_price

string

The index price used for the funding process

Example:

20001.45

Get loan info for portfolio/asset

Get portfolio margin call status

⌘I

REST API

FIX API

WEBSOCKET FEED

Authorizations

Path Parameters

Response