Skip to content

Latest commit

 

History

History
93 lines (68 loc) · 4.11 KB

README.md

File metadata and controls

93 lines (68 loc) · 4.11 KB

roboquant logo

PyPI - Version PyPI - License PyPI - Python Version PyPI - Status GitHub Actions Workflow Status discord

Roboquant is an open-source algorithmic trading platform. It is flexible, user-friendly and completely free to use. It is designed for anyone serious about algo-trading.

So whether you are a beginning retail trader or an established trading firm, roboquant can help you to develop robust and fully automated trading strategies. You can find out more at roboquant.org.

Usage

The following code snippet shows the steps required to run a full back-test on a number of stocks.

import roboquant as rq

feed = rq.feeds.YahooFeed("JPM", "IBM", "F", start_date="2000-01-01")
strategy = rq.strategies.EMACrossover()
account = rq.run(feed, strategy)
print(account)

Install

Roboquant can be installed like most other Python packages, using pip or conda. Make sure you have Python version 3.11 or higher installed.

python3 -m pip install --upgrade roboquant

If you don't want to install anything locally, you can try out roboquant in an online Jupyter environment like Open In Colab or Binder.

The core of roboquant limits the number of dependencies. But you can install roboquant including one or more of the optional dependencies if you require certain functionality:

# market data from Yahoo Finance using the YahooFeed
python3 -m pip install --upgrade "roboquant[yahoo]"

# PyTorch based strategies using RNNStrategy
python3 -m pip install --upgrade "roboquant[torch]"

# Integration with Interactive Brokers using IBKRBroker
python3 -m pip install --upgrade "roboquant[ibkr]"

# Install all dependencies
python3 -m pip install --upgrade "roboquant[all]"

Building from source

Although this first step isn't required, it is recommended to create a virtual environment. Go to the directory where you have downloaded the source code and run the following commands:

python3 -m venv .venv
source .venv/bin/activate

You should now be in the virtual environment and ready to install the required packages and build/install roboquant:

pip install -r requirements.txt
python -m build
pip install .

Some other useful commands:

# run the unit tests
python -m unittest discover -s tests/unit 

# validate the code
flake8 roboquant tests

License

Roboquant is made available under the Apache 2.0 license. You can read more about the Apache 2.0 license on this page: https://www.apache.org/licenses/LICENSE-2.0.html

Disclaimer

Absolutely no warranty is implied with this product. Use at your own risk. I provide no guarantee that it will be profitable, or that it won't lose all your money very quickly or does not contain bugs.

All financial trading offers the possibility of loss. Leveraged trading, may result in you losing all your money, and still owing more. Back tested results are no guarantee of future performance. I can take no responsibility for any losses caused by live trading using roboquant. Use at your own risk. I am not registered or authorised by any financial regulator.

Kotlin version

Next to this Python version of roboquant, there is also a Kotlin version available. Both share a similar API, just the used computer language is different. Which one to use depends very much on personal preferences, skills and usage.