Welcome to the new Hummingbot Quickstart Guide! This will teach you how to build and customize market making strategy using Hummingbot over 5 exercises.
Whether you're a beginner or an experienced trader, this guide should help you get started with creating your own custom trading strategies using Hummingbot. So, let's dive in and start building!
Introduced in version 1.4.0, Scripts enable users to build customized strategies and access the full power of Hummingbot exchange connectors without creating a full-blown strategy. Scripts are light Python files that can be run and modified without re-compilation, which let users can
stop a script, adjust the code, and
start it without leaving the Hummingbot client interface. See Examples for a list of the current sample scripts in the Hummingbot codebase.
First, check out the Installation section to install Hummingbot. You may install it using Docker (easiest for new users) or from source (best for developers).
If you have questions or need help, join the official Hummingbot Discord and ask for help on the #support channel from our community.
If you have installed Hummingbot successfully, you should see a welcome screen like the one below:
The Hummingbot CLI helps you manage, configure, and run your bots. Familiarize yourself with the basic features in Hummingbot, especially the User Interface.
We will start with a simple "Hello World" example of a Hummingbot script and gradually add more functionality to it with each exercise. By the end, you should gain a basic understanding of how to create a market making strategy and use market data to customize its behavior.
Exercise 1: Create Hello World Script¶
- How a basic script works
- Fetching real-time prices (best bid, best ask, mid-price, last traded price)
- Emitting custom log messages
Exercise 2: Create Market Making Script¶
- Building the Pure Market Making strategy as a simple script
- Placing orders using exchange API
- Cancelling orders using exchange API
- Handle an order fill event
Exercise 3: Customize Status Command¶
- Overriding the default
statuscommand with custom output
Exercise 4: Add Basic Price Ceiling/Floor¶
- Motivation for adding this type of logic to a market making strategy
- Adding a price ceiling/floor feature to your script
Exercise 5: Add Dynamic Price Ceiling/Floor¶
- Creating custom OHLCV candles and technical indicators from order book data
- Making the price ceiling/floor feature dynamic with Bollinger Bands
Scripts Cheatsheet: Check out the cheatsheet or the PDF version that highlights the most commonly used methods available when writing scripts
Debugging Scripts with PyCharm: This video shows you how to debug Scripts at runtime with the PyCharm IDE