### Install Condor Setup Script Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/installation/condor.md Run this command to download and execute the Condor installation script. The script will guide you through the setup process. ```bash curl -fsSL https://raw.githubusercontent.com/hummingbot/deploy/main/setup.sh | bash ``` -------------------------------- ### Start Hummingbot from Source Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/blog/posts/using-derive-with-hummingbot/index.md Launch Hummingbot using the start script after installation and compilation. ```bash ./start ``` -------------------------------- ### Install and Run Hummingbot from Source Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/installation/hummingbot-client.md Clone the Hummingbot repository, install dependencies, and start the client. The `make install` command sets up the conda environment, and `make run` starts the client, accepting arguments like strategy files. ```bash git clone https://github.com/hummingbot/hummingbot.git cd hummingbot make install make run ``` -------------------------------- ### Start Hummingbot API Stack with Tailscale Sidecar Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/blog/posts/securing-condor-and-hummingbot-api-with-tailscale/index.md Use this command if you manually cloned the hummingbot-api repository and ran 'make setup'. It starts the API and its Tailscale sidecar. ```bash make deploy ``` -------------------------------- ### Clone Hummingbot API and Run Setup Script Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/blog/posts/quickstart-dashboard/index.md Clone the Hummingbot API repository and execute the setup script to install Hummingbot 2.0 and its dependencies using Docker Compose. This script pulls the necessary Docker images and starts the required services. ```bash git clone https://github.com/hummingbot/hummingbot-api cd hummingbot-api bash setup.sh ``` -------------------------------- ### Example Autostart V2 Script from Source Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/client/global-configs/strategy-autostart.md An example of autostarting a V2 script named 'conf_simple_pmm_1.yml' with a configuration password 'a'. ```bash bin/hummingbot_quickstart.py -p a --v2 conf_simple_pmm_1.yml ``` -------------------------------- ### Start a Controller Configuration Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/client/config-files.md To run controllers, use the `v2_with_controllers.py` loader script. Start the loader with `start --v2` and specify the controller configuration file. ```bash start --v2 conf_v2_with_controllers_1.yml ``` -------------------------------- ### Start V1 Strategy (Legacy) Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/client/start-stop.md For V1 strategies, first import the configuration file, then start the strategy. This is a legacy method. ```bash import start ``` -------------------------------- ### Development Setup for Hummingbot API Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/hummingbot-api/installation.md Commands to uninstall, install, and run the Hummingbot API in a development environment using make targets. ```bash make uninstall make install make run ``` -------------------------------- ### Complete Hummingbot API Example Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/hummingbot-api/quickstart.md This Python script demonstrates a full workflow: adding exchange credentials, fetching portfolio data, retrieving trading rules, and placing a limit order. Ensure you have the necessary libraries installed and replace placeholder credentials with your actual API keys. ```python import asyncio from hummingbot.client.hummingbot_api_client import HummingbotApiClient async def main(): client = HummingbotApiClient() try: # Step 1: Add credentials for hyperliquid print("\nšŸ”‘ Adding Hyperliquid Credentials...") credentials = { "hyperliquid_api_key": "0x1234...abcd", "hyperliquid_api_secret": "your-arbitrum-private-key", "use_vault": False } cred_result = await client.accounts.add_credential( account_name="master_account", connector_name="hyperliquid", credentials=credentials ) print(f"āœ“ Credentials added: {cred_result}") # Wait for account sync await asyncio.sleep(2) # Step 3: View portfolio print("\nšŸ“Š Fetching Portfolio...") portfolio = await client.portfolio.get_state() print("Portfolio State:") for account, exchanges in portfolio.items(): for exchange, balances in exchanges.items(): for balance in balances: print(f" {account}/{exchange}: {balance['units']:.2f} {balance['token']} (${balance['value']:.2f})") # Step 4: Get trading rules print("\nšŸ“ Getting Trading Rules for HYPE-USDC...") rules = await client.connectors.get_trading_rules( connector_name="hyperliquid", trading_pairs=["HYPE-USDC"] ) hype_rules = rules["HYPE-USDC"] print(f" Min Order Size: {hype_rules['min_order_size']}") print(f" Min Price Increment: {hype_rules['min_price_increment']}") # Step 5: Place limit order print("\nšŸ’± Placing Limit Order...") order = await client.trading.place_order( account_name="master_account", connector_name="hyperliquid", trading_pair="HYPE-USDC", trade_type="SELL", amount=1, order_type="LIMIT", price=47.1, position_action="OPEN" ) print(f"āœ“ Order {order['order_id']} submitted") print(f" Status: {order['status']}") print(f" Type: {order['order_type']} {order['trade_type']}") print(f" Amount: {order['amount']} HYPE @ ${order['price']}") except Exception as e: print(f"āŒ Error: {e}") finally: await client.close() # Run the complete example if __name__ == "__main__": asyncio.run(main()) ``` -------------------------------- ### Install and Run Hummingbot from Source Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/blog/posts/trading-on-grvt-with-hummingbot-complete-bot-development-guide/index.md Install Hummingbot dependencies and run the client directly from the source code. ```bash make install make run ``` -------------------------------- ### Gateway Development Mode Startup Log Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/gateway/installation.md Example log output when the Gateway successfully starts in development mode (HTTP). It indicates the version, port, and mode of operation. ```log bigint: Failed to load bindings, pure JS will be used (try npm run rebuild?) ā•”ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā•— ā–ˆā–ˆā–ˆā–ˆā–ˆā•— ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā•—ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā•—ā–ˆā–ˆā•— ā–ˆā–ˆā•— ā–ˆā–ˆā–ˆā–ˆā–ˆā•— ā–ˆā–ˆā•— ā–ˆā–ˆā•— ā–ˆā–ˆā•”ā•ā•ā•ā•ā• ā–ˆā–ˆā•”ā•ā•ā–ˆā–ˆā•—ā•šā•ā•ā–ˆā–ˆā•”ā•ā•ā•ā–ˆā–ˆā•”ā•ā•ā•ā•ā•ā–ˆā–ˆā•‘ ā–ˆā–ˆā•‘ā–ˆā–ˆā•”ā•ā•ā–ˆā–ˆā•—ā•šā–ˆā–ˆā•— ā–ˆā–ˆā•”ā• ā–ˆā–ˆā•‘ ā–ˆā–ˆā–ˆā•—ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā•‘ ā–ˆā–ˆā•‘ ā–ˆā–ˆā–ˆā–ˆā–ˆā•— ā–ˆā–ˆā•‘ ā–ˆā•— ā–ˆā–ˆā•‘ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā•‘ ā•šā–ˆā–ˆā–ˆā–ˆā•”ā• ā–ˆā–ˆā•‘ ā–ˆā–ˆā•‘ā–ˆā–ˆā•”ā•ā•ā–ˆā–ˆā•‘ ā–ˆā–ˆā•‘ ā–ˆā–ˆā•”ā•ā•ā• ā–ˆā–ˆā•‘ā–ˆā–ˆā–ˆā•—ā–ˆā–ˆā•‘ā–ˆā–ˆā•”ā•ā•ā–ˆā–ˆā•‘ ā•šā–ˆā–ˆā•”ā• ā•šā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā•”ā•ā–ˆā–ˆā•‘ ā–ˆā–ˆā•‘ ā–ˆā–ˆā•‘ ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā•—ā•šā–ˆā–ˆā–ˆā•”ā–ˆā–ˆā–ˆā•”ā•ā–ˆā–ˆā•‘ ā–ˆā–ˆā•‘ ā–ˆā–ˆā•‘ ā•šā•ā•ā•ā•ā•ā• ā•šā•ā• ā•šā•ā• ā•šā•ā• ā•šā•ā•ā•ā•ā•ā•ā• ā•šā•ā•ā•ā•šā•ā•ā• ā•šā•ā• ā•šā•ā• ā•šā•ā• 2025-04-04 10:09:59 | info | āš”ļø Gateway version 2.8.0 starting at http://localhost:15888 2025-04-04 10:09:59 | info | Checking for processes using port 15888... 2025-04-04 10:09:59 | info | No process found using port 15888 2025-04-04 10:09:59 | info | šŸ”“ Running in development mode with (unsafe!) HTTP endpoints 2025-04-04 10:09:59 | info | Read token file from conf/lists/solana.json, content length: 619791 2025-04-04 10:09:59 | info | Parsed token count: 3859 2025-04-04 10:09:59 | info | Loaded 3859 tokens for mainnet-beta 2025-04-04 10:09:59 | info | šŸ““ Documentation available at http://localhost:15888/docs ``` -------------------------------- ### Complete Hummingbot API Example using cURL Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/hummingbot-api/quickstart.md A comprehensive cURL script demonstrating account setup, credential addition, portfolio viewing, trading rule retrieval, and placing a limit order on Hyperliquid. ```bash echo "šŸ”‘ Adding Exchange Account..." curl -X POST "http://localhost:8000/accounts/add-account?account_name=master_account" \ -u "admin:admin" \ -H "accept: application/json" # Step 2: Add credentials for hyperliquid curl -X POST "http://localhost:8000/accounts/add-credential/master_account/hyperliquid" \ -u "admin:admin" \ -H "Content-Type: application/json" \ -d '{ "hyperliquid_api_key": "0x1234...abcd", "hyperliquid_api_secret": "your-arbitrum-private-key", "use_vault": false }' # Wait for account sync sleep 2 # Step 3: View portfolio echo -e "\n\U0001F4CA Fetching Portfolio..." curl -X POST "http://localhost:8000/portfolio/state" \ -u "admin:admin" \ -H "accept: application/json" \ -H "Content-Type: application/json" \ -d '{}' # Step 4: Get trading rules for HYPE-USDC echo -e "\n\U0001F4CF Getting Trading Rules..." curl -X GET "http://localhost:8000/connectors/hyperliquid/trading-rules?trading_pairs=HYPE-USDC" \ -u "admin:admin" \ -H "accept: application/json" # Step 5: Place limit order echo -e "\n\U0001F4B1 Placing Limit Order..." curl -X POST "http://localhost:8000/trading/orders" \ -u "admin:admin" \ -H "accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "account_name": "master_account", "connector_name": "hyperliquid", "trading_pair": "HYPE-USDC", "trade_type": "SELL", "amount": 1, "order_type": "LIMIT", "price": 47.1, "position_action": "OPEN" }' ``` -------------------------------- ### Complete Hummingbot API Example using Python Client Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/hummingbot-api/quickstart.md A Python script demonstrating account setup, credential addition, portfolio viewing, trading rule retrieval, and placing a limit order using the Hummingbot API client. Save this code as `hummingbot_api_demo.py`. ```python import asyncio from hummingbot_api_client import HummingbotAPIClient async def main(): # Initialize client client = HummingbotAPIClient( base_url="http://localhost:8000", username="admin", password="admin" ) await client.init() try: # Step 1: Add exchange account print("šŸ”‘ Adding Exchange Account...") try: account = await client.accounts.add_account( account_name="master_account" ) print(f"āœ“ Account '{account['account_name']}' added successfully!") except Exception as e: if "Account already exists" in str(e): print("ā„¹ļø Account already exists, continuing...") else: raise ``` -------------------------------- ### Install Hummingbot Dependencies Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/blog/posts/using-derive-with-hummingbot/index.md After cloning the repository, run the install script to set up Hummingbot dependencies. ```bash cd hummingbot ./install ``` -------------------------------- ### Gateway Production Mode Startup Log Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/gateway/installation.md Example log output when the Gateway successfully starts in production mode (HTTPS). It indicates the version, port, and secured mode of operation. ```log bigint: Failed to load bindings, pure JS will be used (try npm run rebuild?) ā•”ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā•— ā–ˆā–ˆā–ˆā–ˆā–ˆā•— ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā•—ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā•—ā–ˆā–ˆā•— ā–ˆā–ˆā•— ā–ˆā–ˆā–ˆā–ˆā–ˆā•— ā–ˆā–ˆā•— ā–ˆā–ˆā•— ā–ˆā–ˆā•”ā•ā•ā•ā•ā• ā–ˆā–ˆā•”ā•ā•ā–ˆā–ˆā•—ā•šā•ā•ā–ˆā–ˆā•”ā•ā•ā•ā–ˆā–ˆā•”ā•ā•ā•ā•ā•ā–ˆā–ˆā•‘ ā–ˆā–ˆā•‘ā–ˆā–ˆā•”ā•ā•ā–ˆā–ˆā•—ā•šā–ˆā–ˆā•— ā–ˆā–ˆā•”ā• ā–ˆā–ˆā•‘ ā–ˆā–ˆā–ˆā•—ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā•‘ ā–ˆā–ˆā•‘ ā–ˆā–ˆā–ˆā–ˆā–ˆā•— ā–ˆā–ˆā•‘ ā–ˆā•— ā–ˆā–ˆā•‘ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā•‘ ā•šā–ˆā–ˆā–ˆā–ˆā•”ā• ā–ˆā–ˆā•‘ ā–ˆā–ˆā•‘ā–ˆā–ˆā•”ā•ā•ā–ˆā–ˆā•‘ ā–ˆā–ˆā•‘ ā–ˆā–ˆā•”ā•ā•ā• ā–ˆā–ˆā•‘ā–ˆā–ˆā–ˆā•—ā–ˆā–ˆā•‘ā–ˆā–ˆā•”ā•ā•ā–ˆā–ˆā•‘ ā•šā–ˆā–ˆā•”ā• ā•šā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā•”ā•ā–ˆā–ˆā•‘ ā–ˆā–ˆā•‘ ā–ˆā–ˆā•‘ ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā•—ā•šā–ˆā–ˆā–ˆā•”ā–ˆā–ˆā–ˆā•”ā•ā–ˆā–ˆā•‘ ā–ˆā–ˆā•‘ ā–ˆā–ˆā•‘ ā•šā•ā•ā•ā•ā•ā• ā•šā•ā• ā•šā•ā• ā•šā•ā• ā•šā•ā•ā•ā•ā•ā•ā• ā•šā•ā•ā•ā•šā•ā•ā• ā•šā•ā• ā•šā•ā• ā•šā•ā• 2025-04-04 10:12:32 | info | āš”ļø Gateway version 2.8.0 starting at https://localhost:15888 2025-04-04 10:12:32 | info | Checking for processes using port 15888... 2025-04-04 10:12:32 | info | No process found using port 15888 2025-04-04 10:12:32 | info | šŸŸ¢ Running in secured mode with behind HTTPS endpoints 2025-04-04 10:12:33 | info | Read token file from conf/lists/solana.json, content length: 619791 2025-04-04 10:12:33 | info | Parsed token count: 3859 2025-04-04 10:12:33 | info | Loaded 3859 tokens for mainnet-beta 2025-04-04 10:12:33 | info | šŸ““ Documentation available at https://localhost:15888/docs ``` -------------------------------- ### Clone Hummingbot and Run Setup (Docker) Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/client/installation.md Clones the Hummingbot repository and runs the initial setup and deployment commands for Docker. ```bash git clone https://github.com/hummingbot/hummingbot.git cd hummingbot make setup make deploy ``` -------------------------------- ### Install Hummingbot with Tailscale Prompt Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/hummingbot-api/tailscale.md During the source installation process, this command will prompt you to configure Tailscale if it's enabled. ```bash make install ``` -------------------------------- ### Autostart V1 Strategy from Source Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/client/global-configs/strategy-autostart.md Use the hummingbot_quickstart.py script with the -p and -f flags to autostart a V1 strategy configuration from source installation. ```bash bin/hummingbot_quickstart.py -p CONFIG_PASSWORD -f V1_STRATEGY_YML ``` -------------------------------- ### Source Installation Autostart Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/client/start-stop.md Configure Hummingbot to autostart a strategy when installed from source. Use `hummingbot_quickstart.py` with appropriate arguments for V2 or V1 strategies and optional headless mode. ```bash # V2 script or controller loader (YAML in conf/scripts) bin/hummingbot_quickstart.py -p CONFIG_PASSWORD --v2 CONFIG_YML [--headless] # Legacy V1 strategy (YAML in conf/strategies) bin/hummingbot_quickstart.py -p CONFIG_PASSWORD -f STRATEGY_CONFIG_YML [--headless] ``` ```bash # V2: autostart using a script config under conf/scripts bin/hummingbot_quickstart.py -p mypassword --v2 conf_simple_pmm_1.yml # V1: autostart using a strategy config under conf/strategies bin/hummingbot_quickstart.py -p mypassword -f conf_pure_mm_1.yml --headless ``` -------------------------------- ### Autostart V2 Script from Source Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/client/global-configs/strategy-autostart.md Use the hummingbot_quickstart.py script with the -p and --v2 flags to autostart a V2 script configuration from source installation. ```bash bin/hummingbot_quickstart.py -p CONFIG_PASSWORD --v2 V2_CONFIG_YML ``` -------------------------------- ### Clone Hummingbot Repository and Start Docker Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/blog/posts/using-dexalot-with-hummingbot/index.md Clone the Hummingbot repository and start the Hummingbot services using Docker Compose. Remember to restart your PC after WSL installation. ```shell git clone https://github.com/hummingbot/hummingbot.git ``` ```shell cd hummingbot ``` ```shell docker compose up -d ``` -------------------------------- ### Install Hummingbot with dYdX Connector from Source Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/blog/posts/dydx-v4-connector/index.md Clone the Hummingbot repository, navigate to the directory, and run the install command with the `--dydx` flag. Activate the environment and compile the code. ```bash git clone https://github.com/hummingbot/hummingbot.git ``` ```bash cd hummingbot ``` ```bash ./install --dydx ``` ```bash conda activate hummingbot ``` ```bash ./compile ``` -------------------------------- ### Call Class Method to Get Active Markets Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/connectors/connectors/debug.md This example demonstrates how to call a class method asynchronously to retrieve active exchange markets. It uses BittrexAPIOrderBookDataSource as an example and prints the output, which includes market symbols and associated data. ```python3 >>> from hummingbot.market.bittrex.BittrexAPIOrderBookDataSource import BittrexAPIOrderBookDataSource as b >>> await b.get_active_exchange_markets() askRate baseAsset baseVolume ... volume USDVolume old_symbol symbol ... 251.26097386 2.351174e+06 USD-BTC XRP-BTC 0.00003330 XRP 83.81218622 ... 2563786.10102864 7.976883e+05 BTC-XRP BTC-USDT 9346.88236735 BTC 538306.04864142 ... 57.59973765 5.379616e+05 USDT-BTC . . . [339 rows x 18 columns] ``` -------------------------------- ### Deploy Hummingbot API Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/hummingbot-api/tailscale.md After installation and Tailscale setup, navigate to the API directory and run this command to deploy the Hummingbot API. ```bash cd hummingbot-api make deploy ``` -------------------------------- ### dYdX Hummingbot Docker Setup Output Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/blog/posts/using-dydx-v4-with-hummingbot/index.md This output indicates that the Docker containers for the Hummingbot Dashboard and its dependencies have been successfully started. ```bash [+] Running 7/7 āœ” Network deploy_emqx-bridge Created āœ” Volume "deploy_emqx-data" Created āœ” Volume "deploy_emqx-log" Created āœ” Volume "deploy_emqx-etc" Created āœ” Container dashboard Started āœ” Container backend-api Started āœ” Container hummingbot-broker Started ``` -------------------------------- ### Start V2 Strategy Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/client/start-stop.md Start a V2 strategy or controller using an existing configuration file. The config file must be in `conf/scripts/` and specify the `script_file_name`. ```bash start --v2 ``` ```bash start --v2 conf_simple_pmm_1.yml ``` -------------------------------- ### Get Current Market Price Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/blog/posts/strategy-coding-for-dummies/index.md Example of how to retrieve the current top bid or ask price for a market pair using `market_pair.maker.market.c_get_price()`. ```python market_pair.maker.market.c_get_price() ``` -------------------------------- ### Run Gateway Setup Script Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/gateway/installation.md Execute the `gateway-setup.sh` script using pnpm to copy default configuration files from the source to the Gateway's configuration directory. ```bash pnpm run setup ``` -------------------------------- ### Invoke Hummingbot Skills in OpenClaw Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/mcp/skills.md Examples of how to invoke installed Hummingbot skills using slash commands within the OpenClaw chat interface. ```bash /hummingbot start /lp-agent run-strategy /hummingbot-deploy deploy-api /hummingbot-developer verify-build ``` -------------------------------- ### Setup and Deploy Hummingbot Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/installation/hummingbot-client.md Configures the Hummingbot environment and deploys the client. The setup command optionally enables Gateway for DEX trading. ```bash make setup make deploy ``` -------------------------------- ### Update Hummingbot Gateway (Source) Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/installation/update.md Update the Hummingbot Gateway from source by pulling the latest changes from the main branch, installing dependencies, and starting the development server. ```bash cd gateway git pull origin main pnpm install pnpm start --dev --passphrase=PASSPHRASE ``` -------------------------------- ### Create Perpetual Market Making Strategy Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/blog/posts/trading-on-grvt-with-hummingbot-complete-bot-development-guide/index.md Initiate the creation of a new trading strategy within Hummingbot. This command starts the interactive setup process for a bot. ```text >>> create ``` -------------------------------- ### Start a Strategy or Script from File Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/blog/posts/using-osmosis-with-hummingbot/index.md Run a specific strategy or script by providing its file name to the 'start' command. Use '.yml' for strategies and '.py' for scripts. ```bash >>> start ``` ```bash start --script ``` -------------------------------- ### Hold Portfolio Value Calculation Example Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/client/history.md Illustrates the calculation for Hold Portfolio Value, considering base and quote assets at their starting values and current market price. ```text Hold portfolio value = (base start asset*current market price)+ quote start asset From the above example, for the Hold portfolio value is (155248*0.0000809)+23.33=35.89 ``` -------------------------------- ### Start a V2 Strategy with a Configuration File Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/strategies/scripts/index.md Use this command to start a script using a previously created YAML configuration file. Auto-complete will suggest config files from the conf\/scripts directory. ```shell start --v2 [CONFIG_FILE_NAME.yml] ``` -------------------------------- ### Example Uniswap API Request with cURL Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/blog/posts/hummingbot-gateway-architecture-part-2/index.md Use these cURL commands to make sample requests to the Hummingbot Gateway for Uniswap. Verify your setup by checking the expected output. ```bash curl -X GET "http://127.0.0.1:3000/amm/price?exchange=uniswap&token_a=WETH&token_b=USDC" ``` ```bash curl -X GET "http://127.0.0.1:3000/amm/price?exchange=uniswap&token_a=USDC&token_b=WETH" ``` -------------------------------- ### Run dYdX Setup Script Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/blog/posts/using-dydx-v4-with-hummingbot/index.md Execute the setup_dydx.sh script to download necessary Docker images and launch dYdX-specific Hummingbot containers. ```bash bash setup_dydx.sh ``` -------------------------------- ### Start Hummingbot Bot Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/blog/posts/using-dexalot-with-hummingbot/index.md After configuring your bot, use the 'start' command in the Hummingbot client to launch the market making strategy. Confirm with 'Yes' when prompted. ```bash start ``` -------------------------------- ### Quickstart Hummingbot with Grid Strike Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/blog/posts/strategy-guide-grid-strike/index.md Use this command to automatically start the Grid Strike strategy without interactive password entry. Ensure you replace '[PASSWORD]' with your actual Hummingbot password. ```bash /bin/hummingbot_quickstart.py -p [PASSWORD] -f v2_with_controllers.py -c conf_v2_with_controllers_1.yml ``` -------------------------------- ### Docker Compose Services Status Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/blog/posts/quickstart-dashboard/index.md This output shows the status of the Docker containers after the setup script has been executed. It indicates that the network, volumes, and core services like the dashboard, backend API, and Hummingbot broker have started successfully. ```bash [+] Running 7/7 āœ” Network deploy_emqx-bridge Created āœ” Volume "deploy_emqx-data" Created āœ” Volume "deploy_emqx-log" Created āœ” Volume "deploy_emqx-etc" Created āœ” Container dashboard Started āœ” Container backend-api Started āœ” Container hummingbot-broker Started ``` -------------------------------- ### Start a Script with a Configuration File Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/client/config-files.md To run a script using a configuration file, use the `start --v2` command followed by the name of your YAML config file located in `conf/scripts`. ```bash start --v2 conf_simple_pmm_1.yml ``` -------------------------------- ### Run Quants Lab Installation Script Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/quants-lab/index.md Execute the install.sh script to set up the quants-lab Anaconda/Miniconda environment, install dependencies, set up databases, and create a .env file. ```bash ./install.sh [INFO] šŸš€ Welcome to QuantsLab Installation! [INFO] This script will: [INFO] 1. Check prerequisites (conda, docker, docker compose) [INFO] 2. Create conda environment from environment.yml [INFO] 3. Install QuantsLab package in development mode [INFO] 4. Setup databases (optional) [INFO] 5. Create .env file with defaults [INFO] 6. Test the installation ``` -------------------------------- ### Install Hummingbot Core Skill for OpenClaw Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/mcp/skills.md Install the core 'hummingbot' skill into your OpenClaw workspace. Skills are installed to ~/.openclaw/workspace/.agents/skills/. ```bash npx skills add hummingbot/skills/skills/hummingbot --yes ``` -------------------------------- ### Add Account Namespace Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/hummingbot-api/routers.md Example of creating a new account namespace for organizing credentials. ```bash POST /accounts/add-account?account_name=... Create a new account namespace ``` -------------------------------- ### Install Docker on Linux (Headless Servers) Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/client/installation.md Installs Docker on Linux servers using a script. Ensure you have curl installed. ```bash curl -fsSL https://get.docker.com -o get-docker.sh sh get-docker.sh ``` -------------------------------- ### Install System Packages for Anaconda (Linux) Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/client/installation.md Updates system packages and installs necessary build tools before installing Anaconda on Linux. ```bash sudo apt update && sudo apt upgrade -y && sudo apt install -y gcc build-essential ``` -------------------------------- ### TradeFeeSchema Initialization Example Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/connectors/connectors/architecture/index.md Shows how to initialize a TradeFeeSchema object with specific maker and taker percentage fees. ```python trade_fee_schema = TradeFeeSchema( maker_percent_fee_decimal=Decimal("1.0"), taker_percent_fee_decimal=Decimal("2.3") ) ``` -------------------------------- ### Install PostgreSQL DBAPI Driver Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/client/global-configs/external-db.md To use PostgreSQL with Hummingbot, you need to install the `psycopg2` DBAPI driver. This command installs it using conda. ```bash conda install psycopg2 ``` -------------------------------- ### Install and Launch Hummingbot with Docker Source: https://github.com/hummingbot/hummingbot-site/blob/main/docs/blog/posts/using-vega-protocol-with-hummingbot/index.md Clone the Hummingbot repository and use Docker Compose to set up and attach to the Hummingbot container. Ensure you have Docker installed. ```bash git clone https://github.com/hummingbot/hummingbot cd hummingbot docker compose up -d docker attach hummingbot ```