oanda-client 1.1.0

An async, provider-native Rust client for OANDA's v20 REST API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196

//! OANDA v20 position definitions.
// Shared imports vary by definition family; unused ones are deliberately allowed.
#[allow(unused_imports)]
use super::*;
#[allow(unused_imports)]
use crate::ids::*;
#[allow(unused_imports)]
use crate::timestamp::Timestamp;
#[allow(unused_imports)]
use rust_decimal::Decimal;
#[allow(unused_imports)]
use serde::{Deserialize, Serialize};

/// The specification of a Position within an Account.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Position {
    /// The Position’s Instrument.
    #[serde(
        rename = "instrument",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub instrument: Option<InstrumentName>,
    /// Profit/loss realized by the Position over the lifetime of the Account.
    #[serde(rename = "pl", default, skip_serializing_if = "Option::is_none")]
    #[serde(deserialize_with = "crate::decimal_wire::optional_number_or_string")]
    pub pl: Option<Decimal>,
    /// The unrealized profit/loss of all open Trades that contribute to this Position.
    #[serde(
        rename = "unrealizedPL",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    #[serde(deserialize_with = "crate::decimal_wire::optional_number_or_string")]
    pub unrealized_pl: Option<Decimal>,
    /// Margin currently used by the Position.
    #[serde(
        rename = "marginUsed",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    #[serde(deserialize_with = "crate::decimal_wire::optional_number_or_string")]
    pub margin_used: Option<Decimal>,
    /// Profit/loss realized by the Position since the Account’s resettablePL was last reset by the client.
    #[serde(
        rename = "resettablePL",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    #[serde(deserialize_with = "crate::decimal_wire::optional_number_or_string")]
    pub resettable_pl: Option<Decimal>,
    /// The total amount of financing paid/collected for this instrument over the lifetime of the Account.
    #[serde(rename = "financing", default, skip_serializing_if = "Option::is_none")]
    #[serde(deserialize_with = "crate::decimal_wire::optional_number_or_string")]
    pub financing: Option<Decimal>,
    /// The total amount of commission paid for this instrument over the lifetime of the Account.
    #[serde(
        rename = "commission",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    #[serde(deserialize_with = "crate::decimal_wire::optional_number_or_string")]
    pub commission: Option<Decimal>,
    /// The total amount of dividend adjustment paid for this instrument over the lifetime of the Account.
    #[serde(
        rename = "dividendAdjustment",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    #[serde(deserialize_with = "crate::decimal_wire::optional_number_or_string")]
    pub dividend_adjustment: Option<Decimal>,
    /// The total amount of fees charged over the lifetime of the Account for the execution of guaranteed Stop
    /// Loss Orders for this instrument.
    #[serde(
        rename = "guaranteedExecutionFees",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    #[serde(deserialize_with = "crate::decimal_wire::optional_number_or_string")]
    pub guaranteed_execution_fees: Option<Decimal>,
    /// The details of the long side of the Position.
    #[serde(rename = "long", default, skip_serializing_if = "Option::is_none")]
    pub long: Option<PositionSide>,
    /// The details of the short side of the Position.
    #[serde(rename = "short", default, skip_serializing_if = "Option::is_none")]
    pub short: Option<PositionSide>,
}

/// The representation of a Position for a single direction (long or short).
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct PositionSide {
    /// Number of units in the position (negative value indicates short position, positive indicates long
    /// position).
    #[serde(rename = "units", default, skip_serializing_if = "Option::is_none")]
    #[serde(deserialize_with = "crate::decimal_wire::optional_number_or_string")]
    pub units: Option<Decimal>,
    /// Volume-weighted average of the underlying Trade open prices for the Position.
    #[serde(
        rename = "averagePrice",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    #[serde(deserialize_with = "crate::decimal_wire::optional_number_or_string")]
    pub average_price: Option<Decimal>,
    /// List of the open Trade IDs which contribute to the open Position.
    #[serde(rename = "tradeIDs", default, skip_serializing_if = "Option::is_none")]
    pub trade_ids: Option<Vec<TradeID>>,
    /// Profit/loss realized by the PositionSide over the lifetime of the Account.
    #[serde(rename = "pl", default, skip_serializing_if = "Option::is_none")]
    #[serde(deserialize_with = "crate::decimal_wire::optional_number_or_string")]
    pub pl: Option<Decimal>,
    /// The unrealized profit/loss of all open Trades that contribute to this PositionSide.
    #[serde(
        rename = "unrealizedPL",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    #[serde(deserialize_with = "crate::decimal_wire::optional_number_or_string")]
    pub unrealized_pl: Option<Decimal>,
    /// Profit/loss realized by the PositionSide since the Account’s resettablePL was last reset by the client.
    #[serde(
        rename = "resettablePL",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    #[serde(deserialize_with = "crate::decimal_wire::optional_number_or_string")]
    pub resettable_pl: Option<Decimal>,
    /// The total amount of financing paid/collected for this PositionSide over the lifetime of the Account.
    #[serde(rename = "financing", default, skip_serializing_if = "Option::is_none")]
    #[serde(deserialize_with = "crate::decimal_wire::optional_number_or_string")]
    pub financing: Option<Decimal>,
    /// The total amount of dividend adjustment paid for the PositionSide over the lifetime of the Account.
    #[serde(
        rename = "dividendAdjustment",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    #[serde(deserialize_with = "crate::decimal_wire::optional_number_or_string")]
    pub dividend_adjustment: Option<Decimal>,
    /// The total amount of fees charged over the lifetime of the Account for the execution of guaranteed Stop
    /// Loss Orders attached to Trades for this PositionSide.
    #[serde(
        rename = "guaranteedExecutionFees",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    #[serde(deserialize_with = "crate::decimal_wire::optional_number_or_string")]
    pub guaranteed_execution_fees: Option<Decimal>,
}

/// The dynamic (calculated) state of a Position
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CalculatedPositionState {
    /// The Position’s Instrument.
    #[serde(
        rename = "instrument",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub instrument: Option<InstrumentName>,
    /// The Position’s net unrealized profit/loss
    #[serde(
        rename = "netUnrealizedPL",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    #[serde(deserialize_with = "crate::decimal_wire::optional_number_or_string")]
    pub net_unrealized_pl: Option<Decimal>,
    /// The unrealized profit/loss of the Position’s long open Trades
    #[serde(
        rename = "longUnrealizedPL",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    #[serde(deserialize_with = "crate::decimal_wire::optional_number_or_string")]
    pub long_unrealized_pl: Option<Decimal>,
    /// The unrealized profit/loss of the Position’s short open Trades
    #[serde(
        rename = "shortUnrealizedPL",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    #[serde(deserialize_with = "crate::decimal_wire::optional_number_or_string")]
    pub short_unrealized_pl: Option<Decimal>,
    /// Margin currently used by the Position.
    #[serde(
        rename = "marginUsed",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    #[serde(deserialize_with = "crate::decimal_wire::optional_number_or_string")]
    pub margin_used: Option<Decimal>,
}