quantconnect / lean.brokerages.atreyu Goto Github PK

This repository hosts the Atreyu Trading 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 can route strategies to almost any market.

LEAN is maintained primarily by QuantConnect, 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.

Atreyu Trading was founded by George Kledaras and John Pyrovolakis in 2015 with the goal to connect quantitative managers to US markets. Atreyu Trading provides access to US prime brokers for clients from all countries that are not on the FinCen Anti-Money Laundering list. In addition to market access, Atreyu Trading provides information about short availability. Atreyu Trading doesn't have regulatory approval to trade for retail accounts, so you need to be a high net worth ($25M+) individual or firm to open an account. You need an organization on the Trading Firm or Institution tier to use the Atreyu Trading brokerage.

You can deploy using a visual interface in the QuantConnect Cloud. For more information see the QuantConnect-Atreyu Integration Page.

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.

Additionally, Atreyu Trading is sponsoring infrastructure costs for users of the QuantConnect cloud platform.

Follow these steps to start local live trading with the Atreyu brokerage:

1. Open a terminal in your CLI root directory.

2. Run lean live "<projectName>" to start a live deployment wizard for the project in ./<projectName> 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 Atreyu module.

   $ lean live "My Project" 
   
   Select the organization with the Atreyu module subscription:
   1. Organization 1
   2. Organization 2
   3. Organization 3
      Enter an option: 1
   

4. Enter the Atreyu Trading server configuration.

   $ lean live "My Project"
   
   Host:
   Request port:
   Subscribe port: 
   

5. Enter your Atreyu Trading credentials.

   $ lean live "My Project"
   
   Username:
   Password:
   Client id: 
   

6. Enter the broker MPID to use.

   $ lean live "My Project" 
   

Broker MPID:

7. Enter the locate rqd to use.

   $ lean live "My Project"
   
   Locate rqd: 
   

8. 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 for set up instructions.
If you select Polygon Data Feed, see Polygon for set up instructions.

9. View the result in the <projectName>/live/<timestamp> directory. Results are stored in real-time in JSON format. You can save results to a different directory by providing the --output <path> option in step 2.

If you already have a live environment configured in your Lean configuration file, you can skip the interactive wizard by providing the --environment <value> option in step 2. The value of this option must be the name of an environment which has live-mode set to true.

Atreyu Trading supports cash and margin accounts.

Atreyu Trading supports trading US Equities and the following order types:

• Market Order
• Limit Order
• Market-On-Close Order

For local deployment, the algorithm needs to download the following dataset:

US Equities Security Master provided by QuantConnect
US Coarse Universe
Atreyu Trading does not provide historical data.

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.Atreyu, AccountType.Cash);
SetBrokerageModel(BrokerageName.Atreyu, AccountType.Margin);

Read Documentation

We model the order fees of Atreyu Trading, which are $0.0035/share.

We model buying power and margin calls to ensure your algorithm stays within the margin requirements.

Read Documentation

Atreyu Trading allows up to 2x leverage for margin accounts.

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

Orders through Atreyu Trading do not experience slippage in backtests. In live trading, your orders may experience slippage.

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.

Atreyu Trading provides short availability information through the AtreyuShortableProvider. If you try to short an Equity when there are no shares available to borrow, your order is invalidated.

If you trade with a margin account, trades settle immediately. If you trade with a cash account, Equity trades settle 3 days after the transaction date (T+3)

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

We ask that our users adhere to the community code of conduct to ensure QuantConnect remains a safe, healthy environment for high quality quantitative trading discussions.

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

http://www.apache.org/licenses/LICENSE-2.0

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.