oanda-v20-openapi 3.0.25

The full OANDA v20 API Specification. This specification defines how to interact with v20 Accounts, Trades, Orders, Pricing and more.
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228

# Rust API client for oanda-v20-openapi

The full OANDA v20 API Specification. This specification defines how to interact with v20 Accounts, Trades, Orders, Pricing and more.

For more information, please visit [http://developer.oanda.com/rest-live-v20/introduction/](http://developer.oanda.com/rest-live-v20/introduction/)

## Overview

This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.

- API version: 3.0.25
- Package version: 3.0.25
- Generator version: 7.14.0
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`

## Installation

Put the package under your project folder in a directory named `oanda-v20-openapi` and add the following to `Cargo.toml` under `[dependencies]`:

```
oanda-v20-openapi = { path = "./oanda-v20-openapi" }
```

## Documentation for API Endpoints

All URIs are relative to *https://api-fxpractice.oanda.com/v3*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AccountApi* | [**configure_account**](docs/AccountApi.md#configure_account) | **PATCH** /accounts/{accountId}/configuration | Configure Account
*AccountApi* | [**get_account**](docs/AccountApi.md#get_account) | **GET** /accounts/{accountId} | Account Details
*AccountApi* | [**get_account_changes**](docs/AccountApi.md#get_account_changes) | **GET** /accounts/{accountId}/changes | Poll Account Updates
*AccountApi* | [**get_account_instruments**](docs/AccountApi.md#get_account_instruments) | **GET** /accounts/{accountId}/instruments | Account Instruments
*AccountApi* | [**get_account_summary**](docs/AccountApi.md#get_account_summary) | **GET** /accounts/{accountId}/summary | Account Summary
*AccountApi* | [**get_accounts**](docs/AccountApi.md#get_accounts) | **GET** /accounts | List Accounts
*InstrumentApi* | [**get_instrument_candles**](docs/InstrumentApi.md#get_instrument_candles) | **GET** /instruments/{instrument}/candles | Get Candlesticks
*InstrumentApi* | [**get_instrument_order_book**](docs/InstrumentApi.md#get_instrument_order_book) | **GET** /instruments/{instrument}/orderBook | Get Order Book
*InstrumentApi* | [**get_instrument_position_book**](docs/InstrumentApi.md#get_instrument_position_book) | **GET** /instruments/{instrument}/positionBook | Get Position Book
*OrderApi* | [**accounts_account_id_orders_order_specifier_put**](docs/OrderApi.md#accounts_account_id_orders_order_specifier_put) | **PUT** /accounts/{accountId}/orders/{orderSpecifier} | Replace Order
*OrderApi* | [**cancel_order**](docs/OrderApi.md#cancel_order) | **PUT** /accounts/{accountId}/orders/{orderSpecifier}/cancel | Cancel Order
*OrderApi* | [**create_order**](docs/OrderApi.md#create_order) | **POST** /accounts/{accountId}/orders | Create Order
*OrderApi* | [**get_order**](docs/OrderApi.md#get_order) | **GET** /accounts/{accountId}/orders/{orderSpecifier} | Get Order
*OrderApi* | [**get_orders**](docs/OrderApi.md#get_orders) | **GET** /accounts/{accountId}/orders | List Orders
*OrderApi* | [**get_pending_orders**](docs/OrderApi.md#get_pending_orders) | **GET** /accounts/{accountId}/pendingOrders | Pending Orders
*OrderApi* | [**set_order_extensions**](docs/OrderApi.md#set_order_extensions) | **PUT** /accounts/{accountId}/orders/{orderSpecifier}/clientExtensions | Set Order Extensions
*PositionApi* | [**close_position**](docs/PositionApi.md#close_position) | **PUT** /accounts/{accountId}/positions/{instrument}/close | Close Position
*PositionApi* | [**get_instrument_position**](docs/PositionApi.md#get_instrument_position) | **GET** /accounts/{accountId}/positions/{instrument} | Instrument Position
*PositionApi* | [**get_open_positions**](docs/PositionApi.md#get_open_positions) | **GET** /accounts/{accountId}/openPositions | Open Positions
*PositionApi* | [**get_positions**](docs/PositionApi.md#get_positions) | **GET** /accounts/{accountId}/positions | List Positions
*PricingApi* | [**get_pricing**](docs/PricingApi.md#get_pricing) | **GET** /accounts/{accountId}/pricing | Current Account Prices
*TradeApi* | [**close_trade**](docs/TradeApi.md#close_trade) | **PUT** /accounts/{accountId}/trades/{tradeSpecifier}/close | Close Trade
*TradeApi* | [**get_open_trades**](docs/TradeApi.md#get_open_trades) | **GET** /accounts/{accountId}/openTrades | List Open Trades
*TradeApi* | [**get_trade**](docs/TradeApi.md#get_trade) | **GET** /accounts/{accountId}/trades/{tradeSpecifier} | Trade Details
*TradeApi* | [**get_trades**](docs/TradeApi.md#get_trades) | **GET** /accounts/{accountId}/trades | List Trades
*TradeApi* | [**set_trade_extensions**](docs/TradeApi.md#set_trade_extensions) | **PUT** /accounts/{accountId}/trades/{tradeSpecifier}/clientExtensions | Set Trade Client Extensions
*TradeApi* | [**set_trade_orders**](docs/TradeApi.md#set_trade_orders) | **PUT** /accounts/{accountId}/trades/{tradeSpecifier}/orders | Set Dependent Orders
*TransactionApi* | [**get_transaction**](docs/TransactionApi.md#get_transaction) | **GET** /accounts/{accountId}/transactions/{transactionId} | Transaction Details
*TransactionApi* | [**get_transaction_id_range**](docs/TransactionApi.md#get_transaction_id_range) | **GET** /accounts/{accountId}/transactions/idrange | Transaction ID Range
*TransactionApi* | [**get_transactions**](docs/TransactionApi.md#get_transactions) | **GET** /accounts/{accountId}/transactions | List Transactions
*TransactionApi* | [**get_transactions_since**](docs/TransactionApi.md#get_transactions_since) | **GET** /accounts/{accountId}/transactions/sinceid | Transactions Since ID


## Documentation For Models

 - [Account](docs/Account.md)
 - [AccountChanges](docs/AccountChanges.md)
 - [AccountChangesResponse](docs/AccountChangesResponse.md)
 - [AccountChangesState](docs/AccountChangesState.md)
 - [AccountConfigurationBadRequestResponse](docs/AccountConfigurationBadRequestResponse.md)
 - [AccountConfigurationForbiddenResponse](docs/AccountConfigurationForbiddenResponse.md)
 - [AccountConfigurationRequest](docs/AccountConfigurationRequest.md)
 - [AccountConfigurationResponse](docs/AccountConfigurationResponse.md)
 - [AccountCurrency](docs/AccountCurrency.md)
 - [AccountGuaranteedStopLossOrderMode](docs/AccountGuaranteedStopLossOrderMode.md)
 - [AccountInstrumentsResponse](docs/AccountInstrumentsResponse.md)
 - [AccountProperties](docs/AccountProperties.md)
 - [AccountResponse](docs/AccountResponse.md)
 - [AccountState](docs/AccountState.md)
 - [AccountSummary](docs/AccountSummary.md)
 - [AccountSummaryResponse](docs/AccountSummaryResponse.md)
 - [AccountsResponse](docs/AccountsResponse.md)
 - [CalculatedPositionState](docs/CalculatedPositionState.md)
 - [CalculatedTradeState](docs/CalculatedTradeState.md)
 - [CancelOrder404Response](docs/CancelOrder404Response.md)
 - [CancelOrderResponse](docs/CancelOrderResponse.md)
 - [CandlesResponse](docs/CandlesResponse.md)
 - [Candlestick](docs/Candlestick.md)
 - [CandlestickData](docs/CandlestickData.md)
 - [CandlestickGranularity](docs/CandlestickGranularity.md)
 - [ClientConfigure](docs/ClientConfigure.md)
 - [ClientConfigureRejectTransaction](docs/ClientConfigureRejectTransaction.md)
 - [ClientConfigureTransaction](docs/ClientConfigureTransaction.md)
 - [ClientExtensions](docs/ClientExtensions.md)
 - [ClientPrice](docs/ClientPrice.md)
 - [ClosePositionBadRequestResponse](docs/ClosePositionBadRequestResponse.md)
 - [ClosePositionNotFoundResponse](docs/ClosePositionNotFoundResponse.md)
 - [ClosePositionRequest](docs/ClosePositionRequest.md)
 - [ClosePositionResponse](docs/ClosePositionResponse.md)
 - [CloseTradeBadRequestResponse](docs/CloseTradeBadRequestResponse.md)
 - [CloseTradeNotFoundResponse](docs/CloseTradeNotFoundResponse.md)
 - [CloseTradeRequest](docs/CloseTradeRequest.md)
 - [CloseTradeResponse](docs/CloseTradeResponse.md)
 - [CreateOrderBadRequestResponse](docs/CreateOrderBadRequestResponse.md)
 - [CreateOrderNotFoundResponse](docs/CreateOrderNotFoundResponse.md)
 - [CreateOrderRequest](docs/CreateOrderRequest.md)
 - [CreateOrderResponse](docs/CreateOrderResponse.md)
 - [DateTimeFormat](docs/DateTimeFormat.md)
 - [DependentTradeOrdersBadRequestResponse](docs/DependentTradeOrdersBadRequestResponse.md)
 - [DependentTradeOrdersRequest](docs/DependentTradeOrdersRequest.md)
 - [DependentTradeOrdersResponse](docs/DependentTradeOrdersResponse.md)
 - [DynamicOrderState](docs/DynamicOrderState.md)
 - [Error400](docs/Error400.md)
 - [Error401](docs/Error401.md)
 - [Error403](docs/Error403.md)
 - [Error404](docs/Error404.md)
 - [Error405](docs/Error405.md)
 - [Error416](docs/Error416.md)
 - [Error4xxBody](docs/Error4xxBody.md)
 - [Error4xxTransaction](docs/Error4xxTransaction.md)
 - [HomeConversions](docs/HomeConversions.md)
 - [Instrument](docs/Instrument.md)
 - [InstrumentComission](docs/InstrumentComission.md)
 - [InstrumentName](docs/InstrumentName.md)
 - [InstrumentOrderBookResponse](docs/InstrumentOrderBookResponse.md)
 - [InstrumentPositionBookResponse](docs/InstrumentPositionBookResponse.md)
 - [InstrumentPositionResponse](docs/InstrumentPositionResponse.md)
 - [InstrumentType](docs/InstrumentType.md)
 - [MarketOrder](docs/MarketOrder.md)
 - [MarketOrderDelayedTradeClose](docs/MarketOrderDelayedTradeClose.md)
 - [MarketOrderMarginCloseout](docs/MarketOrderMarginCloseout.md)
 - [MarketOrderMarginCloseoutReason](docs/MarketOrderMarginCloseoutReason.md)
 - [MarketOrderPositionCloseout](docs/MarketOrderPositionCloseout.md)
 - [MarketOrderPositionFill](docs/MarketOrderPositionFill.md)
 - [MarketOrderReason](docs/MarketOrderReason.md)
 - [MarketOrderRejectTransaction](docs/MarketOrderRejectTransaction.md)
 - [MarketOrderTradeClose](docs/MarketOrderTradeClose.md)
 - [MarketOrderTransaction](docs/MarketOrderTransaction.md)
 - [OpenPositionsResponse](docs/OpenPositionsResponse.md)
 - [OpenTradeResponse](docs/OpenTradeResponse.md)
 - [Order](docs/Order.md)
 - [OrderBook](docs/OrderBook.md)
 - [OrderBookBucket](docs/OrderBookBucket.md)
 - [OrderCancel](docs/OrderCancel.md)
 - [OrderCancelReason](docs/OrderCancelReason.md)
 - [OrderCancelRejectTransaction](docs/OrderCancelRejectTransaction.md)
 - [OrderCancelTransaction](docs/OrderCancelTransaction.md)
 - [OrderClientExtensionsModify](docs/OrderClientExtensionsModify.md)
 - [OrderClientExtensionsModifyRejectTransaction](docs/OrderClientExtensionsModifyRejectTransaction.md)
 - [OrderClientExtensionsModifyTransaction](docs/OrderClientExtensionsModifyTransaction.md)
 - [OrderExtensionsBadRequestResponse](docs/OrderExtensionsBadRequestResponse.md)
 - [OrderExtensionsNotFoundResponse](docs/OrderExtensionsNotFoundResponse.md)
 - [OrderExtensionsRequest](docs/OrderExtensionsRequest.md)
 - [OrderExtensionsResponse](docs/OrderExtensionsResponse.md)
 - [OrderFillReason](docs/OrderFillReason.md)
 - [OrderFillTransaction](docs/OrderFillTransaction.md)
 - [OrderResponse](docs/OrderResponse.md)
 - [OrderState](docs/OrderState.md)
 - [OrdersResponse](docs/OrdersResponse.md)
 - [PendingOrdersResponse](docs/PendingOrdersResponse.md)
 - [Position](docs/Position.md)
 - [PositionBook](docs/PositionBook.md)
 - [PositionBookBucket](docs/PositionBookBucket.md)
 - [PositionSide](docs/PositionSide.md)
 - [PositionsResponse](docs/PositionsResponse.md)
 - [PriceBucket](docs/PriceBucket.md)
 - [PriceStatus](docs/PriceStatus.md)
 - [PricingResponse](docs/PricingResponse.md)
 - [QuoteHomeConversionFactors](docs/QuoteHomeConversionFactors.md)
 - [RejectTransaction](docs/RejectTransaction.md)
 - [RelatedTransaction](docs/RelatedTransaction.md)
 - [ReplaceOrderBadRequestResponse](docs/ReplaceOrderBadRequestResponse.md)
 - [ReplaceOrderNotFoundResponse](docs/ReplaceOrderNotFoundResponse.md)
 - [ReplaceOrderRequest](docs/ReplaceOrderRequest.md)
 - [ReplaceOrderResponse](docs/ReplaceOrderResponse.md)
 - [StopLossDetails](docs/StopLossDetails.md)
 - [StopLossOrder](docs/StopLossOrder.md)
 - [StopLossOrderRejectTransaction](docs/StopLossOrderRejectTransaction.md)
 - [StopLossOrderTransaction](docs/StopLossOrderTransaction.md)
 - [StopLossOrderTransactionBase](docs/StopLossOrderTransactionBase.md)
 - [TakeProfitDetails](docs/TakeProfitDetails.md)
 - [TakeProfitOrder](docs/TakeProfitOrder.md)
 - [TakeProfitOrderRejectTransaction](docs/TakeProfitOrderRejectTransaction.md)
 - [TakeProfitOrderTransaction](docs/TakeProfitOrderTransaction.md)
 - [TakeProfitOrderTransactionBase](docs/TakeProfitOrderTransactionBase.md)
 - [Trade](docs/Trade.md)
 - [TradeClientExtensionsModify](docs/TradeClientExtensionsModify.md)
 - [TradeClientExtensionsModifyRejectTransaction](docs/TradeClientExtensionsModifyRejectTransaction.md)
 - [TradeClientExtensionsModifyTransaction](docs/TradeClientExtensionsModifyTransaction.md)
 - [TradeExtensionsBadRequestResponse](docs/TradeExtensionsBadRequestResponse.md)
 - [TradeExtensionsNotFoundResponse](docs/TradeExtensionsNotFoundResponse.md)
 - [TradeExtensionsRequest](docs/TradeExtensionsRequest.md)
 - [TradeExtensionsResponse](docs/TradeExtensionsResponse.md)
 - [TradeOpen](docs/TradeOpen.md)
 - [TradeOrderBase](docs/TradeOrderBase.md)
 - [TradeOrderTimeInForce](docs/TradeOrderTimeInForce.md)
 - [TradeOrderTransactionReason](docs/TradeOrderTransactionReason.md)
 - [TradeOrderTriggerCondition](docs/TradeOrderTriggerCondition.md)
 - [TradeReduce](docs/TradeReduce.md)
 - [TradeResponse](docs/TradeResponse.md)
 - [TradeState](docs/TradeState.md)
 - [TradeSummary](docs/TradeSummary.md)
 - [TradesResponse](docs/TradesResponse.md)
 - [TrailingStopLossDetails](docs/TrailingStopLossDetails.md)
 - [TrailingStopLossOrder](docs/TrailingStopLossOrder.md)
 - [TrailingStopLossOrderRejectTransaction](docs/TrailingStopLossOrderRejectTransaction.md)
 - [TrailingStopLossOrderTransaction](docs/TrailingStopLossOrderTransaction.md)
 - [TrailingStopLossOrderTransactionBase](docs/TrailingStopLossOrderTransactionBase.md)
 - [Transaction](docs/Transaction.md)
 - [TransactionHeartbeat](docs/TransactionHeartbeat.md)
 - [TransactionIdRangeResponse](docs/TransactionIdRangeResponse.md)
 - [TransactionResponse](docs/TransactionResponse.md)
 - [TransactionSinceIdResponse](docs/TransactionSinceIdResponse.md)
 - [TransactionType](docs/TransactionType.md)
 - [TransactionsResponse](docs/TransactionsResponse.md)
 - [UnitsAvailable](docs/UnitsAvailable.md)
 - [UnitsAvailableDetails](docs/UnitsAvailableDetails.md)


To get access to the crate's generated documentation, use:

```
cargo doc --open
```

## Author

api@oanda.com