Skip to content

Scripts

Scripts enable Hummingbot users to build customized strategies and access the full power of Hummingbot exchange connectors in a few lines of Python code.

Introduced in version 1.4.0, Script are light Python files that can be run and modified without re-compilation, so users can stop a script, adjust the code, and start it without leaving the Hummingbot client interface.

Scripts can be created without configuration files, so only a single file is needed. Scripts can access all the raw data, events, and methods in Hummingbot connectors, as well as other features such as the Rate Oracle.

Note

Should your script run into an error, it's crucial that you exit Hummingbot entirely, correct or debug the faulty script, and then restart Hummingbot. The stop command won't rectify the issue in case of an error. To get back on track, a complete shutdown and subsequent relaunch of Hummingbot is required.

Script Examples

See Script Examples for a list of the current sample scripts in the Hummingbot codebase. These examples show you how to:

  • Execute V2 strategies
  • Download order book data
  • Download historical candles data
  • Place orders
  • Use the rate oracle
  • Call exchange APIs
  • And much more!

We welcome new sample script contributions from users! To submit a contribution, please follow the Contribution Guidelines.

Mastering V2 Scripts with Botcamp

If you'd like to learn how to learn how to design and customize V2 Scripts, sign up for Botcamp!

PMM Scripts (deprecated)

PMM Scripts were an early experiment to let users customize Hummingbot, but they can only be used with the Pure Market Making V1 strategy.

While the examples remain in the codebase, this feature are no longer maintained.