Skip to content

live

Jump to bottom
John Kearney edited this page Sep 17, 2022 · 1 revision

Running the bot live

Once you've installed and configured the bot as desired, it's time to start your bot in live mode. This page explains how you can start your bot, and anything relating to keeping the system running unattended.

Usage

In order to start the bot in live mode, you will need two things:

  1. setup your API-keys in the api-keys.json file in the root folder. The template file api-keys.example.json can be copied as a starting file.
  2. have the config file you want to use in live mode readily available for the bot (typically placed in configs/live)

!!! Warning Make sure you enable futures on the API key. Also, be aware that on Binance you have to complete a quiz before you can trade futures. Apart from that, you need to make sure there are funds present in the futures wallet.

You can use your favorite text editor to setup the account details in the api-keys.json file. There's a sample template already available when you check out the repository, so you can simply put the required information in the expected places.

Please make not of the account name that is written in the api-keys.json file at the root level, you will need this for the next step (e.g. binance_01 in the template for example).

!!! Info You can name the account any way you want, just make sure you make of what you set it to, as it's used in both live mode, backtesting and optimize

To actually start the bot, you can use the following command:

python3 passivbot.py {account_name} {symbol} {path/to/config.json}

An actual command with the values filled in could look like this for example:

python3 passivbot.py binance_01 XMRUSDT configs/live/binance_xmrusdt.json

Default configurations

There are a number of configurations provided by default in the repository. These configurations are optimized and backtested over a longer period of time, and provide a good starting point for setting up your own perfect configuration. You can find these configurations in the configs/live directory.

There is also a public repository available with a lot of optimized & backtested configurations on multiple coins at this github repository.

If you found a good config and want to share this configuration, please feel free to get in touch with the community to do so!

Controlling the bot

It is possible to control the bot using the following CLI options:

  • -lm LONG_MODE (or -sm SHORT_MODE for shorts): specify one of the following modes: [n (normal), m (manual), gs (graceful_stop), p (panic), t (tp_only)]
    • n (normal); normal operation
    • m (manual): bot neither creates nor cancels orders.
    • gs (graceful stop): let the bot continue as normal until all positions are fully closed, then not open any more positions.
    • p (panic): bot will close positions asap using limit orders
    • t (TP-only): bot only manages TP grid and will not cancel or create any entries.
  • -lw 0.12 (or -sw 0.12 for shorts): specify long wallet exposure limit, overriding value from live config
  • -lw -0 (or sw -0 for shorts): disable and remove all reentries. Bot still manages TP.

You can use the command for shorts and long in the same line. Example to set pbr = 0.1 for longs, 0.05 for shorts, normal mode for longs and manual mode for shorts:

python3 passivbot.py binance_01 XMRUSDT configs/live/binance_xmrusdt.json -lw 0.1 -sw 0.05 -lm n -sm m

Startup checks

When Passivbot is started, it will (if possible) set the position mode to hedge on the exchange, and set the leverage to such a level that you do not run into errors about insufficient margin. To accomplish this, the configuration parameter wallet_exposure_limit is taken into account to determine the appropriate leverage to set on the exchange.

Stopping bot

!!! Warning Before stopping the bot, please make sure it is in an appropriate state, e.g. make sure there are no positions or orders open that will cause problems if left open for a longer period

If you want to stop, you can achieve this by pressing ctrl+c in the terminal

!!! Info Please note that shutting down the bot properly may take a couple of seconds, as it needs time to properly detach from the websocket and shutdown the bot.

Running unattended

Currently there is no active support for running passivbot as a service. Future development is likely to include this, but for now for Unix-based systems it should be fairly straight forward to set this up. There are numerous tutorials available on Google if you search for 'linux running python as a service'.

If you want to leave the bot running without requiring to have the terminal window open all the time, you can use tools like tmux, screen or a similar utility.

In case you need any help, feel freee to reach out for help via one of the channels described in Home.

Clone this wiki locally