Executors

Get Positions Summary

Changed on

Get summary of all held positions from executors stopped with keep_position=True.

Returns aggregate information including:

  • Total number of active position holds
  • Total realized PnL across all positions
  • Total unrealized PnL (when market rates are available)
  • List of all positions with breakeven prices and PnL

Query parameters:

  • controller_id: Filter positions by controller ID
get/executors/positions/summary

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/executors/positions/summary
  • Auth
    HTTP basic

Query parameters

controller_idstring nullable

Response

Successful Response

total_positionsinteger required

Number of active position holds

total_realized_pnlnumber required

Total realized PnL across all positions

total_unrealized_pnlnumber nullable

Total unrealized PnL (None if no rates available)

Changes

  • 6edd79085219Revision changes
    • info

      added the new optional query request parameter controller_id

    • info

      added the non-success response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 92703f48a69eRevision changes
    • info

      endpoint added