Executors

Stop an active executor.

Options:

  • keep_position: If true, keeps any open position (for position executors). If false, the executor will attempt to close all positions before stopping.

Returns confirmation of the stop action.

post/executors/{executor_id}/stop

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/executors/{executor_id}/stop
  • Auth
    HTTP basic

Path parameters

executor_idstring required

Request body

keep_positionboolean

Whether to keep the position open (for position executors)

Response

Successful Response

executor_idstring required

Executor identifier

statusstring required

New status: 'stopping', or 'already_terminated' when the stop was a no-op

keep_positionboolean required

Whether position was kept open

close_typestring nullable

Final close_type when already terminated

position_addressstring nullable

On-chain position address from the executor's final state, if any

orphaned_positionboolean

True when the executor terminated with a live on-chain position that needs recovery

hold_reasonstring nullable

Why a POSITION_HOLD terminal was involuntary (e.g. close_retries_exhausted); None for voluntary holds

Changes

    • info

      added the optional property to the 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

    • info

      added the optional property to the response with the status

    • info

      endpoint added