Get Perpetuals Portfolio Summary

curl --request GET \
  --url https://api.coinbase.com/api/v3/brokerage/intx/portfolio/{portfolio_uuid} \
  --header 'Authorization: Bearer <token>'

{
  "portfolios": [
    {
      "portfolio_uuid": "<string>",
      "collateral": "<string>",
      "position_notional": "<string>",
      "open_position_notional": "<string>",
      "pending_fees": "<string>",
      "borrow": "<string>",
      "accrued_interest": "<string>",
      "rolling_debt": "<string>",
      "portfolio_initial_margin": "<string>",
      "portfolio_im_notional": {
        "value": "<string>",
        "currency": "<string>"
      },
      "portfolio_maintenance_margin": "<string>",
      "portfolio_mm_notional": {
        "value": "<string>",
        "currency": "<string>"
      },
      "liquidation_percentage": "<string>",
      "liquidation_buffer": "<string>",
      "margin_type": "MARGIN_TYPE_UNSPECIFIED",
      "margin_flags": "PORTFOLIO_MARGIN_FLAGS_UNSPECIFIED",
      "liquidation_status": "PORTFOLIO_LIQUIDATION_STATUS_UNSPECIFIED",
      "unrealized_pnl": {
        "value": "<string>",
        "currency": "<string>"
      },
      "total_balance": {
        "value": "<string>",
        "currency": "<string>"
      }
    }
  ],
  "summary": {
    "unrealized_pnl": {
      "value": "<string>",
      "currency": "<string>"
    },
    "buying_power": {
      "value": "<string>",
      "currency": "<string>"
    },
    "total_balance": {
      "value": "<string>",
      "currency": "<string>"
    },
    "max_withdrawal_amount": {
      "value": "<string>",
      "currency": "<string>"
    }
  }
}

GET

api

brokerage

intx

portfolio

{portfolio_uuid}

Get Perpetuals Portfolio Summary

curl --request GET \
  --url https://api.coinbase.com/api/v3/brokerage/intx/portfolio/{portfolio_uuid} \
  --header 'Authorization: Bearer <token>'

{
  "portfolios": [
    {
      "portfolio_uuid": "<string>",
      "collateral": "<string>",
      "position_notional": "<string>",
      "open_position_notional": "<string>",
      "pending_fees": "<string>",
      "borrow": "<string>",
      "accrued_interest": "<string>",
      "rolling_debt": "<string>",
      "portfolio_initial_margin": "<string>",
      "portfolio_im_notional": {
        "value": "<string>",
        "currency": "<string>"
      },
      "portfolio_maintenance_margin": "<string>",
      "portfolio_mm_notional": {
        "value": "<string>",
        "currency": "<string>"
      },
      "liquidation_percentage": "<string>",
      "liquidation_buffer": "<string>",
      "margin_type": "MARGIN_TYPE_UNSPECIFIED",
      "margin_flags": "PORTFOLIO_MARGIN_FLAGS_UNSPECIFIED",
      "liquidation_status": "PORTFOLIO_LIQUIDATION_STATUS_UNSPECIFIED",
      "unrealized_pnl": {
        "value": "<string>",
        "currency": "<string>"
      },
      "total_balance": {
        "value": "<string>",
        "currency": "<string>"
      }
    }
  ],
  "summary": {
    "unrealized_pnl": {
      "value": "<string>",
      "currency": "<string>"
    },
    "buying_power": {
      "value": "<string>",
      "currency": "<string>"
    },
    "total_balance": {
      "value": "<string>",
      "currency": "<string>"
    },
    "max_withdrawal_amount": {
      "value": "<string>",
      "currency": "<string>"
    }
  }
}

Authorizations

Authorization

string

header

required

A JWT signed using your CDP API Key Secret, encoded in base64. Refer to the Creating API Keys section of our Coinbase App Authentication docs for information on how to generate your Bearer Token.

Path Parameters

portfolio_uuid

string

required

The portfolio UUID.

Response

A successful response.

portfolios

object[]

Show child attributes

portfolios.portfolio_uuid

string

The portfolio UUID.

portfolios.collateral

string

The total collateral value in USDC for the portfolio

portfolios.position_notional

string

The total position notional value in USDC for all positions in the portfolio

portfolios.open_position_notional

