Interrupt Order Strategy
Stop a running Order Strategy.
Available to: All authenticated users
Environments: Demo, Live
Rate Limit: 500 requests per hour, 2-second back-off, counts all requests
Stops an Order Strategy that is already running, identified by its orderStrategyId, and cancels its remaining working orders. Order strategies are the multi-bracket constructs created with startOrderStrategy. Use this endpoint to terminate the whole strategy; to change a strategy's parameters while keeping it running, use modifyOrderStrategy instead.
The request body requires only orderStrategyId. Interrupting a strategy stops the strategy logic and cancels its open orders, but it does not flatten any position the strategy has already opened — close that separately with liquidatePosition if needed.
As with other order commands, success is not guaranteed — the strategy may already have completed or its orders may already have filled. The endpoint returns an OrderStrategyStatusResponse. When the request is rejected, the response carries a failureReason and an errorText describing the problem; on success the response includes the updated orderStrategy.
Common Failure Scenarios
- The strategy already completed or was interrupted (TooLate).
- Another command for the strategy is still being processed (AnotherCommandPending).
- The user isn't permitted to trade this account (Unauthorized).
Error Messages
| failureReason | Trigger |
|---|---|
| TooLate | The strategy already completed or was interrupted. |
| AnotherCommandPending | A previous command for this strategy hasn't completed. |
| Unauthorized | The user isn't permitted to trade this account. |
See the failureReason enum in the OrderStrategyStatusResponse schema for the complete list of values.
Request
- Base URL: https://demo.tradovateapi.com/v1
- URL: https://demo.tradovateapi.com/v1/orderStrategy/interruptorderstrategy
- Auth: HTTP bearer
Request body
Response
OrderStrategyStatusResponse
Changes
No recorded changes to this operation across all 1 revision of this API.