Struct fxoanda_definitions::TakeProfitOrder

pub struct TakeProfitOrder {

    pub filled_time: Option<DateTime<Utc>>,
    pub gtd_time: Option<DateTime<Utc>>,
    pub replaces_order_id: Option<String>,
    pub trade_id: Option<String>,
    pub cancelled_time: Option<DateTime<Utc>>,
    pub price: Option<f32>,
    pub trade_opened_id: Option<String>,
    pub trade_closed_i_ds: Option<Vec<String>>,
    pub create_time: Option<DateTime<Utc>>,
    pub time_in_force: Option<String>,
    pub trade_reduced_id: Option<String>,
    pub state: Option<String>,
    pub trigger_condition: Option<String>,
    pub client_trade_id: Option<String>,
    pub filling_transaction_id: Option<String>,
    pub cancelling_transaction_id: Option<String>,
    pub client_extensions: Option<ClientExtensions>,
    pub otype: Option<String>,
    pub id: Option<String>,
    pub replaced_by_order_id: Option<String>,
}

Fields

filled_time: Option<DateTime<Utc>>

Date/time when the Order was filled (only provided when the Order’s state is FILLED) 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).

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).

replaces_order_id: Option<String>

The ID of the Order that was replaced by this Order (only provided if this Order was created as part of a cancel/replace). format: The string representation of the OANDA-assigned OrderID. OANDA- assigned OrderIDs are positive integers, and are derived from the TransactionID of the Transaction that created the Order.

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.

cancelled_time: Option<DateTime<Utc>>

Date/time when the Order was cancelled (only provided when the state of the Order is CANCELLED) 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).

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.

trade_opened_id: Option<String>

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) 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.

trade_closed_i_ds: Option<Vec<String>>

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)

create_time: Option<DateTime<Utc>>

The time when the Order was created. 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).

time_in_force: Option<String>

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

trade_reduced_id: Option<String>

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) 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.

state: Option<String>

The current state of the Order.

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.

client_trade_id: Option<String>

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

filling_transaction_id: Option<String>

ID of the Transaction that filled this Order (only provided when the Order’s state is FILLED) format: String representation of the numerical OANDA-assigned TransactionID

cancelling_transaction_id: Option<String>

ID of the Transaction that cancelled the Order (only provided when the Order’s state is CANCELLED) format: String representation of the numerical OANDA-assigned TransactionID

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.

otype: Option<String>

The type of the Order. Always set to “TAKE_PROFIT” for Take Profit Orders.

id: Option<String>

The Order’s identifier, unique within the Order’s Account. format: The string representation of the OANDA-assigned OrderID. OANDA- assigned OrderIDs are positive integers, and are derived from the TransactionID of the Transaction that created the Order.

replaced_by_order_id: Option<String>

The ID of the Order that replaced this Order (only provided if this Order was cancelled as part of a cancel/replace). format: The string representation of the OANDA-assigned OrderID. OANDA- assigned OrderIDs are positive integers, and are derived from the TransactionID of the Transaction that created the Order.

Implementations

impl TakeProfitOrder

pub fn new() -> TakeProfitOrder

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

Date/time when the Order was filled (only provided when the Order’s state is FILLED) 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 TakeProfitOrder

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 TakeProfitOrder

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

The ID of the Order that was replaced by this Order (only provided if this Order was created as part of a cancel/replace). format: The string representation of the OANDA-assigned OrderID. OANDA- assigned OrderIDs are positive integers, and are derived from the TransactionID of the Transaction that created the Order.

• param String
• return TakeProfitOrder

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 TakeProfitOrder

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

Date/time when the Order was cancelled (only provided when the state of the Order is CANCELLED) 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 TakeProfitOrder

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 TakeProfitOrder

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

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) 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 TakeProfitOrder

pub fn with_trade_closed_i_ds(self, x: Vec<String>) -> Self

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)

• param Vec
• return TakeProfitOrder

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

The time when the Order was created. 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 TakeProfitOrder

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 TakeProfitOrder

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

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) 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 TakeProfitOrder

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

The current state of the Order.

• param String
• return TakeProfitOrder

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 TakeProfitOrder

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 TakeProfitOrder

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

ID of the Transaction that filled this Order (only provided when the Order’s state is FILLED) format: String representation of the numerical OANDA-assigned TransactionID

• param String
• return TakeProfitOrder

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

ID of the Transaction that cancelled the Order (only provided when the Order’s state is CANCELLED) format: String representation of the numerical OANDA-assigned TransactionID

• param String
• return TakeProfitOrder

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 TakeProfitOrder

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

The type of the Order. Always set to “TAKE_PROFIT” for Take Profit Orders.

• param String
• return TakeProfitOrder

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

The Order’s identifier, unique within the Order’s Account. format: The string representation of the OANDA-assigned OrderID. OANDA- assigned OrderIDs are positive integers, and are derived from the TransactionID of the Transaction that created the Order.

• param String
• return TakeProfitOrder

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

The ID of the Order that replaced this Order (only provided if this Order was cancelled as part of a cancel/replace). format: The string representation of the OANDA-assigned OrderID. OANDA- assigned OrderIDs are positive integers, and are derived from the TransactionID of the Transaction that created the Order.

• param String
• return TakeProfitOrder

Trait Implementations

impl Debug for TakeProfitOrder

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TakeProfitOrder

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TakeProfitOrder

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

where __S: Serializer,

Serialize this value into the given Serde serializer.