v3

OpenAPI 3.0.02026-07-31103181312.8 KB

fcm

Get FCM Positions

Endpoint for FCM members to get market positions filtered by subtrader ID. This endpoint requires FCM member access level and allows filtering positions by subtrader ID.

get/fcm/positions

Query parameters

subtrader_idstring required

Restricts the response to positions for a specific subtrader (FCM members only)

tickerstring

Ticker of desired positions

event_tickerstring

Event ticker of desired positions

count_filterstring

Restricts the positions to those with any of following fields with non-zero values, as a comma separated list

settlement_status'all' | 'unsettled' | 'settled'

Settlement status of the markets to return. Defaults to unsettled

limitinteger

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

cursorstring

The Cursor represents a pointer to the next page of records in the pagination

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