place_stop_order
Place a stop order to automatically trigger a market sell or buy when the instrument reaches a specified stop price, limiting risk on existing positions.
Instructions
Submit a stop order that triggers a market execution once the instrument
reaches the specified stop price. Commonly used as a stop-loss to limit
downside risk on an existing position.
When the stop price is hit, the order becomes a market order and fills at
the best available price (which may differ from the stop price in fast markets).
For more control over the fill price, use place_stop_limit_order instead.
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 order (e.g., 140.00).
time_validity: DAY or GOOD_TILL_CANCEL. Defaults to DAY.
Returns:
Order: The newly created stop orderInput Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ticker | Yes | ||
| quantity | Yes | ||
| stop_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 |