-
-
Notifications
You must be signed in to change notification settings - Fork 76
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding BingX connector documentation.
- Loading branch information
1 parent
e689ac6
commit 18761d5
Showing
6 changed files
with
78 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
## 🛠 Connector Info | ||
|
||
- **Exchange Type**: Centralized Exchange (CEX) | ||
- **Market Type**: Central Limit Order Book (CLOB) | ||
|
||
| Component | Status | Connector Version | V2 Strategies | Notes | | ||
| --------- | ------ | ----------------- | ------------ | ----- | | ||
| [🔀 Spot Connector](#spot-connector) | ✅ | v2.1 | Yes | Supports `MARKET` order type | ||
| [🕯 Spot Candles Feed](#spot-candles-feed) | Not built | | ||
|
||
## ℹ️ Exchange Info | ||
|
||
- **Website**: <https://bingx.com/> | ||
- **CoinGecko**: <https://www.coingecko.com/en/exchanges/bingx> | ||
- **API Docs**: <https://bingx-api.github.io/docs/swap/> | ||
- **Fees**: <https://bingx.com/support/costs/> | ||
- **Unsupported Countries**: | ||
- BingX does not accept certain customers. To maintain our strong reputation in the market and ensure a robust compliant marketplace, we have decided to not seek nor accept customers from certain jurisdictions, such as Canada, Mainland China, Hong Kong SAR, Macau SAR, Netherlands, Singapore, United States (including all US territories), United Kingdom, any country that is designated as a restricted country under BingX's AML/CTF policy and any other jurisdictions where the provision of the services is prohibited or will subject us to regulatory penalty ("Restricted Jurisdictions"). | ||
|
||
## 🔑 How to Connect | ||
|
||
### Generate API Keys | ||
|
||
1. Go to [BingX Exchange](https://bingx.com/) and log in or create a new account. | ||
|
||
2. Complete your KYC if you haven't already and then open the API Key page by clicking over the profile icon in the top right corner and go to the API Management page at https://bingx.com/account/api/. | ||
|
||
3. Click on the ***Create API*** button | ||
|
||
![Create API](bingx-api1.png) | ||
|
||
4. Write a label for your API Keys and then select the permission options that you want (enabling the withdrawal permission requires linking IP addresses on the box below) and click ***Confirm*** | ||
|
||
![API Permission](bingx-api2.png) | ||
|
||
5. Enter your corresponding verification codes. | ||
|
||
![Security Verification](bingx-api3.png) | ||
|
||
6. Copy your API keys and store them somewhere safe. | ||
|
||
![Get API Key](bingx-api4.png) | ||
|
||
7. Now, you have created API keys for your BingX Exchange! | ||
|
||
### Add Keys to Hummingbot | ||
|
||
From inside the Hummingbot client, run `connect bing_x`: | ||
|
||
``` | ||
>>> connect bing_x | ||
Enter your BingX Exchange API key >>> | ||
Enter your BingX Exchange secret key >>> | ||
``` | ||
|
||
If connection is successful: | ||
|
||
``` | ||
You are now connected to bing_x | ||
``` | ||
|
||
|
||
## 🔀 Spot Connector | ||
*Integration to spot markets API endpoints* | ||
|
||
- **ID**: `bing_x` | ||
- **Connection Type**: REST / WebSocket | ||
- **Folder**: <https://github.com/hummingbot/hummingbot/tree/master/hummingbot/connector/exchange/bing_x> | ||
|
||
### Order Types | ||
|
||
This connector supports the following `OrderType` constants: | ||
|
||
- `LIMIT` | ||
- `MARKET` |