Skip to content

quickstart.mdx

Latest commit

 

History

History
119 lines (94 loc) · 3.03 KB

quickstart.mdx

File metadata and controls

119 lines (94 loc) · 3.03 KB
title Quickstart
description Get Condor and Hummingbot API running in minutes

This guide walks you through deploying the Hummingbot API on a server and setting up Condor for Telegram-based control.

What You'll Set Up

By the end of this guide, you'll have:

  • Hummingbot API - REST API backend for bot management and trading (port 8000)
  • Condor - Telegram bot for monitoring and controlling Hummingbot API

Prerequisites

| Component | Specification | |-----------|---------------| | **OS** | Linux x64 or ARM (Ubuntu 20.04+, Debian 10+) | | **Memory** | 4 GB RAM minimum | | **Storage** | 10 GB SSD | | **CPU** | 2 vCPUs minimum | ```bash curl -fsSL https://get.docker.com -o get-docker.sh sh get-docker.sh ```

Step 1: Install Hummingbot API

Clone the repository and run setup:

git clone https://github.com/hummingbot/hummingbot-api.git
cd hummingbot-api
chmod +x setup.sh
./setup.sh

The setup script will prompt you for:

  • Config password (for encrypting credentials)
  • API username and password (default: admin/admin)

Start all services:

make deploy
Verify by opening `http://localhost:8000/docs` in your browser.

Step 2: Create a Telegram Bot

  1. Open Telegram and search for @BotFather
  2. Send /newbot and follow the prompts
  3. Copy your bot token (looks like 123456789:ABCdefGHIjklMNOpqrsTUVwxyz)

To get your Telegram User ID:

  1. Search for @userinfobot on Telegram
  2. Send /start - it will reply with your User ID

Step 3: Install Condor

git clone https://github.com/hummingbot/condor.git
cd condor
./setup-environment.sh

Enter when prompted:

  • TELEGRAM_TOKEN: Your bot token from BotFather
  • AUTHORIZED_USERS: Your Telegram User ID

Start Condor:

docker compose up -d

Step 4: Connect Everything

Open your bot in Telegram and send `/start` Use `/config` → **API Servers** to connect to your Hummingbot API (default: `localhost:8000`) Use `/config` → **API Keys** to add your exchange API keys Use `/portfolio` to view balances or `/trade` to place orders

Next Steps

Learn all available Telegram commands Use the API directly with curl and Python Explore all API endpoints Full Hummingbot documentation