oanda-v20-openapi-3.0.25 has been yanked.
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/
Overview
This API client was generated by the OpenAPI Generator project. By using the openapi-spec 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 | PATCH /accounts/{accountId}/configuration | Configure Account |
| AccountApi | get_account | GET /accounts/{accountId} | Account Details |
| AccountApi | get_account_changes | GET /accounts/{accountId}/changes | Poll Account Updates |
| AccountApi | get_account_instruments | GET /accounts/{accountId}/instruments | Account Instruments |
| AccountApi | get_account_summary | GET /accounts/{accountId}/summary | Account Summary |
| AccountApi | get_accounts | GET /accounts | List Accounts |
| InstrumentApi | get_instrument_candles | GET /instruments/{instrument}/candles | Get Candlesticks |
| InstrumentApi | get_instrument_order_book | GET /instruments/{instrument}/orderBook | Get Order Book |
| InstrumentApi | get_instrument_position_book | GET /instruments/{instrument}/positionBook | Get Position Book |
| OrderApi | accounts_account_id_orders_order_specifier_put | PUT /accounts/{accountId}/orders/{orderSpecifier} | Replace Order |
| OrderApi | cancel_order | PUT /accounts/{accountId}/orders/{orderSpecifier}/cancel | Cancel Order |
| OrderApi | create_order | POST /accounts/{accountId}/orders | Create Order |
| OrderApi | get_order | GET /accounts/{accountId}/orders/{orderSpecifier} | Get Order |
| OrderApi | get_orders | GET /accounts/{accountId}/orders | List Orders |
| OrderApi | get_pending_orders | GET /accounts/{accountId}/pendingOrders | Pending Orders |
| OrderApi | set_order_extensions | PUT /accounts/{accountId}/orders/{orderSpecifier}/clientExtensions | Set Order Extensions |
| PositionApi | close_position | PUT /accounts/{accountId}/positions/{instrument}/close | Close Position |
| PositionApi | get_instrument_position | GET /accounts/{accountId}/positions/{instrument} | Instrument Position |
| PositionApi | get_open_positions | GET /accounts/{accountId}/openPositions | Open Positions |
| PositionApi | get_positions | GET /accounts/{accountId}/positions | List Positions |
| PricingApi | get_pricing | GET /accounts/{accountId}/pricing | Current Account Prices |
| TradeApi | close_trade | PUT /accounts/{accountId}/trades/{tradeSpecifier}/close | Close Trade |
| TradeApi | get_open_trades | GET /accounts/{accountId}/openTrades | List Open Trades |
| TradeApi | get_trade | GET /accounts/{accountId}/trades/{tradeSpecifier} | Trade Details |
| TradeApi | get_trades | GET /accounts/{accountId}/trades | List Trades |
| TradeApi | set_trade_extensions | PUT /accounts/{accountId}/trades/{tradeSpecifier}/clientExtensions | Set Trade Client Extensions |
| TradeApi | set_trade_orders | PUT /accounts/{accountId}/trades/{tradeSpecifier}/orders | Set Dependent Orders |
| TransactionApi | get_transaction | GET /accounts/{accountId}/transactions/{transactionId} | Transaction Details |
| TransactionApi | get_transaction_id_range | GET /accounts/{accountId}/transactions/idrange | Transaction ID Range |
| TransactionApi | get_transactions | GET /accounts/{accountId}/transactions | List Transactions |
| TransactionApi | get_transactions_since | GET /accounts/{accountId}/transactions/sinceid | Transactions Since ID |
Documentation For Models
- Account
- AccountChanges
- AccountChangesResponse
- AccountChangesState
- AccountConfigurationBadRequestResponse
- AccountConfigurationForbiddenResponse
- AccountConfigurationRequest
- AccountConfigurationResponse
- AccountCurrency
- AccountGuaranteedStopLossOrderMode
- AccountInstrumentsResponse
- AccountProperties
- AccountResponse
- AccountState
- AccountSummary
- AccountSummaryResponse
- AccountsResponse
- CalculatedPositionState
- CalculatedTradeState
- CancelOrder404Response
- CancelOrderResponse
- CandlesResponse
- Candlestick
- CandlestickData
- CandlestickGranularity
- ClientConfigure
- ClientConfigureRejectTransaction
- ClientConfigureTransaction
- ClientExtensions
- ClientPrice
- ClosePositionBadRequestResponse
- ClosePositionNotFoundResponse
- ClosePositionRequest
- ClosePositionResponse
- CloseTradeBadRequestResponse
- CloseTradeNotFoundResponse
- CloseTradeRequest
- CloseTradeResponse
- CreateOrderBadRequestResponse
- CreateOrderNotFoundResponse
- CreateOrderRequest
- CreateOrderResponse
- DateTimeFormat
- DependentTradeOrdersBadRequestResponse
- DependentTradeOrdersRequest
- DependentTradeOrdersResponse
- DynamicOrderState
- Error400
- Error401
- Error403
- Error404
- Error405
- Error416
- Error4xxBody
- Error4xxTransaction
- HomeConversions
- Instrument
- InstrumentComission
- InstrumentName
- InstrumentOrderBookResponse
- InstrumentPositionBookResponse
- InstrumentPositionResponse
- InstrumentType
- MarketOrder
- MarketOrderDelayedTradeClose
- MarketOrderMarginCloseout
- MarketOrderMarginCloseoutReason
- MarketOrderPositionCloseout
- MarketOrderPositionFill
- MarketOrderReason
- MarketOrderRejectTransaction
- MarketOrderTradeClose
- MarketOrderTransaction
- OpenPositionsResponse
- OpenTradeResponse
- Order
- OrderBook
- OrderBookBucket
- OrderCancel
- OrderCancelReason
- OrderCancelRejectTransaction
- OrderCancelTransaction
- OrderClientExtensionsModify
- OrderClientExtensionsModifyRejectTransaction
- OrderClientExtensionsModifyTransaction
- OrderExtensionsBadRequestResponse
- OrderExtensionsNotFoundResponse
- OrderExtensionsRequest
- OrderExtensionsResponse
- OrderFillReason
- OrderFillTransaction
- OrderResponse
- OrderState
- OrdersResponse
- PendingOrdersResponse
- Position
- PositionBook
- PositionBookBucket
- PositionSide
- PositionsResponse
- PriceBucket
- PriceStatus
- PricingResponse
- QuoteHomeConversionFactors
- RejectTransaction
- RelatedTransaction
- ReplaceOrderBadRequestResponse
- ReplaceOrderNotFoundResponse
- ReplaceOrderRequest
- ReplaceOrderResponse
- StopLossDetails
- StopLossOrder
- StopLossOrderRejectTransaction
- StopLossOrderTransaction
- StopLossOrderTransactionBase
- TakeProfitDetails
- TakeProfitOrder
- TakeProfitOrderRejectTransaction
- TakeProfitOrderTransaction
- TakeProfitOrderTransactionBase
- Trade
- TradeClientExtensionsModify
- TradeClientExtensionsModifyRejectTransaction
- TradeClientExtensionsModifyTransaction
- TradeExtensionsBadRequestResponse
- TradeExtensionsNotFoundResponse
- TradeExtensionsRequest
- TradeExtensionsResponse
- TradeOpen
- TradeOrderBase
- TradeOrderTimeInForce
- TradeOrderTransactionReason
- TradeOrderTriggerCondition
- TradeReduce
- TradeResponse
- TradeState
- TradeSummary
- TradesResponse
- TrailingStopLossDetails
- TrailingStopLossOrder
- TrailingStopLossOrderRejectTransaction
- TrailingStopLossOrderTransaction
- TrailingStopLossOrderTransactionBase
- Transaction
- TransactionHeartbeat
- TransactionIdRangeResponse
- TransactionResponse
- TransactionSinceIdResponse
- TransactionType
- TransactionsResponse
- UnitsAvailable
- UnitsAvailableDetails
To get access to the crate's generated documentation, use:
cargo doc --open