---

This is a fork of hummingbot/hummingbot with the addition of the Yellow Pro (yellow_pro) spot exchange connector.

The master branch tracks upstream Hummingbot. All Yellow Pro additions live on the yellow-pro branch.

---

Yellow Pro Connector

Yellow Pro is a centralized spot exchange. This fork adds a native Hummingbot connector for it.

Connector Details

Property	Value
Connector ID	yellow_pro
Type	CLOB CEX — Spot
Authentication	API Key + Secret
Branch	yellow-pro
Connector path	hummingbot/connector/exchange/yellow_pro/

Files Added

hummingbot/connector/exchange/yellow_pro/
├── yellow_pro_exchange.py                   # Main exchange class
├── yellow_pro_api_order_book_data_source.py # Order book via REST/WebSocket
├── yellow_pro_api_user_stream_data_source.py# User stream via WebSocket
├── yellow_pro_auth.py                       # API key authentication
├── yellow_pro_constants.py                  # URLs, rate limits, order states
├── yellow_pro_order_book.py                 # Order book snapshot/diff handling
├── yellow_pro_utils.py                      # Utility helpers
├── yellow_pro_web_utils.py                  # HTTP/WS factory helpers
├── yellow_pro_perf_tracer.py                # Performance tracing
└── docs/
    ├── API.md                               # REST API reference
    └── WS.md                               # WebSocket API reference

scripts/
├── yellow_pro_market_making.py              # Market making example script
├── yellow_pro_market_data_dumper.py         # Market data logging script
└── yellow_pro_order_test.py                 # Order placement test script

Usage

1. Clone this repo and switch to the yellow-pro branch:

git clone https://github.com/layer-3/hummingbot.git
cd hummingbot
git checkout yellow-pro

2. Install and run Hummingbot (see Getting Started below).

3. Connect the Yellow Pro connector:

connect yellow_pro

4. Enter your API key and secret when prompted.

Syncing with Upstream Hummingbot

# Update master to match upstream
git checkout master
git fetch upstream
git merge upstream/master
git push origin master

# Bring yellow-pro up to date
git checkout yellow-pro
git merge master
git push origin yellow-pro

---

About Hummingbot

Hummingbot is an open-source framework that helps you design and deploy automated trading strategies, or bots, that can run on many centralized or decentralized exchanges. Over the past year, Hummingbot users have generated over $34 billion in trading volume across 140+ unique trading venues.

The Hummingbot codebase is free and publicly available under the Apache 2.0 open-source license. Our mission is to democratize high-frequency trading by creating a global community of algorithmic traders and developers that share knowledge and contribute to the codebase.

Quick Links

• Website and Docs: Official Hummingbot website and documentation
• Installation: Install Hummingbot on various platforms
• Discord: The main gathering spot for the global Hummingbot community
• YouTube: Videos that teach you how to get the most out of Hummingbot
• Twitter: Get the latest announcements about Hummingbot

Getting Started

The easiest way to get started with Hummingbot is using Docker:

• To install the Telegram Bot Condor, follow the instructions in the Hummingbot Docs site.

• To install the CLI-based Hummingbot client, follow the instructions below.

Alternatively, if you are building new connectors/strategies or adding custom code, see the Install from Source section in the documentation.

Install Hummingbot with Docker

Install Docker Compose website.

Clone this repo, switch to the yellow-pro branch, and use the provided docker-compose.yml file:

git clone https://github.com/layer-3/hummingbot.git
cd hummingbot
git checkout yellow-pro

make setup
make deploy

docker attach hummingbot

Install Hummingbot + Gateway DEX Middleware

git clone https://github.com/layer-3/hummingbot.git
cd hummingbot
git checkout yellow-pro
make setup
# Answer `y` when prompted: Include Gateway? [y/N]
make deploy
docker attach hummingbot

---

For comprehensive installation instructions and troubleshooting, visit the Hummingbot Installation Docs.

Getting Help

• Consult the Hummingbot FAQ, Troubleshooting Guide, or Glossary
• For Yellow Pro connector issues, open an issue in this repository
• For general Hummingbot issues, submit a Github issue upstream
• Join the Hummingbot Discord community

License

This repository is licensed under the Apache 2.0 License, the same as the upstream Hummingbot project.

The Yellow Pro connector (hummingbot/connector/exchange/yellow_pro/) is original work added by layer-3, also released under Apache 2.0.

Copyright notices from the original Hummingbot project are preserved in full.