Sign in

v3

OpenAPI 3.0.02026-07-31103181312.8 KB
historical

Get Historical Positions

Endpoint for getting settled market positions that have been archived to the historical database. Positions whose markets were archived before market_positions_last_updated_ts on GET /historical/cutoff are available via this endpoint. Positions are archived per whole event: a settled event's positions move here together and are never split between this endpoint and GET /portfolio/positions. Unsettled positions are always available via GET /portfolio/positions.

get/historical/positions

Query parameters

tickerstring

Filter by market ticker

event_tickerstring

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

limitinteger

Number of results per page. Defaults to 100.

cursorstring

Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.

Response

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