List Perpetuals Positions

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

{
  "positions": [
    {
      "product_id": "<string>",
      "product_uuid": "<string>",
      "portfolio_uuid": "<string>",
      "symbol": "<string>",
      "vwap": {
        "value": "<string>",
        "currency": "<string>"
      },
      "entry_vwap": {
        "value": "<string>",
        "currency": "<string>"
      },
      "position_side": "POSITION_SIDE_UNKNOWN",
      "margin_type": "MARGIN_TYPE_UNSPECIFIED",
      "net_size": "<string>",
      "buy_order_size": "<string>",
      "sell_order_size": "<string>",
      "im_contribution": "<string>",
      "unrealized_pnl": {
        "value": "<string>",
        "currency": "<string>"
      },
      "mark_price": {
        "value": "<string>",
        "currency": "<string>"
      },
      "liquidation_price": {
        "value": "<string>",
        "currency": "<string>"
      },
      "leverage": "<string>",
      "im_notional": {
        "value": "<string>",
        "currency": "<string>"
      },
      "mm_notional": {
        "value": "<string>",
        "currency": "<string>"
      },
      "position_notional": {
        "value": "<string>",
        "currency": "<string>"
      },
      "aggregated_pnl": {
        "value": "<string>",
        "currency": "<string>"
      }
    }
  ],
  "summary": {
    "aggregated_pnl": {
      "value": "<string>",
      "currency": "<string>"
    }
  }
}

GET

api

brokerage

intx

positions

{portfolio_uuid}

List Perpetuals Positions

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

{
  "positions": [
    {
      "product_id": "<string>",
      "product_uuid": "<string>",
      "portfolio_uuid": "<string>",
      "symbol": "<string>",
      "vwap": {
        "value": "<string>",
        "currency": "<string>"
      },
      "entry_vwap": {
        "value": "<string>",
        "currency": "<string>"
      },
      "position_side": "POSITION_SIDE_UNKNOWN",
      "margin_type": "MARGIN_TYPE_UNSPECIFIED",
      "net_size": "<string>",
      "buy_order_size": "<string>",
      "sell_order_size": "<string>",
      "im_contribution": "<string>",
      "unrealized_pnl": {
        "value": "<string>",
        "currency": "<string>"
      },
      "mark_price": {
        "value": "<string>",
        "currency": "<string>"
      },
      "liquidation_price": {
        "value": "<string>",
        "currency": "<string>"
      },
      "leverage": "<string>",
      "im_notional": {
        "value": "<string>",
        "currency": "<string>"
      },
      "mm_notional": {
        "value": "<string>",
        "currency": "<string>"
      },
      "position_notional": {
        "value": "<string>",
        "currency": "<string>"
      },
      "aggregated_pnl": {
        "value": "<string>",
        "currency": "<string>"
      }
    }
  ],
  "summary": {
    "aggregated_pnl": {
      "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.

positions

object[]

Show child attributes

positions.product_id

string

The unique identifier of the instrument the position is in.

positions.product_uuid

string

The unique identifier of the instrument the position is in.

positions.portfolio_uuid

string

The portfolio UUID.

positions.symbol

string

The trading pair (e.g. 'BTC-PERP-INTX').

positions.vwap

Message that represents the monetary amount. · object

Show child attributes

positions.vwap.value

string

Value of the Amount

positions.vwap.currency

string

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

positions.entry_vwap

Message that represents the monetary amount. · object

Show child attributes

positions.entry_vwap.value

string

Value of the Amount

positions.entry_vwap.currency

string

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

positions.position_side

enum<string>

default:POSITION_SIDE_UNKNOWN

Available options:

POSITION_SIDE_UNKNOWN,

POSITION_SIDE_LONG,

POSITION_SIDE_SHORT

positions.margin_type

enum<string>

default:MARGIN_TYPE_UNSPECIFIED

Available options:

MARGIN_TYPE_UNSPECIFIED,

MARGIN_TYPE_CROSS,

MARGIN_TYPE_ISOLATED

positions.net_size

string

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

positions.buy_order_size

string

Cumulative size of all the open buy orders

positions.sell_order_size

string

Cumulative size of all the open sell orders

positions.im_contribution

string

The amount this position contributes to the initial margin

positions.unrealized_pnl

Message that represents the monetary amount. · object

Show child attributes

positions.unrealized_pnl.value

string

Value of the Amount

positions.unrealized_pnl.currency

string

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

positions.mark_price

Message that represents the monetary amount. · object

Show child attributes

positions.mark_price.value

string

Value of the Amount

positions.mark_price.currency

string

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

positions.liquidation_price

Message that represents the monetary amount. · object

Show child attributes

positions.liquidation_price.value

string

Value of the Amount

positions.liquidation_price.currency

string

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

positions.leverage

string

The leverage of this position

positions.im_notional

Message that represents the monetary amount. · object

Show child attributes

positions.im_notional.value

string

Value of the Amount

positions.im_notional.currency

string

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

positions.mm_notional

Message that represents the monetary amount. · object

Show child attributes

positions.mm_notional.value

string

Value of the Amount

positions.mm_notional.currency

string

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

positions.position_notional

Message that represents the monetary amount. · object

Show child attributes

positions.position_notional.value

string

Value of the Amount

positions.position_notional.currency

string

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

positions.aggregated_pnl

Message that represents the monetary amount. · object

Show child attributes

positions.aggregated_pnl.value

string

Value of the Amount

positions.aggregated_pnl.currency

string

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

summary

object

Show child attributes

summary.aggregated_pnl

Message that represents the monetary amount. · object

Show child attributes

summary.aggregated_pnl.value

string

Value of the Amount

summary.aggregated_pnl.currency

string

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

Get Portfolios Balances

Opt In or Out of Multi Asset Collateral

⌘I

REST API

Authorizations

Path Parameters

Response