Blog Post

Read more about Whale's Secret.

Running Whale's Secret Bots — Step-by-Step Guide

How to run Whale's Secret bots? This tutorial will guide you through all the steps necessary to successfully run the trading bot of your choice. It includes instructions on obtaining the bot, downloading it, configuring it, and executing it.

Table of Contents

Sign In

To get a trading bot, you need to register a Whale's Secret account. You simply enter your email address and click “Send Sign-In Link” and we will send you a sign-in link to your email.

Enter your email address and press the button. We will send you the sign-in link to your email.

Get Trading Bot

Whale's Secret trading bots are divided into three categories:

Currently, Free Trading Bots and Exclusive-with-license Trading Bots are available. So, once you have an account, you can visit the Free Trading Bots page to choose the bot you want to install. And if you decide to buy a Whale's Secret license, you will also be able to access Exclusive-with-license Trading Bots for no extra charge.

Navigate to Free Trading Bots page.

Click the Install button:

Click “Install” to add the bot to your account.

You will be redirected to Trading Bots section in the user area and you will be informed that the selected bot has been added to your account.

The selected trading bot has been added to the user's area.

Download Binaries

Click the details icon on the right side to show the download links for the selected trading bot.

After clicking on the document icon, the list of download links appears.

Click the link for the binaries that matches your operating-system platform:

  • win-x86 is for 32-bit Windows systems,
  • win-x64 is for 64-bit Windows systems,
  • linux-x64 is for 64-bit linux systems,
  • osx-x64 is for Intel-powered macOS devices,
  • osx-arm64 is for Apple-Silicon-powered (M1, M2, M3) macOS devices.

This will initiate downloading of the archive with the selected binaries.

Extract the contents of the archive to your preferred location on your computer. If you are unsure how to do that, read How to Uncompress Archives, which explains how to do this operation on different systems.

Configure License and API Keys

The ZIP archive with the bot binaries contains a configuration file called input.json. You need to modify this file using a text editor. The configuration file contains both settings of the trading bot strategy (see the next section below) and configuration of the license and API keys under the “System” section. By default, you should see the system template: 

"System": {
    "License": "INSERT YOUR WHALES SECRET LICENSE HERE OR USE null TO USE FREE MODE",
    "AppDataPath": "Data",
    "Telegram": {
      "GroupId": "INSERT YOUR TELEGRAM GROUP ID HERE",
      "ApiToken": "INSERT YOUR BOT'S Telegram API token"
    },
    "ApiKeys": {
      "Binance": {
        "HmacKey": "INSERT YOUR Binance HMAC API key HERE OR USE null TO USE RSA key",
        "HmacSecret": "INSERT YOUR Binance HMAC API key HERE OR USE null TO USE RSA key",
        "RsaKey": "INSERT YOUR Binance RSA API key HERE OR USE null TO USE HMAC key",
        "RsaSecret": "INSERT YOUR Binance RSA API secret OR USE null TO USE HMAC key"
      },
      "Kucoin": {
        "Key": "INSERT YOUR Kucoin API key HERE",
        "Secret": "INSERT YOUR Kucoin API secret HERE",
        "Passphrase": "INSERT YOUR Kucoin API passphrase HERE"
      }
    }
  },

License

The License configuration property is for your Whale's Secret license, if you have one. You can use the bot without Whale's Secret license, in which case you need to change this setting to null as follows: 

"License": null,

In that case you will use so called Free Mode. For more information about its restrictions, see the Whale's Secret ScriptApiLib license.

If you have purchased a license, simply put the hexadecimal license string there.

Application Data Path

The AppDataPath setting specifies a name of the directory where the bot will store its data. You do not need to change it for the bot to operate correctly.

Telegram

The Telegram configuration section allows you to configure your access to Telegram channel to which the bot will send its notifications. If you do not want the bot to report to Telegram, set this null as follows: 

"Telegram": null,

If you want to connect to Telegram you have to specify the GroupId of the channel where the bot will report and the Telegram bot's ApiToken. If you are unsure where to get these values, read our blog post Trading Bot in C# — Part 2 — Notifications.

API Keys

In the ApiKeys section you need to fill in your API keys for the exchange on which you want the bot to operate. API key settings for other exchanges can be set to null. For example, if you intend to run the bot on KuCoin, you set Binance settings to null: 

"Binance": null,

In case of Binance, we support two different types of API key types — HMAC and RSA. You will only use a single key, and remove the settings for the other. For example, if you have an HMAC API key, your settings will look like this: 

"Binance": {
  "HmacKey": "YOUR KEY",
  "HmacSecret": "YOUR SECRET",
},

If you are unsure about how to create API keys for your Binance account, please read How to Create API Keys on Binance? article in Binance's Support Center.

In case of KuCoin, all three values (key, secret, and passphrase), have to be entered correctly. If you need help with creating API keys on KuCoin, please read the FAQ section of KuCoin API page.

Adjust Settings

Besides the system settings, the configuration file also contains settings related to the trading bot's strategy. Refer to the documentation of each bot or contact Whale's Secret support if you need help with configuring your bot.

Run Trading Bot

The name of the main executable is the first part of the name of the zip file you downloaded. For example, if you downloaded WsBotDca.osx-arm64.zip, the name of the main executable is WsBotDca. On Windows, the main executable file has .exe file extension.

Extra Step for linux and macOS

On linux and macOS systems, after extracting files from the archive, you must ensure that the main executable file is allowed to be executed. To ensure you can execute it, run chmod command in your shell: 

chmod +x ./WsBotDca

Run It

Open a command prompt (shell). On Windows, this can be cmd.exe or PowerShell, on linux and macOS, this can be Terminal, Bash etc. Navigate to the directory with the main executable and run it with a single argument — the name of the configuration file. By default, the configuration file is called input.json.

On Windows it may look like this:

C:\> cd WsDca
C:\WsDca> WsBotDca.exe input.json

On linux/macOS, it may look like this:

$ cd ~/WsDca
$ ./WsBotDca input.json

You should now see the bot operating in the console.

Running Environment

The bots are designed to be run on a server, or other computer that runs 24/7 and is always connected to the Internet. The bots are designed to recover from disruption of Internet connection, so home servers with not so reliable Internet connections are OK to use, but professional servers are highly recommended. Note that if a bot gets disconnected for a longer period of time, it may affect its trading strategy and profitability, especially if it has an open position at the moment it is disconnected.

We recommend using Windows or Linux VPS servers to run the bots (Linux servers are usually cheaper but require more technical knowledge to operate). VPS are affordable and reliable servers for running bots. Make sure your server has at least 2 GB of RAM and you are good to go. There are many VPS providers and most of them are just fine. If you don't have a favorite provider, you can try InterServer.net.