Hummingbot docs. You will then be guided to configure the settings.

Hummingbot docs Home Documentation CLOB Connectors Polkadex 🛠 Connector Info¶. Home Documentation Hummingbot Client Start and Stop Strategy¶ Starting a strategy¶. -i n ve nt ory_skew_e na bled: True-i n ve nt ory_ tar ge t _base_pc t: 50-i n ve nt ory_ra n ge_mul t iplier: 1. When you use our software to trade on Gate. Trading logic. Select the v2_directional_rsi. Hummingbot homepage; Hummingbot whitepaper; Github Welcome to the official website and documentation for Hummingbot and the Hummingbot Foundation! This documentation site uses MkDocs documentation-focused static site engine, 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 exchange. We foster an open, technical, and community-driven approach to learning the discipline of market making. Alternatively, you can copy the section above into a *. This mode only allows to request public information from the nodes, but since it does not require credentials it does not allow to perform trading operations. To support us, just enter your API keys into Hummingbot and run bots! Currently, Hummingbot supports the following commands: Depending on the usage of the hummingbot client, you may need to add new commands to the client. All sample scripts below can be found in the root /scripts folder and are available to run from the Hummingbot client by default. ndax. The most important components to understand are: Script: Entry point for all strategies, this Python file orchestrates the strategy. 1 and an active order's spread changes from Docs » Whitepaper; Edit on GitHub Hummingbot will facilitate trade execution and interaction with different exchanges, performing actions such as price and order book retrieval, submission of trade instructions, and, if specified by the ℹ️ Exchange Info¶. g. yml file and use the import command to import it as a strategy. The Gateway API is typically a Docker container running on the same computer as Hummingbot, which hosts the external libraries and / or network nodes This strategy allows Hummingbot users to run a market making strategy on a single trading pair on a perpetuals swap (perp) order book exchange. Hummingbot v1. Users of the Docker version of Hummingbot can update their instances to the Hummingbot documentation and website. This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. The "Allocated" column shows how much of your assets are being used when there are active orders. Setting order_level_spread to a very low number may cause multiple orders to be placed on the same price level. Exchange Type: Decentralized Exchange (DEX); Market Type: Central Limit Order Book (CLOB) Hummingbot will generate self-signed certificates that a server can use to authenticate its connection with this client. Run strategy¶. Docker¶. Home Documentation Hummingbot Client Advanced Features Clock tick size¶. This is also stored as certs_path in the Hummingbot's Which chain do you want quickswap to connect to? (polygon) >>> Which network do you want quickswap to connect to? (mainnet, mumbai) >>> Enter your polygon-mainnet private key >>>> Timeframes¶. in Announcements, Engineering. 02 9746. 77 9745. 9. December 27, 2024. Gateway manages interfacing with DEX connectors and exposes standard REST API endpoints for trading and liquidity-related functionality on these DEXs. io, a custom API header tells Gate. Hummingbot Foundation maintains certain reference connectors as the standard and utilizes a community-based maintenance process. 0, PMM Scripts are an earlier component that allows users customize the behavior of the Pure 📓 Description¶. Which chain do you want traderjoe to connect to? (avalanche) >>> Which network do you want traderjoe to connect to? (avalanche, fuji) >>> Enter your avalanche-avalanche private key >>>> 📓 Description¶. How it works¶. Now, users can adjust this setting and define a custom tick_size parameter. Spot-Perpetual Arbitrage Strategy Each V1 strategy is a sub-folder in the /hummingbot/strategy folder. Network ChainId Type; mainnet: 1: mainnet: arbitrum: 42161: mainnet: optimism: 10: mainnet: goerli Hummingbot documentation and website. Above the list of files, click Compare & pull request to create a pull request for the associated branch. Scripts are a subclass of ScriptStrategy. Refer to the example below: Change the default setting in conf_client. If not, check if conda was installed correctly and reinstall if necessary. The hanging order will stay outstanding and will be cancelled if its spread Hummingbot Foundation has a fee share partnership with Binance. Users can configure this feature by setting the new config variables in the conf_client. having a bot local and another bot on AWS). However, if you're on a VIP level getting discounts on fees, you can override this by editing the conf_fee_overrides. 0; Description: The bot will place two orders around the price_source (mid price or last traded price) in a trading_pair on exchange, Voting with HBOT¶. Home Documentation Strategies V2 Executors Executors. General endpoints for all chains. Hummingbot Foundation has a fee share partnership with Bybit. The image below shows our total balance is The password in Hummingbot encrypts sensitive data such as API keys, secret keys, and wallet private keys. In the future, we should encourage community maintainers to upload DEX and chain-specific collections to the Hummingbot workspace. For example, for an asset like SNM/BTC, if you set an order interval percent of 0. They are not maintained by Hummingbot Foundation but may be maintained by a community member. You will then be guided to configure the settings. 0 | 1. Hummingbot Foundation has a fee share partnership with HTX. Run the balance paper command to check your paper trade account We are very excited to ship the January 2023 Hummingbot release (v1. 25. Introduced in version 0. 36. fi; API Docs: Curve Documentation; Fees: As of the latest update, each trade incurs a 0. We then refer to the more liquid market as the "taker side" - since the strategy is taking liquidity there. Pull Requests: #6348. Run the balance command to check the balances of all connected wallets and exchanges. Pull Requests: #6399, #138. yml file or by running config tick_size from within Hummingbot. Snapshot Proposal: NCP-9. Transactions from Hummingbot are normal transactions conducted on exchanges; therefore when operating Hummingbot, you would be subject to each exchange’s fees (e. The conversion also shows up during the status Make sure to perform extensive manual testing of your connector to ensure that users can use it when running various Hummingbot strategies. All proposal voting occur on the offical Hummingbot Snapshot, which features an off-chain, gas-less voting system that allows you to vote by signing messages using your HBOT Getting started¶. Home Developers Brokers Module. When you use our software to trade on Bitfinex, a custom API header tells Bitfinex that the trade was executed using Hummingbot, so they share a portion of your fees with us, at no cost to you. Use the start command, and then answer Yes when asked to confirm the strategy settings. The two strategies supported natively by the Osmosis connector are amm_arb and amm_v3_lp. On the page to create a new pull request, click compare across forks. Liquidity Mining Explained | For New Users: Learn about Liquidity Mining and how to set up a market-making bot to earn rewards in an exchange. Other Updates¶ Hummingbot¶ #6791 - Added OKX Perpetuals candles feed Thanks to tomasgaudino for this fix! 🙏 #6796 - Renamed Huobi to HTX Thanks to blagodar1 for this fix! 🙏 Home Documentation Hummingbot Client Advanced Features Override Fees¶. 7. yml file: See Polkadex for the exchange connector docs. To get started with Hummingbot, check out the following docs: Post Installation; Basic Features Hummingbot documentation and website. Home Documentation CLOB Connectors Dexalot 🛠 Connector Info¶. Take note of the certs_path where they are stored. 0, we are excited to introduce Hummingbot Dashboard , an open-source graphical interface designed to help Network¶. By default, Hummingbot uses the default fees of the exchange. Version: In Hummingbot code and documentation, we usually refer to the less liquid market as the "maker side" - since the cross exchange market making strategy is providing liquidity there. Exchange Type: Centralized Exchange (CEX); Market Type: Central Limit Order Book (CLOB) We are very excited to ship the December 2022 Hummingbot release (v1. Over the past Scripts are the entry point for Hummingbot strategies. In #247, we have added Hummingbot Academy, a comprehensive learning hub designed for both new and We are very excited to ship the March 2023 release of Hummingbot (v1. To support us, just enter your API keys into Hummingbot and run bots! This parameter allows Hummingbot to cancel the active order right away when its spread dips below the specified value. Hummingbot Miner Help Center: Check out our latest announcements, campaigns, documentations, handy articles and much more. Hummingbot documentation and website. The status output will show all active orders while indicating which orders are hanging. Important commands on Hummingbot client: status: Renders information about the current strategy and markets. Hummingbot pioneered a modular architecture that allowed external developers to contribute new exchange connectors and trading strategies into a shared, community-maintained Co-founder, Hummingbot Metadata November 29, 2023. It interfaces with the MarketDataProvider, which includes OrderBook, Trades, and Candles, and forwards a series The Board is an independent committee that oversees the day-to-day administration of the Hummingbot Foundation and manages the multi-signature wallet of the HBOT treasury. The deployed site at https://hummingbot. What are PMM Scripts?¶ Snippets of Python code that let users customize the Pure Market Making strategy. The assumption was that the market maker wants to end the trading day with the same inventory he started. Make sure the We introduce Hummingbot, an open source software client that allows users to create and customize automated, algorithmic trading bots for making markets on both centralized and API Docs: https://apidoc. Integrating Hummingbot with Telegram Messenger allows you to get real-time updates and issue commands to your trading bot from any device where you have Telegram installed. Run the command gateway -h to print out the different commands you can use with gateway. Through its bounty system, developers are incentivized to solve issues and implement enhancements that push the boundaries of the platform. Pull Request: #256. , Hummingbot immediately places a new order to replace a filled order. voted to allocate a bounty to fund development of an orchestration module that lets users control multiples instances of Hummingbot. Custom Indicator¶. 2. To begin trading, a strategy must be configured. Chain connectors integrate a Layer 1 blockchain and their networks into Gateway, enabling wallet access, node RPC interactions, and other support needed by DEXs supported by Gateway. We strongly recommend users point to the development 📓 Description¶. Another important risk you must consider is related to where you are executing your trades: Hummingbot documentation and website. While the Foundation maintains the core Hummingbot framework and the reference connectors for each type, the Hummingbot documentation and website. This is done by adding a new command class to the Hummingbot documentation and website. API requirements¶. In this release, we are happy to introduce the fixed_grid strategy for Hummingbot, the first community strategy created under the Developer Grant proposal HGP-4. 3 min read Introducing V2 Strategies¶ We are excited to formally introduce the V2 Strategy Framework! After months of testing by us and our community, we are confident that using this new framework to design and deploy strategies will improve your algo trading P Hummingbot stores trades in a local SQLite for database by default, but it may be limiting for some cases such as sharing data to external system, in some cases user may want to use their own preferred client/server RDBMS for it. We generally release a new version of Hummingbot every month. Adding certificates¶ All Levels: Hummingbot is designed for use by individuals and professionals alike; History¶ Hummingbot was originally built and open sourced by CoinAlpha in April 2019. Simple PMM¶. Creating script config files¶. File: *_order_book_tracker. Building Connectors¶. Paper Trade balance¶. To create a configuration file for a compatible, run the create command and add the --script-config flag. ; 🔑 How to Connect¶. In addition, we also added prompts to guide users in using Gateway commands intended for Docker and non-Docker use cases in this pull request. - Collecting and validating user inputs as config values. Opening a Pull Request¶. Install Hummingbot on Windows or Mac with Docker or Source build. We've also integrated CoinCap as a new rate oracle source and expanded the list of connectors with Woo X and Kujira. 0 Release Notes¶ Released on October 30, 2023. Integration to spot markets API endpoints. By default, Hummingbot uses the order book you're trading in to generate the mid price (between the top bid and the top ask) as a starting price to calculate maker order prices. This upgrade improves the client's performance, reliability, and security. When you use our software to trade on OKX, a custom API header tells OKX that the trade was executed using Hummingbot, so they share a portion Which chain do you want tinyman to connect to? (algorand) >>> algorand Which network do you want tinyman to connect to? (mainnet, testnet) >>> mainnet Enter your algorand-mainnet private key >>>> If you want your contribution to be reviewed, merged into the official Hummingbot codebase and included in ongoing monthly releases, you need to get a Proposal approved. Home Documentation CLOB Connectors Bitrue 🛠 Connector Info¶. 0 Release Notes¶. This allows the Foundation to support these exchange connectors better via bug Checking connection status¶. 4 (~0. With this feature, users have the option to choose a different price reference for your Strategy Description¶. For example, the image below shows the buy order is placed at 0. If the installation was successful, you should see the Hummingbot welcome screen afterwards: Let’s create a simple LimitOrder strategy that places a limit order! Hummingbot is an open source framework that helps you build automated trading strategies, or This code is free and publicly available under the Apache 2. Markets: Exchange Market Best Bid Price Best Ask Price Mid Price binance BTCUSDT 9745. Hummingbot's brokers module allows for remote control and monitoring of multi-bot environments in a distributed context , so that bots can "live" on different machines and infrastructures (e. See this Notion doc for an overview of the project. How to arbitrage AMMs like Uniswap and Balancer: Learn how you can Arbitrage AMMs with our strategy. Now let's enable order_optimization_enabled. The connector supports two different account modes: - Trading with delegate accounts - Trading through off-chain vault contracts. This section will break down some ways to debug and test the code. 0 open source license! Hummingbot Documentation¶ Quick Links. When you use our software to trade on Bybit, a custom API header tells Bybit that the trade was executed using Hummingbot, so they share a portion of your fees with us, at no cost to you. We fund development bounties to incentivize contributions from the community. Hummingbot's config module helps onboard users who are new to running a trading bot. In this tutorial, we'll guide you through installing Hummingbot 2. Code: simple_pmm Author: cardosofede; Release Added: Configurable 1. Was this page helpful? Thanks for your feedback! Which chain do you want uniswap to connect to? (ethereum, polygon) >>> Which network do you want uniswap to connect to? (mainnet, goerli, arbitrum_one) >>> Enter your ethereum-mainnet private key >>>> Support Hummingbot. Postman is the easiest way to test Gateway on a standalone basis. io. Hummingbot is an community-driven, open source Python framework for building automated market making and algorithmic trading bots, maintained by Hummingbot Foundation. You'll see in the next image that the buy order is placed at Home Documentation Hummingbot Client User Interface Guide¶. Home Documentation Hummingbot Client How to get Balances¶ Exchange and wallet balance¶. 0, which provides an easy-to-use Dashboard app that helps you connect exchange credentials, create/backtest a strategy configuration, and deploy a fleet of bots! Watch this video for an overview and walkthrough of the features in Hummingbot 2. token, market name, etc). e. See Exchange API Requirements for what the exchange API requirements needed to support the latest Hummingbot spot and perp connector standards. When you enter the create --script-config command and press SPACE Hummingbot will display available scripts in the scripts folder, as shown below. December 27, 2024 The TWAP strategy is a common algorithmic execution strategy used for splitting up large orders over time. A detailed performance analysis is provided below. pyx; config: Prompts users asking for details about strategy set up (e. Hedge by amount; The strategy will hedge by amount by calculating the amount to hedge by each asset. 14. 19. You Support Hummingbot. See Trading logic to understand how the strategy works. These bounties cover various aspects of the project, including: Fixing bugs and issues; To set the parameters for rate_oracle_source, global_token. We devised a trading strategy utilizing the MACD and Bollinger Bands indicators to trade the APE-BUSD pair. py — REQUIRED Each Exchange/Derivative class contains an OrderBookTracker to maintain a real-time order book of one/multiple trading pairs and is responsible for applying the Hummingbot Client Advanced Features Balance Limit. Home Documentation Hummingbot Client Advanced Features Telegram Integration. Description: Get the current status of a chain/network; Request params: {chain?, network?} Response: array of { chain, network, rpcUrl, currentBlockNumber, currentBlockSeconds(seconds since block) } for each chain/network combination; GET /network/chain_config. Home Documentation CLOB Connectors Kraken 🛠 Connector Info¶. Centralized exchange (CEX) connectors integrate into a centralized exchange's WebSocket API, enabling standardized order placement/cancellation and order book data fetching from the perspective of With this configuration, Hummingbot will create both buy and sell orders if the mid price is between 9750 and 9730. minimum_spread ¶ If the spread of any active order falls below this param value, it will be automatically canceled. We've added pages tthat describe the latest spot and perpetual connector standards, developer and QA checklists, as well as debugging and troubleshooting docs. Whether you are running Hummingbot in the cloud or on your local machine, you can use Telegram to monitor and Kujira 🛠 Connector Info¶. Starting Scripts¶. The original Avellaneda-Stoikov model was designed to be used for market making on stock markets, which have defined trading hours. Hummingbot Foundation has a fee share partnership with OKX. Subscribe to the Hummingbot Newletter to get notified when a new release ships. Run history --verbose to see all recent trades. Released on August 28, 2023. 2. There is a third account type called read_only_account. ℹ️ More Resources¶. Home Documentation Strategies V2 Architecture Components¶. To achieve this approach, there is an MQTT layer for bots to connect remotely to message brokers, as a Support Hummingbot. Keys Added column indicates if API keys are added to Hummingbot. Home Documentation Strategies V2 Controllers Controllers. 12. By leastchaos - see original pull request. 0 ¶. If there is a sustained movement in the market in any one direction for some time, there is a risk of continued trading in that direction: For example, continuing to buy and accumulate base . See below for information about each release. Hummingbot is a free software, so you can download, install, and run it for free. Updated as of v0. 00am UTC March 3, 2020 for a subset of our launch partners: Harmony; We are very excited to ship the August 2022 Hummingbot release (v1. 21. For example, setting order_refresh_tolerance_pct to 0. Note Should your script run into an error, it's crucial that you exit Hummingbot entirely, correct or debug the faulty script, and then restart Hummingbot. Home Documentation CLOB Connectors Hyperliquid 🛠 Connector Info¶. In the auto-complete dropdown, only the configurable scripts located in the /scripts folder will be shown. This can be useful when running multiple bots on different Hummingbot documentation and website. When you use our software to trade on Binance, a custom API header tells Binance that the trade was executed using Hummingbot, so they share a portion of your fees Hummingbot relies heavily on community maintainers to keep the project up-to-date and expand its capabilities. Executors are tasked with managing the state of orders — initiating, refreshing, and 🐦 With Hummingbot you can enable the paper trading mode using the command paper_trading, which allows you to test your strategy in a real-time simulated environment, without the need to put your capital at risk. . Stop a running strategy¶ We are very excited to ship the September 2022 Hummingbot release (v1. io that the trade was executed using Hummingbot, so they share a portion of your fees with us, at no cost to you. This documentation site uses MkDocs documentation-focused static site engine, along with Material for MkDocs theme, of which Hummingbot is a proud sponsor. GET /network/status. Navigate to the Github link where you created your fork. Keys Confirmed column shows the status if Hummingbot has successfully connected to the exchange or protocol. The CLI is divided into five panes: Input pane (lower left): Where users enter commands Output pane (upper left): Prints the output of the user's commands Log pane (right): Log messages Top navigation bar: Displays the status/information of the following items. The ping pong strategy tries to keep buys and sells balanced by only creating orders on the opposite side of an order that is filled. Follow the guides below: Manual testing under Gateway V2; Client testing and Postman: Gateway V2 connector testing guide; 10. The history command displays the current duration of total past trades, asset inventory and value, and market trading pair performance. Executors in Hummingbot are self-managing components that handle the execution of orders according to predefined conditions set by Controllers, which, in turn, utilize data from the MarketDataProvider (Candles, Orderbook, Trades). Once a month, we publish an official release of Hummingbot and Hummingbot Gateway, marked by code release on Github and DockerHub and the publication of the release notes. Below are configurable variables that are available in the Pure Market Making strategy. Creating a password¶ If you are using Hummingbot for the first time, the system will prompt you to create a password. The fixed_grid strategy is similar to "Grid Trading Bot" strategies available on popular exchanges such as Binance and Kucoin, which are often the entry point of users to algorithmic OrderBookTracker¶. For information on developing gateway connectors that use Gateway, see Building Gateway Connectors. How to Use the New Spot-perpetual Arbitrage Strategy: Learn how the spot-perpetual arbitrage strategy works and how you can make use of it. After creating or importing a config file, use the start command to run the strategy. HBOT token holders can create and vote on various types of Proposals to allocate HBOT bounties toward maintenance of various components in the Hummingbot codebase. Hummingbot Foundation has a fee share partnership with Gate. 895 Assets: BTC USDT Total Home Documentation AMM Connectors Mad Meerkat 🛠 Connector Info¶. Hummingbot Foundation has a fee share partnership with Kucoin. They standardize interactions with the idiosyncratic APIs offered by these platforms, for purposes such as gathering order book and blockchain Home Documentation Hummingbot Client Advanced Features Paper Trade. 29. List of V1 Strategies¶ Strategies have passed the Minimum Voting Power Threshold in the latest Poll and are included in each monthly release. 0) today! Variable Tick Size¶ Previously, the default tick size (how long it takes Hummingbot to loop through a strategy iteration) was set at 1 second. Create a wallet on one of the supported networks below: For more information, refer to the Carbon connector docs. hummingbot/hbot-remote-client-py: A remote client for Hummingbot in Python [NEW] hummingbot/dashboard: Dashboards that helps you visualize and analyze your Hummingbot strategies; See Algorand for Home Releases Hummingbot v1. 35. Specifically, the TWAP strategy helps traders minimize slippage when buying or selling large orders. Each connector is customized for a particular blockchain's idiosyncrasies to enable this level of standardization, so they may should ideally Hummingbot solves this problem via the Gateway API architecture. 04% trading fee for liquidity providers. Create connector documentation page¶ 📁 Folder hummingbot-site: docs/gateway Hummingbot Gateway is open source API middleware that helps the Hummingbot client to connect to decentralized exchanges (DEX) on various blockchain networks. 10 and updates its most important dependencies. >>> gateway-h usage: gateway [-h] {create, config, connect, connector-tokens, generate-certs, start, status, stop, test-connection} positional arguments: {create, config, connect, connector-tokens, generate-certs, start, status, stop, test-connection} Hummingbot documentation and website. This strategy contains 2 mode of hedging. At this stage, you may modify the options or simply hit ENTER to accept the default values. Exchange Type: Decentralized Exchange (DEX); Market Type: Central Limit Order Book (CLOB) Hummingbot is a global community of developers and traders who use the Hummingbot open source framework to build all kinds of algo trading strategies. To gain a deeper understanding for how Hummingbot connectors work, we recommend reading the following engineering posts from Hummingbot's original technical 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 of of Hummingbot; Twitter: Get the latest announcements about Hummingbot The pancakeswap connector now uses wallet [pubKey] on binance-smart-chain-mainnet We plan to release an enhanced version of Hummingbot, Hummingbot Pro, that allows for high performance back testing with high resolution historical order book data. Listing Gateway commands¶. py script and press ENTER. Hummingbot Foundation has a fee share partnership with Bitfinex. In the "base branch" dropdown menu, select the development branch. Exchange Type: Centralized Exchange (CEX); Market Type: Central Limit Order Book (CLOB) By default, Hummingbot places orders as soon as there are no active orders; i. The first four campaigns go live at 12. The information that you want displayed can be customized with format_status() function in {strategy name}. maker, taker, and withdrawal fees), as you would if you were trading on that exchange normally (i Ultimately the market and levels of participation will determine the equilibrium rates, but our Hummingbot Miners web app will show users real-time rates of return available from running Hummingbot in various markets so that they can decide to participate when rates are attractive vis-a-vis alternative uses of inventory. yml inside the conf or hummingbot_conf directory, depending on your installation method. It also allows users who install from source to utilize the latest version Connector Development and Governance Docs¶ This release features a revamped Building Connectors section for developers building connectors to order book spot and perpetual exchanges. ID: perpetualprotocol; Connection Type: REST via Gateway; API Docs: Run a Strategy¶. 4%) because of low asset value, the price of the next order will be rounded to the nearest price supported by the The Hummingbot Miner platform has been live for one year! When we launched Hummingbot Miner on March 3, 2020, we kicked off a new and sustainable way for issuers to source liquidity for their tokens. Sets the amount limit on how much assets Hummingbot can use in an exchange or wallet. Trades are saved locally in a . Starting with version 1. Description: Display the configuration Hummingbot documentation and website. It also shows failed connections due to connectivity issues, invalid API key permissions, etc. Exchange Type: Centralized Exchange (CEX); Market Type: Central Limit Order Book (CLOB) For more community events, check out the Hummingbot Events Calendar. If you haven’t already, connect a wallet to Support Hummingbot. When you use our software to trade on Kucoin, a custom API header tells Kucoin that the trade was executed using Hummingbot, so they share a portion of your fees with us, at no cost to you. Home Documentation CLOB Connectors Bitget 🛠 Connector Info¶. Home Documentation Glossary¶. Exchange Type: Centralized Exchange (CEX); Market Type: Central Limit Order Book (CLOB) They enable Hummingbot users to build customized strategies using the Strategy V2 framework, and access the full power of Hummingbot exchange connectors in a few lines of Python code. 003165 with the order optimization disabled. This should expose you to different parts of the Hummingbot codebase, help you understand some core classes that are frequently referred to when building strategies, and provide a starting point for developing custom Exchange API Requirements¶. This feature allows users to test Hummingbot and simulate trading strategies without risking any actual assets. It was a data-driven approach for rewarding a decentralized group of market makers for providing liquidity and harnessing the collective trading Hummingbot can now collect real-time market data in the background for the trading pairs that are initialized in the running strategy. Warning. 0. When you use our software to trade on MEXC, a custom API header tells MEXC that the trade was executed using Hummingbot, so they share a portion of your fees with us, at no cost to you. Quickstart Guide for amm_arb (deprecated): This guide will walk you through the installation and launch of the new amm_arb strategy December 27, 2024 Hummingbot documentation and website. Follow the Installation docs for your environment; Code your script inside the /scripts folder; Run your script with start --script [SCRIPT NAME]; Scripts basics¶ Configuration¶. Similar to the pure_market_making_strategy, the perpetual_market_making strategy Which chain do you want openocean to connect to? (avalanche, ethereum, polygon, harmony) >>> Which network do you want openocean to connect to? (mainnet) >>> Enter your polygon-mainnet private key >>>> Hummingbot documentation and website. 0) today! New Exchange Certification Program¶ We introduce a new program that certifies certain exchanges in the Hummingbot codebase, selected via a Snapshot vote by the Hummingbot community. All the major components of Hummingbot, As an open source project, Hummingbot thrives on the contributions of developers around the world. Exchanges with REST APIs must provide: Endpoint to get trading rules. Repository Description GitHub Release See Kujira for the chain docs and Kujira Fin for the exchange connector docs. It may be a simple file that contains all strategy logic, or one that loads one or more Controllers. org uses the Insiders build of MkDocs-Material, which features experimental features like tags and Hummingbot Foundation's purpose is to empower Hummingbot Governance Token (HBOT) token holders to govern how the Hummingbot open source codebase evolves over time. - Skip or provide default variables that are more advanced / have the potential to confuse new users. Make sure the bot not in PAPER TRADE. Hummingbot Foundation has a fee share partnership with MEXC. Exchange Type: Decentralized Exchange (DEX); Market Type: Central Limit Order Book (CLOB) CoinAlpha/hummingbot-docs. The Board conducts quarterly virtual board meetings to discuss Foundation progress and strategy. 0! This version introduces a new 9-step Intro to Dashboard quickstart guide, along with a new authentication module in Dashboard. Prepare¶. Released December 26, 2024 Hummingbot is a community-driven open source project that provides standardized exchange connectors and a strategy framework that enables the development of custom algorithmic trading strategies that can run on any compatible exchange. Home Documentation Hummingbot Client Performance History¶ History command¶. New Academy section¶. 0! This release include the launch of the new V2 Strategies framework, major improvements to Dashboard, new sample scripts including the return of Fixed Grid, and new connectors to Injective (direct Python, no Hummingbot Dashboard Quickstart Guide. Website: Curve. global_token_symbol, run the config command. Summary. Setting our bid and ask threshold to a very small value (0. Set up a strategy following the instructions on this page: Hummingbot Academy quickstart. In addition, the Board regularly corresponds over group chat to handle multi This is an optional feature, and more basic scripts may elect to hardcode their parameters in the script file. Create a new proposal in the appropriate Snapshot sub-space following the instructions on the Proposals page. 0: Updating Hummingbot¶. We're excited to present Hummingbot version 1. Thanks to tiagofilipenunes for this contribution! 🙏. yml to GBP (Great Britain Pound). io/ Fees: From inside the Hummingbot client, run connect ndax: Enter your ndax user ID (uid) >>> Enter the name of the account you want to use >>> Enter your ndax API key >>> Enter your ndax secret key >>> If connection is successful: You are now connected to ndax. The information below are for developers building spot and perp connectors that integrate directly into the Hummingbot client. 🔀 Spot Connector¶. Exchange Type: Decentralized Exchange (DEX); Market Type: Central Limit Order Book (CLOB) With inventory skew, Hummingbot will maintain a target balance with respect to the allowable asset. Home Documentation CLOB Connectors Bitmart 🛠 Connector Info¶. Without balance limit. 0) today! This release focused on improving the docs by adding a new Quickstart guide, revamping the Installation section, and generally adding more video 📺 content to many pages! In 2019, Hummingbot was introduced as a command-line based market-making bot. Python 3. 0) today! The Gateway developer setup docs now reflect this new, simpler workflow. 🧢 Hummingbot Helper is an AI assistant that helps users craft advanced trading strategies, understand the codebase and docs, and control their bot instances! 🚀 - hummingbot/helper After you have run through the first notebook that creates a vector database based on the Hummingbot docs, you can also test out RAG-based prompts using a Home Releases Releases. csv file located in the data folder which you can view by running history --verbose --days 📓 Description¶. Exchange Type: Decentralized Exchange (DEX); Market Type: Automatic Market Maker (AMM) Today marks an important milestone for Hummingbot as we launch the first live campaigns for liquidity mining! The inaugural campaigns will last for a period of 12 weeks with a total reward pool of USDC 51,000. The strategy sets buy or sell limit orders on the maker exchanges, these orders are set when 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. 0) today! See below for the highlights in this release. 1%) puts our orders at the top of the order book. 11. Introduction¶ We're thrilled to present Hummingbot version 1. They give you more control over how your market making bot behaves. They enable Hummingbot users to build customized strategies using the Strategy V2 framework, and access the full power of Hummingbot exchange connectors in a few lines of Python Run Hummingbot. You are not required to use these options during Setting it to -1 will disable the feature, which means Hummingbot will always cancel and create orders every order_refresh_time seconds. Our experiment integrates MACD and Bollinger Bands to create a custom indicator for potential mean reversion points in the market. : Support Hummingbot. Endpoint to check the server status (in general any endpoint returning a low amount of information could serve for this purpose, but a ping or time endpoint would be ideal). When you use our software to trade on HTX, a custom API header tells Huobi that the trade was executed using Hummingbot, so they share a portion Check out the Hummingbot Events Calendar for links to these and other upcoming events!. If you are a developer interested in participating in a Hummingbot bounty, here are the steps you need to Hummingbot documentation and website. 10 Upgrade¶ #6389 upgrades Hummingbot's Python version to 3. It is designed to be modular and extensible, allowing Follow the instructions in Installation and install Hummingbot from source. Introduction¶. For example, here are the DAI and HBOT entries from the default Token List for Ethereum Mainnet: For reference check the Uniswap Docs here. The strategy operates by maintaining the 'order amount' base balance across the taker and maker exchanges. To support us, just enter your API keys into Hummingbot and run bots! The conda activate hummingbot command should add a (hummingbot) label in front of your command line, which lets you know that you are inside the conda environment. Run the connect command to view the status of each connector. After 60 seconds, Hummingbot will create a new set of buy and sell orders. 8. Other RDBMS are supported on Hummingbot through SQLAlchemy, it has included some widely used RDBMS dialects, i. 003159 and the sell order at 0. After starting the amm_arb strategy, you’ll see the apparent prices on the AMM market will track the prices on Hummingbot uses the Token Lists standard to define a token dictionary for each network. Index. The Controller plays a crucial role within Hummingbot's Strategy V2 framework, serving as the orchestrator of the strategy's overall behavior. For developers and advanced users, the Hummingbot Python Library has been rolled out. Support Hummingbot. global_token_name and global_token. For security reasons, the password is only stored locally in encrypted form, and we do not have access to it. HBOT holders can vote on Proposals and Polls The Hummingbot Foundation (the “Foundation”) is a not-for-profit organization established in the Cayman Islands. When you start diving into the Hummingbot ecosystem, you'll probably encounter some unfamiliar terms and phrases along the way. The Foundation’s mission is to democratize high-frequency trading by enabling decentralized maintenance Add Keys to Hummingbot¶ You will need the following to connect Hummingbot to dydx_v4_perpetual: dYdX v4 secret_passphrase (24 words) dYdX v4 chain address (starts with dydx) From inside the Hummingbot client, run connect dydx_v4_perpetual in Hummingbot in order to connect your wallet: AMM connectors require ongoing maintenance: fixing bugs, addressing user issues, and keeping up with updates to both the exchange/blockchain API as well as improvements to the Hummingbot connector standard. Home Documentation Strategies V1 PMM Configs External Pricing Source Configuration¶. Demystifying liquidity mining rewards. Updated on version 0. It is helpful in - Compiling a list of absolutely essential config variables. Home Documentation Strategies V1 PMM Configs PMM Configs. The conversion will show up when you run balance command. It gives you the ability to plug in any strategy written for Hummingbot, run historical order book data traces with it, and give you the output on the trading performance for that Here, you can download collections and environments for use with Hummingbot. With the 2024 release of Hummingbot 2. 0, the tick_size is now added as a variable in the ClientConfigMap, this means that you will be able to change the value of the tick size in the conf_client. znhxpu ncku zoewq upo zqrp jfko iki sjphpw yrgicur tgdhy