Executors

Get Position Held

Changed on

Get held position for a specific connector/trading pair.

Returns the aggregated position from executors stopped with keep_position=True, including breakeven prices, matched/unmatched volume, realized PnL, and unrealized PnL.

Query parameters:

  • controller_id: Controller ID (default "main")
get/executors/positions/{connector_name}/{trading_pair}

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/executors/positions/{connector_name}/{trading_pair}
  • Auth
    HTTP basic

Path parameters

connector_namestring required
trading_pairstring required

Query parameters

account_namestring
controller_idstring

Response

Successful Response

trading_pairstring required
connector_namestring required
account_namestring required
controller_idstring

Controller that owns this position

buy_amount_basenumber required
buy_amount_quotenumber required
sell_amount_basenumber required
sell_amount_quotenumber required
net_amount_basenumber required
buy_breakeven_pricenumber nullable required
sell_breakeven_pricenumber nullable required
matched_amount_basenumber required
unmatched_amount_basenumber required
position_sidestring nullable required
realized_pnl_quotenumber required
cum_fees_quotenumber
unrealized_pnl_quotenumber nullable
executor_countinteger required
executor_idsstring[] required
last_updatedstring nullable required

Changes

  • 6edd79085219Revision changes
    • info

      added the new optional query request parameter controller_id

    • 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