string

The total position notional value in USDC for all open orders and positions

portfolios.pending_fees

string

The accrued fees that has not been paid yet in USDC

portfolios.borrow

string

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

portfolios.accrued_interest

string

Interest charged for borrowed USDC balances

portfolios.rolling_debt

string

Amount of settled transactions that hasn't been paid

portfolios.portfolio_initial_margin

string

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

portfolios.portfolio_im_notional

Message that represents the monetary amount. · object

Show child attributes

portfolios.portfolio_im_notional.value

string

Value of the Amount

portfolios.portfolio_im_notional.currency

string

The currency to be allocated for the specific isolated position (e.g. USD, BTC, etc).

portfolios.portfolio_maintenance_margin

string

The maintenance margin of the portfolio

portfolios.portfolio_mm_notional

Message that represents the monetary amount. · object

Show child attributes

portfolios.portfolio_mm_notional.value

string

Value of the Amount

portfolios.portfolio_mm_notional.currency

string

The currency to be allocated for the specific isolated position (e.g. USD, BTC, etc).

portfolios.liquidation_percentage

string

The liquidation percentage of the portfolio

portfolios.liquidation_buffer

string

The liquidation buffer of the portfolio

portfolios.margin_type

enum<string>

default:MARGIN_TYPE_UNSPECIFIED

Available options:

MARGIN_TYPE_UNSPECIFIED,

MARGIN_TYPE_CROSS,

MARGIN_TYPE_ISOLATED

portfolios.margin_flags

enum<string>

default:PORTFOLIO_MARGIN_FLAGS_UNSPECIFIED

Available options:

PORTFOLIO_MARGIN_FLAGS_UNSPECIFIED,

PORTFOLIO_MARGIN_FLAGS_IN_LIQUIDATION

portfolios.liquidation_status

enum<string>

default:PORTFOLIO_LIQUIDATION_STATUS_UNSPECIFIED

Available options:

PORTFOLIO_LIQUIDATION_STATUS_UNSPECIFIED,

PORTFOLIO_LIQUIDATION_STATUS_CANCELING,

PORTFOLIO_LIQUIDATION_STATUS_AUTO_LIQUIDATING,

PORTFOLIO_LIQUIDATION_STATUS_LSP_ASSIGNMENT,

PORTFOLIO_LIQUIDATION_STATUS_CUSTOMER_ASSIGNMENT,

PORTFOLIO_LIQUIDATION_STATUS_MANUAL,

PORTFOLIO_LIQUIDATION_STATUS_NOT_LIQUIDATING

portfolios.unrealized_pnl

Message that represents the monetary amount. · object

Show child attributes

portfolios.unrealized_pnl.value

string

Value of the Amount

portfolios.unrealized_pnl.currency

string

The currency to be allocated for the specific isolated position (e.g. USD, BTC, etc).

portfolios.total_balance

Message that represents the monetary amount. · object

Show child attributes

portfolios.total_balance.value

string

Value of the Amount

portfolios.total_balance.currency

string

The currency to be allocated for the specific isolated position (e.g. USD, BTC, etc).

summary

object

Show child attributes

summary.unrealized_pnl

Message that represents the monetary amount. · object

Show child attributes

summary.unrealized_pnl.value

string

Value of the Amount

summary.unrealized_pnl.currency

string

The currency to be allocated for the specific isolated position (e.g. USD, BTC, etc).

summary.buying_power

Message that represents the monetary amount. · object

Show child attributes

summary.buying_power.value

string

Value of the Amount

summary.buying_power.currency

string

The currency to be allocated for the specific isolated position (e.g. USD, BTC, etc).

summary.total_balance

Message that represents the monetary amount. · object

Show child attributes

summary.total_balance.value

string

Value of the Amount

summary.total_balance.currency

string

The currency to be allocated for the specific isolated position (e.g. USD, BTC, etc).

summary.max_withdrawal_amount

Message that represents the monetary amount. · object

Show child attributes

summary.max_withdrawal_amount.value

string

Value of the Amount

summary.max_withdrawal_amount.currency

string

The currency to be allocated for the specific isolated position (e.g. USD, BTC, etc).

Allocate Portfolio

Get Perpetuals Position

⌘I

REST API

Authorizations

Path Parameters

Response