Error Codes
All API requests return the following common parameters to describe the request results:
- code: Business status code
- message: Status description
| code | message | message detail | Notes |
|---|---|---|---|
| 0 | success | Request successful | |
| 1 | server error | This status code is returned when request parameters cannot be processed, or when the server itself has service exceptions | |
| 2 | network read time out | Request network timeout. Check network conditions, consider deploying close to OpenAPI services, or use stable dedicated line services | |
| 4 | access forbidden | Access denied, possible reasons: 1. IP whitelist is configured but the requesting machine is not in the whitelist 2. Account may be blacklisted due to frequent requests or too many error requests 3. Long connection signature verification failed 4. Long connection subscribed too many symbols, exceeding the limit | |
| -- | You don't have permission to subscribe quotes, please purchase api quotes permission first | No permission for long connection subscription, subscription quota is 0 | |
| -- | According to your user level, you can only subscribe to xxx symbols | Long connection subscription exceeded the subscribable symbol limit | |
| 5 | rate limit error | Request frequency exceeded limit. In this case, HTTP status code 429 is returned, and the error message will include the limit description per unit time | |
| 1000 | common param error | Parsing common parameters error, possible reasons: 1. Request method not supported (method parameter error) 2. Incorrect request URL address 3. Request parameters are not in standard JSON format 4. Common parameter (non-bizContent) validation error, such as timestamp format error, empty fields, sign signature field validation error, etc. | |
| -- | invalid symbols | Symbol code error | |
| -- | the current requested method does not support | Incorrect API method requested. Usually occurs when calling unsupported SDK methods, or writing wrong API methods without using SDK | |
| -- | time parse error, support time format is 'yyyy-MM-dd HH:mm:ss' | Date parameter format error | |
| -- | failed to verify signature, please make sure you use the correct rsa private key | Signature error, usually caused by incorrect key | |
| -- | request parameters cannot be empty | Request parameters cannot be empty | |
| -- | field 'xxx' cannot be empty | Field cannot be empty | |
| -- | failed to get developer information | Failed to get developer information. Usually tigerid doesn't exist or requested wrong environment (e.g., production tigerid requested to sandbox, or US tigerid requested to non-US) | |
| -- | get device information error | Device ID error | |
| 1010 | biz param error | bizContent parameter parsing error, possible reasons: Business parameter validation error (e.g., begin_time format error, sec_type not supported) | |
| -- | failed to parse parameters in 'biz_content' | biz_content parameter content error | |
| -- | field 'secret_key' or 'account' invalid | Business parameter error: institutional account secret_key or account error | |
| -- | 'market' xxxx not supported, all supported market include:[HK] | Market not supported | |
| -- | 'page_token' is used in the wrong way, when this parameter is used, other parameters cannot be changed | Pagination parameter page_token used incorrectly. When using page_token, all other parameters except this one should remain unchanged | |
| -- | field 'page_token' is illegal, can't be parsed | page_token error | |
| -- | option symbol format error | Option identifier format error | |
| -- | sec_type xxx error, current contract interface supported sec_type include:[STK, OPT, FUT] | sec type error | |
| -- | symbols cannot be empty and cannot exceed xxx | Symbols empty or quantity exceeds limit | |
| 1100 | global account response error | Global account trading error, such as: 1. TRADE DUPLICATE ORDER ID: Trading order ID duplicate 2. TRADE ORDER NOT ALLOWED: Order placement currently not allowed | |
| 1200 | prime account response error | Prime account trading error, such as: 1. BAD_REQUEST:Orders cannot be place at this moment: Cannot place orders at current time 2. BAD_REQUEST:You cannot place market or stop order during pre-market and after-hours trading: Cannot place market or stop orders during US pre-market and after-hours trading 3. The order quantity you entered exceeds your currently available position: Order quantity exceeds tradable quantity 4. bad_request:We don't support trading of this stock now: Trading of this symbol is not supported | |
| 1300 | paper account response error | Paper account trading error, error descriptions are basically the same as prime account | |
| 2100 | stock response error | Stock market data related error | |
| 2200 | option response error | Option market data related error | |
| 2300 | futures response error | Futures market data related error | |
| 2400 | user token error | HK license token error | |
| user token can not be empty | Token is empty | ||
| user token expired invalid | Token expired | ||
| user token invalid | Token invalid | ||
| 3xxx | subscribe error | Subscription data related error, possible reasons: 1. tigerId exception during subscription 2. Server exception occurred during subscription 3. Unsupported market data provider parameter 4. Unsupported subscription type 5. Number of subscriptions exceeded limit requirements | |
| 4000 | permission denied | Insufficient access permissions, access denied, possible reasons: 1. K-line market data request time period exceeds allowed range 2. Tick data request time period exceeds allowed range 3. Market data requesting device not in allowed range (only one device supported when multiple devices compete for market data) 4. Market data permissions do not meet requirements | |
| 4001 | kick out by a new connection | Long connection channel has been kicked out by a newly established connection |
Updated 1 day ago