FAQs
Last Updated: 2026-04-14
Document Summary: This guide is designed to assist developers in quickly integrating the WEEX API, addressing common technical issues regarding permission configurations, rate limits, and trading processes.
1. Account & Permission Configuration
API Key Permission Types
When creating an API Key, please check the corresponding permission options based on your business needs:
| Permission | Description | Use Case |
|---|---|---|
| Readonly | Read-only permission. Only allows calling query-based endpoints (e.g., balance, positions, trade history). No trading operations allowed. | Asset monitoring, ledger syncing, market analysis. |
| Spot | Spot trading permission. Allows placing/canceling orders and querying assets specifically in the Spot market. | Spot quant bots, automated rebalancing. |
| Futures | Futures trading permission. Allows opening/closing positions, setting TP/SL, and querying positions in Futures markets (USDT-M/Coin-M). | Futures hedging, high-frequency contract strategies. |
Note: These three permissions are independent. If you need to operate both Spot and Futures, ensure both are checked or create separate keys for isolation.
Why is my API permission disabled or returning an "API Restricted" error?
- Risk Control Trigger: If the account triggers platform security risk controls (e.g., suspicious logins, high-frequency invalid requests), API permissions may be automatically disabled.
- Reactivation Process: Please contact Customer Support.
- Effective Time: Newly created or modified API Keys usually take approximately 15 minutes to propagate globally across the system.
Security Recommendations for Creating API Keys
- Passphrase: When setting your API Passphrase, do not include special characters (alphanumeric only).
- IP Whitelist: It is highly recommended to enable an IP Whitelist to enhance security.
2. Rate Limits
WEEX imposes strict weight limits on different types of interfaces to ensure system stability. If limits are exceeded, the system will return an HTTP 429 error.
| Business Type | Operation Type | Rate Limit |
|---|---|---|
| Spot Trading | Cancel Order | 80 times / 10s or 200 times / 1 min |
| Spot Trading | Place Order | 100 times / min |
| Network Connection | REST/WS Connection | 300 times / 5 mins / per IP |
| WebSocket | Channel Subscription | 240 times / hour / per connection |
3. Interface Rule Adjustments (2026/04)
The platform has refined the time range validation logic for V3 Agent/Rebate interfaces. Developers should adjust their code accordingly:
Affected Endpoints:
Specific Rules:
- Query Range:
startTimemust be within the last 365 days. - Span Limit: The maximum time span for a single query (Start to End) is 90 days.
- Default Logic: If no parameters are passed, the system defaults to querying data from the last 90 days.
4. Paper Trading Interface (NEW)
To facilitate strategy debugging and hedge mode testing, WEEX has officially launched Paper Trading endpoints. You can fully simulate the trading process without consuming real assets.
New Demo Endpoints:
- Get Account Balance: View simulated funds (SUSDT).
GET /capi/v3/sim/balance - Get All Positions: Supports viewing long/short dual-direction (Hedge Mode) positions.
GET /capi/v3/sim/position/allPosition - Place Order: Supports Market, Limit, and other order types.
POST /capi/v3/sim/order - Get Order History: Track and analyze historical simulated trade records.
GET /capi/v3/sim/order/history
5. Technical Q&A
Q1: Why does placing an order return -1052 (Insufficient permissions)?
A: This error is usually caused by:
- Permission Check: The corresponding "Futures" or "Spot" trading permission was not checked in the API management page.
- Unsupported Trading Pair: Certain tokens (e.g., new listings like TIA) may not support API trading yet.
- Interface Version: It is recommended to use V3 interfaces, as V1/V2 are being deprecated.
Q2: Why does the WebSocket connection return a 403 error?
A: When establishing a WebSocket connection, you must include User-Agent info in the Header (content can be custom). If this field is missing, the request will be blocked by the firewall.
Q3: Why does canceling an order return -1054?
A: Order does not exist. This is typically due to providing an incorrect order ID during the cancellation request.
Q4: How do I get all tradable Symbols?
A:
Spot: Visit Get Spot Trading Pairs Interface.
Futures: Visit Get Futures Trading Symbols Interface.
Q5: Why am I getting a 404 error?
A: Check your path. For example, to get all positions, use GET /capi/v3/account/position/allPosition.
Q6: Does changing leverage trigger a WebSocket push?
A: Yes. Only placing orders, closing positions, and adjusting margin will trigger updates.
Q7: Are TradingView or FIX API supported?
A: Currently, neither is supported.
6. More Support
If you encounter technical difficulties during development, you can obtain support through the following channels:
- Official API Docs: WEEX API Documentation
- Telegram Tech Support Groups:
- API trading involves high risk; ensure your code includes robust error-handling logic.
- Never disclose your API Key or Secret Key to third parties.
- The content of this document may change with system upgrades. Please refer to the latest official API documentation.