Skip to content

sleeyax/voltra

Repository files navigation

logo

Voltra

A cross-market cryptocurrency volatility trading bot written in go.

Warning

Trading cryptocurrency carries risks. This bot is a tool, not financial advice. Use at your own discretion.

Note

This project has entered its alpha phase. We welcome you to report and/or help resolve any bugs!

build status

Strategy

The bot analyses changes in price of all coins across all supported marketplaces and places trades on the most volatile ones.

Features

  • Supports multiple cryptocurrency marketplaces
  • Highly configurable
    • Configurable stop loss (SL) and take profit (TP)
    • Trailing SL and TP
    • Limit amount of coins to trade
    • Option to include or exclude specific pairs
    • Option to reinvest profits
    • Configurable intervals, trading fees etc.
    • ...
  • Optimized for speed and efficiency
    • Selling and buying coins happens in different goroutines (= lightweight threads)
    • Marketplace API requests are reduced to a minimum
  • Trade history is stored to a (local) database.
  • Production-grade logging
  • Receive status updates via Telegram or Discord - coming very soon!
  • Request a feature!

Supported markets

If you're a developer, you can add support for a new marketplace by implementing the Market interface here. See the Binance implementation as an example. Comment on the relevant issue if you need help.

Getting started

First of all, make sure you have a valid config file. You can use the example config as a starting point:

$ cp config.example.yml config.yml

Open the file in your text editor of choice and edit it according to your preferred trading strategy. Don't forget to at least configure your API keys!

Binaries

The easiest way to get started is by downloading the latest release for your operating system from the releases page. Extract the archive, copy your config file to the same directory and finally run the binary in a terminal/command prompt as follows:

$ ./voltra

Docker

You can run the bot on any platform or cloud provider that supports Docker.

First, pull the latest image from GitHub's container registry as follows:

$ docker pull ghcr.io/sleeyax/voltra:latest
OR click here for instructions to build from source Clone the source code and build the docker image locally:
$ git clone https://github.com/sleeyax/voltra.git
$ cd voltra
$ docker build --tag ghcr.io/sleeyax/voltra:latest .

Then, to run the bot you have the option to run with our without data persistence. When you opt for the latter, any outputted data such as your database will be deleted as soon as the container is removed.

  • With full data persistence:
$ docker run --name voltra --volume ./config.yml:/bot/config.yml:ro --volume ./data:/bot/data -it sleeyax/voltra:latest

Alternatively, you can store your config file in the data directory and only mount that directory:

$ docker run --name voltra --volume ./data:/bot/data -it sleeyax/voltra:latest
  • Without data persistence:
$ docker run --name voltra --volume ./config.yml:/bot/config.yml:ro -it sleeyax/voltra:latest

Credits

Inspired by CyberPunkMetalHead/Binance-volatility-trading-bot and its many forks.