What is Hummingbot?

Hummingbot is an open source framework that helps you build automated trading strategies, or bots that run on cryptocurrency exchanges. A detailed description of the bot configuration and its capabilities can be found at https://docs.hummingbot.org/getting-started/

Installation

Installing Hummingbot on OpenCEX is possible in two ways:

1. Automatic installation using the OpenCEX wizard. Launch the installation wizard and enter True at step 12. This will install OpenCEX along with Hummingbot. More details about installation: OpenCEX Installation
2. Manual installation of Hummingbot on an already running OpenCEX instance. To start the installation, enter the command in the console:

cd /app/opencex || exit
git clone <https://github.com/Polygant/hummingbot.git> ./hmbot
cd ./hmbot
docker build -t hummingbot:latest -f Dockerfile .
cat << EOF >> /app/opencex/docker-compose.yml
    hummingbot:
     container_name: hummingbot
     hostname: hummingbot
     restart: always
     image: hummingbot:latest
     volumes:
       - /app/opencex/hmbot/conf:/home/hummingbot/conf
       - /app/opencex/hmbot/conf/connectors:/home/hummingbot/conf/connectors
       - /app/opencex/hmbot/conf/strategies:/home/hummingbot/conf/strategies
       - /app/opencex/hmbot/logs:/home/hummingbot/logs
       - /app/opencex/hmbot/data:/home/hummingbot/data
       - /app/opencex/hmbot/scripts:/home/hummingbot/scripts
     networks:
       - caddy
     tty: true
     stdin_open: true
EOF
cd /app/opencex/ && docker compose up -d

After installation using the above methods, the bot will be ready to work.

Pre-setting

To run Hummingbot on your OpenCEX instance, you need to complete the following steps:

1. Register a user for the bot via standard OpenCEX registration and confirm it.
2. Top up the bot user's balances. The top-up is possible via cryptocurrency deposit or via manual top-up. Learn more about manual top-up: OpenCEX admin panel user's manual
3. Save the user's API keys. Go to the Users page in the admin panel, find the bot user in the list and click on the pencil icon. Find the API keys in the window that opens and save them.

https://lh7-us.googleusercontent.com/ZWbvCGe5tEMMd2oiqW18uRDvd0rzjbobJWAD-tWgLSUDRTNqVPCraRGQof68wKa-rNNC-BfEv0Hs-e24ZMj5mA-pBZ1ge-vd5L6MpbejVqT1EpypDekdRxbz4TdJSjMwRJ3W-Pj7jCTl_5vX2OAlS_U

1. Place orders in the order book if the order book is empty. Create buy and sell orders in the pair you want to run the bot on (for example, BTC-USDT). Orders must be placed by another user, not the bot user.
2. Set up a pair (e.g. BTC-USDT) for the bot to work. Go to the Pair Settings page in the admin panel, go to edit the pair and set the required values:
3. Min order size (e.g. 0.0001 for BTC)
4. Min base amount increment (e.g. 0.0001 for BTC)
5. Min price increment (e.g. 0.01 for BTC)