> For the complete documentation index, see [llms.txt](https://openbot.gitbook.io/project/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://openbot.gitbook.io/project/master.md).

# About

Open bot is an event-driven open source trading bot built with Node.js and RxJS.

![](https://3012758120-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LZg_2UWkwhHXCiUHwTf%2F-L_qlgsOo9PjYP8xO4qM%2F-L_qlnG-f6c6ND290Slp%2FOpenbot_black.e8208c90.svg?alt=media\&token=b739adaf-409b-4800-8920-a5b599fabec8)

* Open-source
* Fully-tested
* Free to use

## With openbot you can:

* Create your custom strategy with [Tulip Indicators](https://tulipindicators.org/)
* Backtest via [cryptowat.ch](https://cryptowat.ch/) API
* Paper trade via Bittrex API
* Live trade via Bittrex API

## Requirements

#### OSX/Linux

* To run open bot you need a Unix bash shell from OSX or Linux. If you are using Microsoft, setup a virtual machine. 

#### Docker

* To run the project you need to install [Docker](https://www.docker.com/) including docker-compose

#### Bittrex

* If you want to run open bot live against Bittrex you need to have `BITTREX_API_KEY` and `BITTREX_API_SECRET` in your path, look at how to [Obtain an API key](https://bittrex.github.io/api/v1-1) under the "Authentication" section.

##