pub struct StopLossOrder {Show 23 fields
pub id: Option<OrderID>,
pub create_time: Option<Timestamp>,
pub state: Option<OrderState>,
pub client_extensions: Option<ClientExtensions>,
pub type: Option<OrderType>,
pub guaranteed_execution_premium: Option<Decimal>,
pub trade_id: TradeID,
pub client_trade_id: Option<ClientID>,
pub price: Decimal,
pub distance: Option<Decimal>,
pub time_in_force: TimeInForce,
pub gtd_time: Option<Timestamp>,
pub trigger_condition: OrderTriggerCondition,
pub guaranteed: Option<bool>,
pub filling_transaction_id: Option<TransactionID>,
pub filled_time: Option<Timestamp>,
pub trade_opened_id: Option<TradeID>,
pub trade_reduced_id: Option<TradeID>,
pub trade_closed_ids: Option<Vec<TradeID>>,
pub cancelling_transaction_id: Option<TransactionID>,
pub cancelled_time: Option<Timestamp>,
pub replaces_order_id: Option<OrderID>,
pub replaced_by_order_id: Option<OrderID>,
}Expand description
A StopLossOrder is an order that is linked to an open Trade and created with a price threshold. The Order will be filled (closing the Trade) by the first price that is equal to or worse than the threshold. A StopLossOrder cannot be used to open a new Position.
Fields§
§id: Option<OrderID>The Order’s identifier, unique within the Order’s Account.
create_time: Option<Timestamp>The time when the Order was created.
state: Option<OrderState>The current state of the Order.
client_extensions: Option<ClientExtensions>The client extensions of the Order. Do not set, modify, or delete clientExtensions if your account is associated with MT4.
type: Option<OrderType>The type of the Order. Always set to “STOP_LOSS” for Stop Loss Orders.
The premium that will be charged if the Stop Loss Order is guaranteed and the Order is filled at the guaranteed price. It is in price units and is charged for each unit of the Trade. Deprecated: Will be removed in a future API update.
trade_id: TradeIDThe ID of the Trade to close when the price threshold is breached.
client_trade_id: Option<ClientID>The client ID of the Trade to be closed when the price threshold is breached.
price: DecimalThe price threshold specified for the Stop Loss Order. The associated Trade will be closed by a market price that is equal to or worse than this threshold.
distance: Option<Decimal>Specifies the distance (in price units) from the Account’s current price to use as the Stop Loss Order price. If the Trade is short the Instrument’s bid price is used, and for long Trades the ask is used.
time_in_force: TimeInForceThe time-in-force requested for the StopLoss Order. Restricted to “GTC”, “GFD” and “GTD” for StopLoss Orders.
gtd_time: Option<Timestamp>The date/time when the StopLoss Order will be cancelled if its timeInForce is “GTD”.
trigger_condition: OrderTriggerConditionSpecification of which price component should be used when determining if an Order should be triggered and filled. This allows Orders to be triggered based on the bid, ask, mid, default (ask for buy, bid for sell) or inverse (ask for sell, bid for buy) price depending on the desired behaviour. Orders are always filled using their default price component. This feature is only provided through the REST API. Clients who choose to specify a non-default trigger condition will not see it reflected in any of OANDA’s proprietary or partner trading platforms, their transaction history or their account statements. OANDA platforms always assume that an Order’s trigger condition is set to the default value when indicating the distance from an Order’s trigger price, and will always provide the default trigger condition when creating or modifying an Order. A special restriction applies when creating a Guaranteed Stop Loss Order. In this case the TriggerCondition value must either be “DEFAULT”, or the “natural” trigger side “DEFAULT” results in. So for a Guaranteed Stop Loss Order for a long trade valid values are “DEFAULT” and “BID”, and for short trades “DEFAULT” and “ASK” are valid.
guaranteed: Option<bool>Flag indicating that the Stop Loss Order is guaranteed. The default value depends on the GuaranteedStopLossOrderMode of the account, if it is REQUIRED, the default will be true, for DISABLED or ENABLED the default is false. Deprecated: Will be removed in a future API update.
filling_transaction_id: Option<TransactionID>ID of the Transaction that filled this Order (only provided when the Order’s state is FILLED)
filled_time: Option<Timestamp>Date/time when the Order was filled (only provided when the Order’s state is FILLED)
trade_opened_id: Option<TradeID>Trade ID of Trade opened when the Order was filled (only provided when the Order’s state is FILLED and a Trade was opened as a result of the fill)
trade_reduced_id: Option<TradeID>Trade ID of Trade reduced when the Order was filled (only provided when the Order’s state is FILLED and a Trade was reduced as a result of the fill)
trade_closed_ids: Option<Vec<TradeID>>Trade IDs of Trades closed when the Order was filled (only provided when the Order’s state is FILLED and one or more Trades were closed as a result of the fill)
cancelling_transaction_id: Option<TransactionID>ID of the Transaction that cancelled the Order (only provided when the Order’s state is CANCELLED)
cancelled_time: Option<Timestamp>Date/time when the Order was cancelled (only provided when the state of the Order is CANCELLED)
replaces_order_id: Option<OrderID>The ID of the Order that was replaced by this Order (only provided if this Order was created as part of a cancel/replace).
replaced_by_order_id: Option<OrderID>The ID of the Order that replaced this Order (only provided if this Order was cancelled as part of a cancel/replace).