v13

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-0815390371.2 KB
Executors

Stop Executor

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

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 (usually 'stopping')

keep_positionboolean required

Whether position was kept open