bot-vox

WARNING:

This application is under development and should NOT be used at this current time!!!

BotVox Introduction

BotVox is a powerful, hackable crypto trading bot that makes it easy for users to get started with automated trading.

It comes with a integrated back testing engine that enables users to test strategies before they deploy them in real-time.

BotVox provides a set of ready-to-use strategies, notifications, and alerts that are ready to use for trading and reference material for user who want to implement their own Strategies.

BotVox does not require users to share or store any API keys, which ensures their security.

BotVox offers a guided command-line interface that can help users create their own strategies, alerts, and notifications easily and quickly.

BotVox is implemented with NodeJS making it easy to set up and use.

Installation

You can install BotVox as a dependency inside your own project

npm install botvox

Or Install it globally to just leverage the CLI interface.

npm install -g botvox

Commandline Interface

If You are using The BotVox Commandline Interface to start some the available Bots and Strategies You need to make yourself familiar with the Common Commandline Arguments across all scopes

Keep in mind Commandline args may vary across different bots additionally some Custom Strategies or Notifications require Additional args so its impossible to list all possible Commandline Arguments in this Document.

Argument	Type	Description
--vox	String	Execution Context (see SimpleVox and VoxEngine to understand this better)
--exchange	String	The Name Of the target exchange(binance, bybit,coinbase etc.)
--symbol	String	The Target Symbol (BTCUSDT,ADAUSDT,ETHUSDT) etc.
--timeframe	String	Timeframe if the Execution Context relies on Candle data from a given timeframe
--amount	Number	The Initial Starting amount of a Base Currency
--profitPct	Number	The Profit Target pct
--fee	Number	The Fee's an Exchange might charge for a trade
--key	String	Your API Key ( This is never Stored or Shared)
--secret	String	Your API Secret ( This is never Stored or Shared)
--life	Boolean	Boolean value to indicate whether this is a life Bot or a Test Bot
--interval	String	Configurable interval to poll and execute the Execution Context

BotVox Comes with a set of available Bots See below Bot Description and examples on how you could start them via the commandline Interface These bots all a common commandline argument set as slight differences.

ByBitMarketMaker

node botvox.js --symbol=ADAUSDT --vox=ByBitMarketMaker --qty=50 --fee=0.01 --spread=0.0009 --key=FAKE_KEY --secret=FAKE_SECRET --life=true

SmartAccumulateVox

node botvox.js --vox=SmartAccumulateVox --exchange=bybit --symbol ADAUSDT --accumulate=quote --amount=50  --profitPct=0.1 --fee=0.01 --key=FAKE_KEY --secret=FAKE_SECRET --life=true

VoxEngine SuperTrend

node botvox.js --vox=VoxEngine --strategy=./extensions/vox-strategies/SuperTrend --backtest=true --exchange=bybit --symbol=ADAUSDT --timeframe=15m --amount=100  --profitPct=0.003 --fee=0.02 --key=FAKE_KEY --secret=FAKE_SECRET --life=true --interval=10

VoxEngine RSITrend

node botvox.js --vox=VoxEngine --sidePreference=biDirectional --strategy=./extensions/vox-strategies/RSITrend --backtest=true --exchange=bybit --symbol=ADAUSDT --timeframe=5m --amount=100  --profitPct=0.01 --fee=0.02 --key=FAKE_KEY --secret=FAKE_SECRET --life=true --interval=1

VoxEngine SmartAccumulate

node botvox.js --vox=VoxEngine --sidePreference=long --strategy=./extensions/vox-strategies/SmartAccumulate --backtest=true --exchange=bybit --symbol=ADAUSDT --timeframe=5m --amount=100  --profitPct=0.003 --fee=0.02 --key=FAKE_KEY --secret=FAKE_SECRET --life=true --interval=10

VoxEngine

This is really the Heart and Soul of BotVox, If you are leveraging the VoxEngine, using, developing and creating Strategies is very Easy The VoxEngine will execute your Strategies and handle all Trading Activities for you based on whatever you define in your Strategies.

SimpleVox

SimpleVox is not really recommended but can be useful to test and create standalone Bots that run independently of the VoxEngine. SimpleVox Execution Context's usually don't require Kline Candle imports or Indicator Data The ByBitMarker and SmartAccumulateVox are good example of simple Vox instances.

SimpleVox Execution Contexts are simple non-complex processes BotVox comes preloaded with a few SimpleVox implementations that are functioning as Utility processes.

• ExchangeDetails
  • Prints out some important information about an Exchange
• Exchanges
  • Prints all available exchanges that can be used
• IndicatorVox
  • Prints out a List of Available Indicators and Candlestick Pattern that can be used inside a Strategy
• TradUtil
  • Utility to calculate Profit Targets, Stop Loss Limits, Show Available Balances etc.

Each of these has somewhat of a utility function baked in thus they are considered SimpleVox Execution Contexts

Strategies & Alert

This is where BotVox differs from many other Trading Bot's Creating Alerts and Strategies is super simple and easy. The Simplicity is achieved by using VoxStates that are validated at the VoxEngineLevel. With just a few lines of code you can Implement complex strategies and Validate them through the VoxEngine Back-testing interface.

Getting Started

BotVox Cli

Install BotVox globally

npm install -g botvox

BotVox inside your Own Project

Advanced Usage

Create a New Strategy

Create a New Alert

Create a new SimpleVox