Ninjabot CLI

This page describes how to install and use Ninjabot CLI to download historical data for backtesting.
Categories:

Ninjabot CLI provides utilities commands to support backtesting and bot development.

Installation

You can install CLI with the following command

go install github.com/rodrigo-brito/ninjabot/cmd/ninjabot@latest

Or downloading pre-build binaries in release page.

Helper (ninjabot -h)

NAME:
   ninjabot - Utilities for bot creation

USAGE:
   ninjabot [global options] command [command options] [arguments...]

COMMANDS:
   download  Download historical data
   help, h   Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h  show help (default: false)

We have the following commands:

  • download: Download historical data from the binace exchange.

Download Command

NAME:
   download - Download historical data

USAGE:
   download [command options] [arguments...]

OPTIONS:
   --pair value, -p value       eg. BTCUSDT
   --days value, -d value       eg. 100 (default 30 days) (default: 0)
   --start value, -s value      eg. 2021-12-01 (default: <nil>)
   --end value, -e value        eg. 2020-12-31 (default: <nil>)
   --timeframe value, -t value  eg. 1h
   --output value, -o value     eg. ./btc.csv
   --futures, -f                true or false (default: false)
   --help, -h                   show help (default: false)

--pair, --timeframe and --output are required. --start and --end must be informed together, and they take precedence over --days. Without any of them, the last month is downloaded.

Examples of Usage

  • Downloading 30 days of historical data for the BTC/USDT pair with 1d timeframe:
ninjabot download --pair BTCUSDT --timeframe 1d --days 30 --output ./btc-1d.csv
  • Downloading historical data for the BTC/USDT pair with 1h timeframe and from 2020-12-01 to 2020-12-31:
ninjabot download -p BTCUSDT -t 1h -s "2020-12-01" -e "2020-12-31" -o ./btc-1h.csv
  • Downloading historical data from the futures market, with the --futures flag:
ninjabot download -p BTCUSDT -t 1h -d 30 -o ./btc-1h.csv --futures

The generated CSV can be loaded with exchange.NewCSVFeed, and resampled to the timeframe of your strategy - a 1h dataset can feed a 4h strategy, for example.