Struct fxoanda_definitions::TakeProfitOrderRequest

pub struct TakeProfitOrderRequest {
    pub trigger_condition: Option<String>,
    pub trade_id: Option<String>,
    pub price: Option<f32>,
    pub time_in_force: Option<String>,
    pub client_extensions: Option<ClientExtensions>,
    pub client_trade_id: Option<String>,
    pub gtd_time: Option<DateTime<Utc>>,
    pub otype: Option<String>,
}

Fields

trigger_condition: Option<String>

Specification 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 Stop Loss Order for a long trade valid values are "DEFAULT" and "BID", and for short trades "DEFAULT" and "ASK" are valid.

trade_id: Option<String>

The ID of the Trade to close when the price threshold is breached. format: The string representation of the OANDA-assigned TradeID. OANDA- assigned TradeIDs are positive integers, and are derived from the TransactionID of the Transaction that opened the Trade.

price: Option<f32>

The price threshold specified for the TakeProfit Order. The associated Trade will be closed by a market price that is equal to or better than this threshold. format: A decimal number encodes as a string. The amount of precision provided depends on the Instrument.

time_in_force: Option<String>

The time-in-force requested for the TakeProfit Order. Restricted to "GTC", "GFD" and "GTD" for TakeProfit Orders.

client_extensions: Option<ClientExtensions>

A ClientExtensions object allows a client to attach a clientID, tag and comment to Orders and Trades in their Account. Do not set, modify, or delete this field if your account is associated with MT4.

client_trade_id: Option<String>

The client ID of the Trade to be closed when the price threshold is breached.

gtd_time: Option<DateTime<Utc>>

The date/time when the TakeProfit Order will be cancelled if its timeInForce is "GTD". format: The RFC 3339 representation is a string conforming to https://tools.ietf.org/rfc/rfc3339.txt. The Unix representation is a string representing the number of seconds since the Unix Epoch (January 1st, 1970 at UTC). The value is a fractional number, where the fractional part represents a fraction of a second (up to nine decimal places).

otype: Option<String>

The type of the Order to Create. Must be set to "TAKE_PROFIT" when creating a Take Profit Order.

Methods

impl TakeProfitOrderRequest

pub fn new() -> TakeProfitOrderRequest

pub fn with_trigger_condition(self, x: String) -> Self

Specification 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 Stop Loss Order for a long trade valid values are "DEFAULT" and "BID", and for short trades "DEFAULT" and "ASK" are valid.

• param String
• return TakeProfitOrderRequest

pub fn with_trade_id(self, x: String) -> Self

The ID of the Trade to close when the price threshold is breached. format: The string representation of the OANDA-assigned TradeID. OANDA- assigned TradeIDs are positive integers, and are derived from the TransactionID of the Transaction that opened the Trade.

• param String
• return TakeProfitOrderRequest

pub fn with_price(self, x: f32) -> Self

The price threshold specified for the TakeProfit Order. The associated Trade will be closed by a market price that is equal to or better than this threshold. format: A decimal number encodes as a string. The amount of precision provided depends on the Instrument.

• param f32
• return TakeProfitOrderRequest

pub fn with_time_in_force(self, x: String) -> Self

The time-in-force requested for the TakeProfit Order. Restricted to "GTC", "GFD" and "GTD" for TakeProfit Orders.

• param String
• return TakeProfitOrderRequest

pub fn with_client_extensions(self, x: ClientExtensions) -> Self

A ClientExtensions object allows a client to attach a clientID, tag and comment to Orders and Trades in their Account. Do not set, modify, or delete this field if your account is associated with MT4.

• param ClientExtensions
• return TakeProfitOrderRequest

pub fn with_client_trade_id(self, x: String) -> Self

The client ID of the Trade to be closed when the price threshold is breached.

• param String
• return TakeProfitOrderRequest

pub fn with_gtd_time(self, x: DateTime<Utc>) -> Self

The date/time when the TakeProfit Order will be cancelled if its timeInForce is "GTD". format: The RFC 3339 representation is a string conforming to https://tools.ietf.org/rfc/rfc3339.txt. The Unix representation is a string representing the number of seconds since the Unix Epoch (January 1st, 1970 at UTC). The value is a fractional number, where the fractional part represents a fraction of a second (up to nine decimal places).

• param DateTime
• return TakeProfitOrderRequest

pub fn with_otype(self, x: String) -> Self

The type of the Order to Create. Must be set to "TAKE_PROFIT" when creating a Take Profit Order.

• param String
• return TakeProfitOrderRequest

Trait Implementations

impl Debug for TakeProfitOrderRequest

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Serialize for TakeProfitOrderRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for TakeProfitOrderRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.