pub struct StopOrderTransaction {Show 24 fields
pub id: Option<TransactionID>,
pub time: Option<Timestamp>,
pub user_id: Option<i64>,
pub account_id: Option<AccountID>,
pub batch_id: Option<TransactionID>,
pub request_id: Option<RequestID>,
pub type: Option<TransactionType>,
pub instrument: InstrumentName,
pub units: Decimal,
pub price: Decimal,
pub price_bound: Option<Decimal>,
pub time_in_force: TimeInForce,
pub gtd_time: Option<Timestamp>,
pub position_fill: OrderPositionFill,
pub trigger_condition: OrderTriggerCondition,
pub reason: Option<StopOrderReason>,
pub client_extensions: Option<ClientExtensions>,
pub take_profit_on_fill: Option<TakeProfitDetails>,
pub stop_loss_on_fill: Option<StopLossDetails>,
pub trailing_stop_loss_on_fill: Option<TrailingStopLossDetails>,
pub guaranteed_stop_loss_on_fill: Option<GuaranteedStopLossDetails>,
pub trade_client_extensions: Option<ClientExtensions>,
pub replaces_order_id: Option<OrderID>,
pub cancelling_transaction_id: Option<TransactionID>,
}Expand description
A StopOrderTransaction represents the creation of a Stop Order in the user’s Account.
Fields§
§id: Option<TransactionID>The Transaction’s Identifier.
time: Option<Timestamp>The date/time when the Transaction was created.
user_id: Option<i64>The ID of the user that initiated the creation of the Transaction.
account_id: Option<AccountID>The ID of the Account the Transaction was created for.
batch_id: Option<TransactionID>The ID of the “batch” that the Transaction belongs to. Transactions in the same batch are applied to the Account simultaneously.
request_id: Option<RequestID>The Request ID of the request which generated the transaction.
type: Option<TransactionType>The Type of the Transaction. Always set to “STOP_ORDER” in a StopOrderTransaction.
instrument: InstrumentNameThe Stop Order’s Instrument.
units: DecimalThe quantity requested to be filled by the Stop Order. A positive number of units results in a long Order, and a negative number of units results in a short Order.
price: DecimalThe price threshold specified for the Stop Order. The Stop Order will only be filled by a market price that is equal to or worse than this price.
price_bound: Option<Decimal>The worst market price that may be used to fill this Stop Order. If the market gaps and crosses through both the price and the priceBound, the Stop Order will be cancelled instead of being filled.
time_in_force: TimeInForceThe time-in-force requested for the Stop Order.
gtd_time: Option<Timestamp>The date/time when the Stop Order will be cancelled if its timeInForce is “GTD”.
position_fill: OrderPositionFillSpecification of how Positions in the Account are modified when the Order is filled.
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.
reason: Option<StopOrderReason>The reason that the Stop Order was initiated
client_extensions: Option<ClientExtensions>Client Extensions to add to the Order (only provided if the Order is being created with client extensions).
take_profit_on_fill: Option<TakeProfitDetails>The specification of the Take Profit Order that should be created for a Trade opened when the Order is filled (if such a Trade is created).
stop_loss_on_fill: Option<StopLossDetails>The specification of the Stop Loss Order that should be created for a Trade opened when the Order is filled (if such a Trade is created).
trailing_stop_loss_on_fill: Option<TrailingStopLossDetails>The specification of the Trailing Stop Loss Order that should be created for a Trade that is opened when the Order is filled (if such a Trade is created).
guaranteed_stop_loss_on_fill: Option<GuaranteedStopLossDetails>The specification of the Guaranteed Stop Loss Order that should be created for a Trade that is opened when the Order is filled (if such a Trade is created).
trade_client_extensions: Option<ClientExtensions>Client Extensions to add to the Trade created when the Order is filled (if such a Trade is created). Do not set, modify, delete tradeClientExtensions if your account is associated with MT4.
replaces_order_id: Option<OrderID>The ID of the Order that this Order replaces (only provided if this Order replaces an existing Order).
cancelling_transaction_id: Option<TransactionID>The ID of the Transaction that cancels the replaced Order (only provided if this Order replaces an existing Order).