Sign in

v3

OpenAPI 3.0.02026-07-31103181312.8 KB
portfolio

Get Positions

Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted: position, total_traded

get/portfolio/positions

Query parameters

cursorstring

The Cursor represents a pointer to the next page of records in the pagination. Use the value returned from the previous response to get the next page.

limitinteger

Parameter to specify the number of results per page. Defaults to 100.

count_filterstring

Restricts the positions to those with any of following fields with non-zero values, as a comma separated list. The following values are accepted - position, total_traded

tickerstring

Filter by market ticker

event_tickerstring

Event ticker to filter by. Only a single event ticker is supported.

subaccountinteger

Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0.

Response

Positions retrieved successfully

cursorstring

The Cursor represents a pointer to the next page of records in the pagination. Use the value returned here in the cursor query parameter for this end-point to get the next page containing limit records. An empty value of this field indicates there is no next page.

Example response

{
  "market_positions": [
    {
      "total_traded_dollars": "0.5600",
      "position_fp": "10.00",
      "market_exposure_dollars": "0.5600",
      "realized_pnl_dollars": "0.5600",
      "fees_paid_dollars": "0.5600"
    }
  ],
  "event_positions": [
    {
      "total_cost_dollars": "0.5600",
      "total_cost_shares_fp": "10.00",
      "event_exposure_dollars": "0.5600",
      "realized_pnl_dollars": "0.5600",
      "fees_paid_dollars": "0.5600"
    }
  ]
}