Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/quantconnect/lean.brokerages.oanda
OANDA Brokerage Implementation
https://github.com/quantconnect/lean.brokerages.oanda
Last synced: about 1 month ago
JSON representation
OANDA Brokerage Implementation
- Host: GitHub
- URL: https://github.com/quantconnect/lean.brokerages.oanda
- Owner: QuantConnect
- License: apache-2.0
- Created: 2022-03-25T17:54:31.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-22T20:38:43.000Z (4 months ago)
- Last Synced: 2024-08-22T21:51:49.573Z (4 months ago)
- Language: C#
- Size: 260 KB
- Stars: 6
- Watchers: 8
- Forks: 12
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Introduction
This repository hosts the OANDA Brokerage Plugin Integration with the QuantConnect LEAN Algorithmic Trading Engine. LEAN is a brokerage agnostic operating system for quantitative finance. Thanks to open-source plugins such as this [LEAN](https://github.com/QuantConnect/Lean) can route strategies to almost any market.
[LEAN](https://github.com/QuantConnect/Lean) is maintained primarily by [QuantConnect](https://www.quantconnect.com), a US based technology company hosting a cloud algorithmic trading platform. QuantConnect has successfully hosted more than 200,000 live algorithms since 2015, and trades more than $1B volume per month.
### About OANDA
![introduction]()
[OANDA](https://www.oanda.com/) was co-founded by Dr. Stumm, a computer scientist and Dr. Olsen, an economist, in 1997. The company was born out of the belief that the Internet and technology would open up the markets for both currency data and trading. OANDA uses innovative computer and financial technology to provide Internet-based forex trading and currency information services to everyone, from individuals to large corporations, from portfolio managers to financial institutions. OANDA is a market maker and a trusted source for currency data. It has access to one of the world's largest historical, high-frequency, filtered currency databases.
For more information about the OANDA brokerage, see the [QuantConnect-OANDA Integration Page](https://www.quantconnect.com/docs/v2/our-platform/live-trading/brokerages/oanda).
## Using the Brokerage Plugin
### Deploying Oanda with VSCode User Interace
You can deploy using a visual interface in the QuantConnect cloud. For instructions, [QuantConnect-OANDA Integration Page](https://www.quantconnect.com/brokerages/oanda).
In the QuantConnect Cloud Platform, you can harness the QuantConnect Live Data Feed. For most users, this is substantially cheaper and easier than self-hosting.
### Deploying Oanda with LEAN CLI
Follow these steps to start local live trading with the OANDA brokerage:
1. Open a terminal in your [CLI root directory](https://www.quantconnect.com/docs/v2/lean-cli/initialization/directory-structure#02-lean-init).
2. Run `lean live "`" to start a live deployment wizard for the project in ./`` and then enter the brokerage number.
```
$ lean live 'My Project'
Select a brokerage:
1. Paper Trading
2. Interactive Brokers
3. Tradier
4. OANDA
5. Bitfinex
6. Coinbase Pro
7. Binance
8. Zerodha
9. Samco
10. Terminal Link
11. Atreyu
12. Trading Technologies
13. Kraken
14. FTX
Enter an option:
```
3. Enter the number of the organization that has a subscription for the OANDA module.
```
$ lean live "My Project"
Select the organization with the OANDA module subscription:
1. Organization 1
2. Organization 2
3. Organization 3
Enter an option: 1
```
4. Enter your OANDA environment.
```
$ lean live "My Project"
Environment? (Practice, Trade) [Practice]:
```
5. Enter your OANDA credentials.
```
$ lean live "My Project"
Your OANDA account id can be found on your OANDA Account Statement page (https://www.oanda.com/account/statement/). It
follows the following format: ###-###-######-###. You can generate an API token from the Manage API Access page
(https://www.oanda.com/account/tpa/personal_token).
Account id:
Access token:
```
6. Enter the number of the data feed to use and then follow the steps required for the data connection.
```
$ lean live 'My Project'
Select a data feed:
1. Interactive Brokers
2. Tradier
3. Oanda
4. Bitfinex
5. Coinbase Pro
6. Binance
7. Zerodha
8. Samco
9. Terminal Link
10. Trading Technologies
11. Kraken
12. FTX
13. IQFeed
14. Polygon Data Feed
15. Custom Data Only
To enter multiple options, separate them with comma:
```
If you select IQFeed, see [IQFeed](https://www.quantconnect.com/docs/v2/lean-cli/live-trading/other-data-feeds/iqfeed) for set up instructions.
If you select Polygon Data Feed, see [Polygon](https://www.quantconnect.com/docs/v2/lean-cli/live-trading/other-data-feeds/polygon) for set up instructions.
1. View the result in the `/live/` directory. Results are stored in real-time in JSON format. You can save results to a different directory by providing the `--output ` option in step 2.
If you already have a live environment configured in your [Lean configuration file](https://www.quantconnect.com/docs/v2/lean-cli/initialization/configuration#03-Lean-Configuration), you can skip the interactive wizard by providing the `--environment ` option in step 2. The value of this option must be the name of an environment which has `live-mode` set to true.
## Account Types
OANDA supports cash and margin accounts.
## Order Types and Asset Classes
OANDA supports trading Forex and CFDs with the following order types:
- Market Order
- Limit Order
- Stop-Market Order
## Downloading Data
For local deployment, the algorithm needs to download the following dataset:
[FOREX Data](https://www.quantconnect.com/datasets/oanda-forex)
[CFD Data](https://www.quantconnect.com/datasets/oanda-cfd-data)
## Brokerage Model
Lean models the brokerage behavior for backtesting purposes. The margin model is used in live trading to avoid placing orders that will be rejected due to insufficient buying power.
You can set the Brokerage Model with the following statements
```
SetBrokerageModel(BrokerageName.OandaBrokerage, AccountType.Cash);
SetBrokerageModel(BrokerageName.OandaBrokerage, AccountType.Margin);
```
[Read Documentation](https://www.quantconnect.com/docs/v2/our-platform/live-trading/brokerages/oanda)
### Fees
We model the order fees of OANDA, which are $0.
### Margin
We model buying power and margin calls to ensure your algorithm stays within the margin requirements.
[Read Documentation](https://www.quantconnect.com/docs/v2/our-platform/live-trading/brokerages/oanda)
#### Buying Power
OANDA allows up to 50x leverage for margin accounts.
#### Margin Calls
Regulation T margin rules apply. When the amount of margin remaining in your portfolio drops below 5% of the total portfolio value, you receive a [warning](https://www.quantconnect.com/docs/v2/writing-algorithms/reality-modeling/margin-calls#08-Monitor-Margin-Call-Events). When the amount of margin remaining in your portfolio drops to zero or goes negative, the portfolio sorts the generated margin call orders by their unrealized profit and executes each order synchronously until your portfolio is within the margin requirements.
### Slippage
Orders through OANDA do not experience slippage in backtests. In paper trading and live trading, your orders may experience slippage.
### Fills
We fill market orders immediately and completely in backtests. In live trading, if the quantity of your market orders exceeds the quantity available at the top of the order book, your orders are filled according to what is available in the order book.
### Settlements
Trades settle immediately after the transaction.
### Deposits and Withdraws
You can deposit and withdraw cash from your brokerage account while you run an algorithm that's connected to the account. We sync the algorithm's cash holdings with the cash holdings in your brokerage account every day at 7:45 AM Eastern Time (ET).
LEAN Engine is an open-source algorithmic trading engine built for easy strategy research, backtesting, and live trading. We integrate with common data providers and brokerages, so you can quickly deploy algorithmic trading strategies.
The core of the LEAN Engine is written in C#, but it operates seamlessly on Linux, Mac and Windows operating systems. To use it, you can write algorithms in Python 3.8 or C#. QuantConnect maintains the LEAN project and uses it to drive the web-based algorithmic trading platform on the website.
## Contributions
Contributions are warmly very welcomed but we ask you to read the existing code to see how it is formatted, commented and ensure contributions match the existing style. All code submissions must include accompanying tests. Please see the [contributor guide lines](https://github.com/QuantConnect/Lean/blob/master/CONTRIBUTING.md).
## Code of Conduct
We ask that our users adhere to the community [code of conduct](https://www.quantconnect.com/codeofconduct) to ensure QuantConnect remains a safe, healthy environment for
high quality quantitative trading discussions.
## License Model
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You
may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language
governing permissions and limitations under the License.