LoopTrader

An extensible options trading bot built on top of Python.

Generate Convert Improve

Install / Use

npx skills add pattertj/LoopTrader

Installs into whichever agent you are using.

About this skill

Quality Score

0/100

README

<h1 align="center"> <br> <a href="https://github.com/pattertj/LoopTrader/"><img src="https://i.ibb.co/KqRpvVN/stock-exchange-app-2.png" alt="LoopTrader" width="200"></a><br> LoopTrader <br> </h1> <p align="center"> <a href="https://github.com/pattertj/LoopTrader/commits/main"><img src="https://img.shields.io/github/last-commit/pattertj/LoopTrader"></a> <a href="https://github.com/pattertj/LoopTrader/actions/workflows/python-app.yml"><img src="https://img.shields.io/github/workflow/status/pattertj/looptrader/Build?style=flat"></a> <a href="https://github.com/pattertj/LoopTrader/network/members"><img src="https://img.shields.io/github/forks/pattertj/LoopTrader?style=flat"></a> <a href="https://github.com/pattertj/LoopTrader/stargazers"><img src="https://img.shields.io/github/stars/pattertj/LoopTrader?style=flat"></a> <a href="https://github.com/pattertj/LoopTrader/blob/main/LICENSE"><img src="https://img.shields.io/github/license/pattertj/LoopTrader?style=flat"></a> <a href="https://saythanks.io/inbox#badge-modal"><img src="https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg"></a> </p> <h4 align="center">An extensible options trading bot built on top of Python.</h4> <p align="center"> <a href="#description">Description</a> • <a href="#installation">Installation</a> • <a href="#usage">Usage</a> • <a href="#contributing">Contributing</a> • <a href="#license">License</a> </p>

Description

The goal for LoopTrader is to provide a flexible engine for running one or more option trading strategies in real-time against provided broker API's. The Key Features include:

Simple to setup and run multiple trading bots
Extensibility for various brokers, trading strategies, and logging patterns
Local storage for trades and orders (In Progress)
Support for notifications and interactions through tools like Telegram

<b>LoopTrader is very much a work in progress and is currently not feature complete. See the Issues for what remains open, or to make a suggestion.</b>

Installation

Getting up and running with LoopTrader is just a few commands:

# Clone LoopTrader
git clone https://github.com/pattertj/LoopTrader.git

# Install dependencies
pipenv install --dev

# Setup pre-commit and pre-push hooks
pipenv run pre-commit install -t pre-commit
pipenv run pre-commit install -t pre-push

More detailed instructions on specific components can be found in the wiki.

Usage

Currently all configuration of LoopTrader is done in the code when creating the bot in main.py, the .env, and config.yaml file. A sample .env and .yaml file are provided, but should be renamed to ".env" and "config.yaml" respectively, with the configuration variables populated.