Skip to content

CLOB Connectors

What are Connectors?

Connectors are packages of code that link Hummingbot's internal trading engine with real-time and historical data from different cryptocurrency exchanges and blockchains, via WebSocket and/or REST API. They standardize interactions with the idiosyncratic APIs offered by these platforms, for purposes such as gathering order book and blockchain data, as well as sending and cancelling transactions and orders.

CLOB Connectors

CLOB (Central Limit Order Book) connectors integrate into a CLOB exchange's WebSocket API, enabling standardized order placement/cancellation and order book data fetching from the perspective of Hummingbot strategies. These connectors work with both centralized exchanges (CEX) and decentralized exchanges (DEX) that utilize a central limit order book model.

Each connector is customized for a particular exchange's idiosyncrasies to enable this level of standardization, so they should ideally have a maintainer, whose role is to ensure consistent performance by fixing bugs, incorporating API updates, and other ongoing work.

CLOB Connector Types

Currently, Hummingbot supports two CLOB connector standards, each which define how the code encapsulated in a connector folder should offer standardized API endpoints and hook into the Hummingbot client.

  • CLOB Spot: WebSocket-based connectors to an exchange's spot order book-based markets. Each connector is a folder in the hummingbot/connector/exchange folder.

  • CLOB Perp: WebSocket-based connectors to an exchange's perpetual futures order book-based markets. Each connector is a folder in the hummingbot/connector/derivative folder. By convention, these connector names end in _perpetual.

These connector standards allow users to create Strategies and Scripts that can operate on different spot and perpetual markets without modification.

CLOB Connector Maintenance and Governance

CLOB connectors requires ongoing maintenance: fixing bugs, addressing user issues, and keeping up with updates to both the exchange/blockchain API as wel as improvements to the Hummingbot connector standard.

Hummingbot Foundation maintains certain reference connectors to maintain an updated standard and leverages community-based developers to maintain other connectors to the same standard. We assign Bounties to community developers to upgrade and fix bugs for each exchange's connectors in the codebase.

Each quarter, Exchange Connector Polls allocates HBOT bounties toward top exchanges and determines which exchanges should be included in the codebase going forward. See the Connector Pots tab in HBOT Tracker for the current allocations for each exchange.

Adding New CLOB Connectors

CLOB connectors may be contributed by community members via New Connector Proposals, which require a pull request with the connector code to the Hummingbot Github repo, along with a minimum HBOT balance to create.

The Notion templates below summarize the file and functionalities needed to build the latest spot and perpetual connectors standards and support V2 Strategies:

See Building Connectors for more information.

Current CLOB Connectors

Here are the CLOB connectors in the codebase for the current Epoch. Note that the Foundation prioritizes fixes for connectors from exchanges that are sponsors or partners, so they tend to be more reliable and better maintained.

Exchange Foundation Partner Spot Perp Connector Guide
Binance ✓ ✓ ✓ Guide
Bitmart ✓ ✓ ✓
Derive ✓ ✓ ✓ Guide
dYdX ✓ ✓ Guide
Gate.io ✓ ✓ ✓
HTX ✓ ✓
Kucoin ✓ ✓ ✓
OKX ✓ ✓ ✓
XRPL ✓ ✓
AscendEx ✓
BingX ✓
Bitstamp ✓
Bitrue ✓
Bitget ✓
Bybit ✓ ✓
BTC Markets ✓
Coinbase ✓
Cube ✓
Dexalot ✓ ✓ Guide
Hashkey Global ✓ ✓
Kraken ✓
MEXC ✓
NDAX ✓
Tegro ✓ ✓
Vertex ✓