README.md

Hummingbot - Decentralize Market Making

An open-source project for the development of cryptocurrency trading software, created and maintained by CoinAlpha, Inc.

Install · Documentation · FAQ · Contributing · Blog

Hummingbot allows users to run a local client that executes customized, automated market-making trading strategies for cryptocurrencies.

Hummingbot was created to promote decentralized market-making: enabling members of the community to contribute to the liquidity and trading efficiency in cryptocurrency markets. We further discuss this rational on our blog.

For more detailed information, please visit the Hummingbot website and read the Hummingbot whitepaper.

Currently supported cryptocurrency exchanges

logo id name ver doc binance Binance * API radar_relay Radar Relay 2 API ddex DDEX 3 API

Resources / links

• Hummingbot Home Page
• Whitepaper
• Documentation

Getting started

See installation guide.

Docker / deployment

Hummingbot is available on Docker Hub at coinalpha/hummingbot.

For instructions on running hummingbot with Docker including deployment, see DOCKER.md.

Testing

Running tests locally

Run tests by executing: python test/test_**TEST_NAME**.py.

Requires secret files to be saved in the hummingbot/templates/test_templates/ folder:

File Description binance_secret.py binance_secret_TEMPLATE.py web3_wallet_secret.py web3_wallet_secret_TEMPLATE.py

Social / discuss

• Follow us on Twitter
• Read our blog
• Join the CoinAlpha / Hummingbot community on our Discord Server

Contributions are welcome!

We welcome code contributions (via pull requests) as well as bug reports and feature requests through github issues.

When doing so, please review the contributing guidelines / git workflow.

License

Code is released under the Apache-2.0 License, which means it's absolutely free for any developer to build commercial and opensource software on top of it, but use it at your own risk with no warranties, as is.

Contact

Hummingbot was created and is maintained by CoinAlpha. You can contact us at [email protected] or join our Discord server.

For business inquiries, please contact us at [email protected].