List portfolio positions

GET

api

portfolios

{portfolio}

positions

curl --request GET \
  --url https://api.international.coinbase.com/api/v1/portfolios/{portfolio}/positions \
  --header 'CB-ACCESS-KEY: <api-key>' \
  --header 'CB-ACCESS-PASSPHRASE: <api-key>' \
  --header 'CB-ACCESS-SIGN: <api-key>' \
  --header 'CB-ACCESS-TIMESTAMP: <api-key>'

[
  {
    "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
  }
]

PortfoliosService portfoliosService = IntxServiceFactory.createPortfoliosService(client);
ListPortfolioPositionsRequest request = new ListPortfolioPositionsRequest.Builder()
    .portfolio("portfolio_id")
    .build();
ListPortfolioPositionsResponse response = portfoliosService.listPortfolioPositions(request);

For more information, please visit the INTX Java SDK.

PortfoliosService portfoliosService = IntxServiceFactory.createPortfoliosService(client);
ListPortfolioPositionsRequest request = new ListPortfolioPositionsRequest.Builder()
    .portfolio("portfolio_id")
    .build();
ListPortfolioPositionsResponse response = portfoliosService.listPortfolioPositions(request);

For more information, please visit the INTX Java SDK.

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

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

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

For more information, please visit the INTX Go SDK.

client = IntxClient()
request = GetPortfolioPositionsRequest(
    portfolio="portfolio_id",
)
response = client.get_portfolio_positions(request)

For more information, please visit the INTX Python SDK.

const portfoliosService = new PortfoliosService(client);

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

For more information, please visit the INTX TS SDK.

intxctl get-portfolio-positions --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

Position information

The response is of type object[].

List portfolio fills

List the open position limits for all instruments

curl --request GET \
  --url https://api.international.coinbase.com/api/v1/portfolios/{portfolio}/positions \
  --header 'CB-ACCESS-KEY: <api-key>' \
  --header 'CB-ACCESS-PASSPHRASE: <api-key>' \
  --header 'CB-ACCESS-SIGN: <api-key>' \
  --header 'CB-ACCESS-TIMESTAMP: <api-key>'

[
  {
    "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
  }
]

REST API

FIX API

WEBSOCKET FEED

List portfolio positions

Authorizations

Path Parameters

Response