Skip to main content

What is Hummingbot API?

Hummingbot API is a RESTful API server that provides programmatic access to all Hummingbot exchange connectors and trading strategies. It serves as the deterministic execution layer for Condor, handling:
  • Data collection: Standardized access to order books, candles, balances, and positions across 50+ exchanges
  • Market access: Connectors to spot, perpetual, and AMM exchanges, along with Solana and EVM networks
  • Trade execution: Place orders, manage positions, and track fills
  • Bot management: Deploy and manage containerized bots for long-running strategies

Base URL

http://localhost:8000
For remote deployments, replace localhost with your server’s address.

Authentication

All endpoints require HTTP Basic Authentication:
curl -u admin:admin http://localhost:8000/accounts

API Routers

Accounts

Manage trading accounts and exchange credentials.
EndpointMethodDescription
/accountsGETList all account names
/accounts/{account_name}/credentialsGETList configured connectors for an account
/accounts/add-accountPOSTCreate a new account
/accounts/delete-accountPOSTDelete an account
/accounts/add-credential/{account_name}/{connector_name}POSTAdd exchange credentials
/accounts/delete-credential/{account_name}/{connector_name}POSTRemove exchange credentials

Portfolio

Real-time balances and portfolio analytics.
EndpointMethodDescription
/portfolio/statePOSTGet portfolio balances across all accounts and connectors

Trading

Execute orders and manage positions.
EndpointMethodDescription
/trading/ordersPOSTPlace a new order
/trading/orders/activePOSTGet active orders
/trading/{account_name}/{connector_name}/orders/{order_id}/cancelPOSTCancel an order
/trading/positionsPOSTGet open positions (perpetual)

Connectors

Exchange connector information and trading rules.
EndpointMethodDescription
/connectorsGETList available connectors
/connectors/{connector_name}/config-mapGETGet required credential fields
/connectors/{connector_name}/trading-rulesGETGet trading rules for pairs
/connectors/{connector_name}/trading-pairsGETList available trading pairs

Market Data

Prices, candles, order books, and funding rates.
EndpointMethodDescription
/market-data/candlesPOSTGet historical candles
/market-data/order-bookPOSTGet order book snapshot
/market-data/pricesPOSTGet current prices
/market-data/funding-ratesPOSTGet perpetual funding rates

Rate Oracle

Cross-exchange price feeds and conversion rates.
EndpointMethodDescription
/rate-oracle/sourcesGETList available price sources
/rate-oracle/rateGETGet conversion rate between assets

Executors

Create and manage trading executors.
EndpointMethodDescription
/executorsGETList active executors
/executorsPOSTCreate a new executor
/executors/{executor_id}DELETEStop an executor
/executors/{executor_id}/statusGETGet executor status

Bot Orchestration

Deploy and manage Hummingbot trading bots.
EndpointMethodDescription
/bot-orchestration/statusGETGet status of all bots
/bot-orchestration/deployPOSTDeploy a new bot
/bot-orchestration/{bot_id}/startPOSTStart a bot
/bot-orchestration/{bot_id}/stopPOSTStop a bot
/bot-orchestration/{bot_id}/logsGETGet bot logs

Controllers

V2 strategy controller management.
EndpointMethodDescription
/controllersGETList available controllers
/controllers/{controller_name}/configGETGet controller configuration schema

Scripts

V1 script management.
EndpointMethodDescription
/scriptsGETList available scripts

Gateway

DEX infrastructure via Hummingbot Gateway.
EndpointMethodDescription
/gateway/statusGETGet Gateway status
/gateway/connectorsGETList Gateway connectors
/gateway/walletsGETList configured wallets
/gateway/networksGETList supported networks

Gateway Swaps

DEX token swaps.
EndpointMethodDescription
/gateway/swaps/quotePOSTGet swap quote
/gateway/swaps/executePOSTExecute a swap

Gateway CLMM

Concentrated liquidity positions.
EndpointMethodDescription
/gateway/clmm/poolsPOSTGet pool information
/gateway/clmm/positionsPOSTGet LP positions
/gateway/clmm/add-liquidityPOSTAdd liquidity to a pool
/gateway/clmm/remove-liquidityPOSTRemove liquidity from a pool
/gateway/clmm/collect-feesPOSTCollect accumulated fees

Backtesting

Strategy backtesting.
EndpointMethodDescription
/backtesting/runPOSTRun a backtest
/backtesting/results/{backtest_id}GETGet backtest results

Archived Bots

Historical bot performance data.
EndpointMethodDescription
/archived-bots/databasesGETList archived bot databases
/archived-bots/{database}/performanceGETGet historical performance

Docker

Container lifecycle management.
EndpointMethodDescription
/docker/statusGETCheck if Docker is running
/docker/containersGETList containers

Response Format

Success responses return the requested data:
["master_account"]
Error responses include a detail field:
{
  "detail": "Account not found"
}

Interactive Playground

Each endpoint page includes an interactive playground where you can test API calls directly. Enter your credentials and server URL to make live requests.

Resources

Condor GitHub

Condor source code

API GitHub

Hummingbot API source code

Discord

Community support