place_stop_limit_order
Place a stop-limit order to automatically trigger a limit order when a specified stop price is reached, preventing unfavorable execution during fast market moves while maintaining price control.
Instructions
Submit a combined stop-limit order: once the stop price is hit, a limit order
is placed at your specified limit price instead of executing at market.
This gives more control than a plain stop order by preventing execution at
an unfavourable price during fast market moves, but the order may not fill
if the price moves through the limit. See also: place_stop_order for a
simpler stop that guarantees execution.
Args:
ticker: Instrument ticker (e.g., 'AAPL_US_EQ'). Use search_instrument to find valid tickers.
quantity: Number of shares. Positive to buy, negative to sell.
stop_price: Trigger price that activates the limit order (e.g., 140.00).
limit_price: Price at which the resulting limit order is placed (e.g., 139.50).
Typically set slightly below the stop price for sells.
time_validity: DAY or GOOD_TILL_CANCEL. Defaults to DAY.
Returns:
Order: The newly created stop-limit orderInput Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ticker | Yes | ||
| quantity | Yes | ||
| stop_price | Yes | ||
| limit_price | Yes | ||
| time_validity | No | DAY |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| ticker | Yes | ||
| type | No | ||
| status | No | ||
| quantity | No | ||
| filledQuantity | No | ||
| filledValue | No | ||
| limitPrice | No | ||
| stopPrice | No | ||
| strategy | No | ||
| value | No | ||
| creationTime | No |