Quick Start Guide for Users with AI Coding Assistants.
Overview
This document is a collection of BingX API Skills for AI Coding Assistants, including 15 skill modules, covering Perpetual Futures, spot trading, Coin-M Standard Futures, copy trading, and account management.
After installation, you can directly interact in natural language withAI to query market data, place trades, and manage accounts, without writing any API request code manually.
Supported AI Assistants:Claude Code,Cursor and other AI coding assistants that support the Skills mechanism.
Install
- General Installation (Claude Code / Cursor / Others)
| npx skills add BingX-API/api-ai-skills |
- Claude Code Dedicated Installation (supports auto updates)
| /plugin add BingX-API/api-ai-skills |
For detailed installation instructions, see README.md
Skills Overview
- USDT-M Perpetual
| Skill Name | Purpose | Authorization Required |
| bingx-swap-market | Market data: Price, Depth, K-line, funding rate, open interest, etc. | Incomplete |
| bingx-swap-trade | Trading operations: Place orders, cancel orders, set leverage, asset mode, etc. | Yes |
| bingx-swap-account | Account info: Balances, current positions, fee rates, fund flows, etc. | Yes |
- Spot
| Skill Name | Purpose | Authorization Required |
| bingx-spot-market | Market data: Price, Depth, K-line,Trade history, etc. | Incomplete |
| bingx-spot-trade | Trading operations: Place orders, cancel orders, order queries,OCO orders, etc. | Yes |
| bingx-spot-account | Account info: Balances, asset overview, asset transfer, etc. | Yes |
| bingx-spot-wallet | Wallet operations: Deposit, withdrawal, transfer records, etc. | Yes |
- Coin-M Perpetual
| Skill Name | Purpose | Authorization Required |
| bingx-coinm-market | Market data: Price, Depth, K-line, funding rate, etc. | Incomplete |
| bingx-coinm-trade | Trading operations: Place orders, cancel orders, leverage, asset mode, etc. | Yes |
- Copy Trading
| Skill Name | Purpose | Authorization Required |
| bingx-copytrade-spot | Spot Copy Trading: Close copy positions, query profits, etc. | Yes |
| bingx-copytrade-swap | Futures Copy Trading: Close positions, set TP/SL, set commission, etc. | Yes |
- Account Management
| Skill Name | Purpose | Authorization Required |
| bingx-fund-account | Fund Account: Query balance, asset overview, internal transfer, etc. | Yes |
| bingx-sub-account | Sub-Account Management: Create/freeze sub-accounts,API Key management, etc. | Yes |
| bingx-agent | Partner/Broker: Invite users, query commissions, and check partner data, etc. | Yes |
- Standard Futures
| Skill Name | Purpose | Authorization Required |
| bingx-standard-trade | Standard Futures: Query position, order history, balance, etc. | Yes |
Authorization Explanation
- Skills not requiring authorization
The following market data skills can be used without configuring API Key :
- bingx-swap-market (Perp Futures market data)
- bingx-spot-market (Spot market data)
- bingx-coinm-market (Coin-M Standard Futures market data)
- Skills requiring authorization
All other trading and account-related skills require configuration of the following environment variables:
- BINGX_API_KEY — your API Key
- BINGX_SECRET_KEY — your Secret Key
API Key is created in BingX User Center → API Management .
- Operating Environments
| Environment | Description | Base URL |
| prod-live | Production (live) | https://open-api.bingx.com |
| prod-vst | Demo (no real funds required) | https://open-api-vst.bingx.com |
For full technical details on the authentication signature, see skills/references/authentication.md
Security Mechanism
- Write operation confirmation
In the prod-live (production) environment, all write operations (placing orders, canceling orders, transfers, etc.) require user input of CONFIRM before execution. No confirmation is required in the demo environment.
- Key Masking
AI will automatically mask keys when displaying them:
- API Key: Shows first 5 and last 4 characters, e.g., su1Qc...8akf
- Secret Key: Entirely masked, only shows the last 5 characters, e.g., ***...aws1
Common Use Scenarios
Once installation is complete, you can interact directly with AI using natural language. Here are some common examples:
- Market Data Query
| Query the current price of BTC-USDT |
| View the past hour's K-line data for ETH-USDT |
| What is the current funding rate for BTC-USDT? |
- Trading Operations
| Place a market buy order for BTC-USDT with an amount of 0.01 |
| Place a limit sell order for ETH at price 4,000 USDT with an amount of 0.1 |
| Cancel all open orders for BTC-USDT |
- Account Management
| View my futures account balance and current positions |
| Query my spot account balance |
| Transfer 100 USDT from my spot account to my futures account |
- Other Operations
| View my sub-account list |
| Query my partner referral list |
Multi-Skill Workflow
Multiple skills can be combined to complete full trading processes:
- Futures Trading Workflow
| swap-market (view BTC-USDT market data and depth) ↓ swap-account (check account balance and available margin) ↓ swap-trade (place order) |
- Position Management Workflow
| swap-account (view current positions and PnL) ↓ swap-market (view last price) ↓ swap-trade (close or adjust position) ↓ swap-account (confirm close result) |
- Spot Trading Workflow
| spot-market (query spot price and depth) ↓ spot-account (check spot account balance) ↓ spot-trade (place buy or sell order) |
- Cross-Account Asset Transfer
| spot-account (view spot balance) ↓ spot-account / fund-account (transfer assets to futures account) ↓ swap-trade (trade futures with transferred funds) |
File Structure
Each skill module consists of two files:
| skills/<skill-name>/ ├── SKILL.md # Agent usage description └── api-reference.md # Full API documentation |
- SKILL.md: Defines skill purpose, quick reference table, TypeScript code samples, agent interaction rules (authorization, confirmation mechanism, etc.)
- api-reference.md: Complete API endpoint documentation, including parameter details, response fields, JSON examples, and error codes
General reference documentation can be found in skills/references/ directory:
- authentication.md — HMAC SHA256 signature implementation
- base-urls.md — Environment base URL configuration
