Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Gunbot Quickstart Guide
This guide describes the essential steps to get up and running with Gunbot, using the built-in GUI.
If you prefer running Gunbot without the GUI, you need to edit the
config.jsfile with a text editor to get started. This is the only configuration file for Gunbot that requires any modification. The config.js file is where you add your exchange keys, edit your bot settings, strategies and add trading pairs. Config.js and the GUI are not mutually exclusive: if you edit your settings through the the GUI these will be detected automatically and config.js will be updated accordingly.
1. Download Gunbot
Download your copy of Gunbot:
Gunbot Standard edition and higher: https://github.com/GuntharDeNiro/BTCT/releases
Gunbot Starter edition: https://github.com/GuntharDeNiro/Gunthy/releases/
2. Unpack & install
Gunbot has an easy installation process: you only need to unpack the zip file to a new folder.
Instructions per operating system:
After installing, you can login to the GUI by opening
localhost:5000 in a browser on the same system (modern browsers recommended, preferably Chrome or Firefox).
3. Connect to an exchange
To be able to trade, you need to enter the exchange API key and secret. To enter these in the Gunbot GUI, go to Settings > Trading > Exchanges.
Select your exchange and fill in all the fields for this exchange.
- Master Key: the API key registered to be used with Gunbot. This key may have read only access as long as you use a different Key for actual trading.
- Master Secret: The API secret for the Master Key.
- Key: The API key used for trading, can be the same as Master Key. This key must exist in the same exchange account as the Master Key.
- Secret: The API secret for the Key.
- Delay: The delay factor (in seconds) for processing pairs on this exchange. Setting this to 10 should work in almost all cases, you can lower it later to speed up pair processing after you've verified that everything works.
4. Configure a trading strategy
Before you start trading with Gunbot you'll need to configure a trading strategy to later assign to a trading pair. Do this, go to Settings > Strategies > Strategy Configurator.
The easiest option to begin with, and learn how Gunbot works, is with the Emotionless: strategy. Make sure that the balance settings reflect the amount of base currency Gunbot is allowed to use for each buy order and that the correct trading fees are set.
5. Add trading pairs
Add one or more trading pairs and assign them the strategy you configured in the previous step. To do so, go to Settings > Trading > Trading Pairs.
6. Start trading
To start trading the configured pairs, click on the START BOT CORE button on the Settings page.
To monitor your Gunbot, go to the Dashboard. It can take a small moment for data to appear on the dashboard after starting the bot core. Refresh the dashboard after a few seconds if it's empty at first.
Make sure to keep the computer Gunbot runs on powered on. It will not be able to trade when the computer is off or in sleep/hibernation mode. You can safely close the browser and Gunbot will continue to run in the background.
7. Making changes
When you want to make any changes such as adding a new trading pair, be aware that the settings take effect immediately.
If you intend to make numerous changes and don’t wish these to take effect straight away, make sure to stop the bot core first on the Settings page.