Open API status codes
About this document
This document defines the status code conventions returned by Open API endpoints, clarifying call results, error types, and causes to help developers diagnose and resolve issues quickly. All API endpoints follow these rules.
Status code ranges
| Range | Category |
|---|---|
| 200 | Success (call completed normally) |
| 1xxxx | General errors (uncategorized) |
| 2xxxx | Authentication and authorization |
| 4xxxx | Request / parameter validation |
| 5xxxx | Endpoint-related errors |
| 6xxxx | Rate limiting |
| 7xxxx | Business logic errors |
Status code details
1. Success
| Code | Enum | Description |
|---|---|---|
| 200 | SUCCESS | Call succeeded |
2. General errors (1xxxx)
| Code | Enum | Description |
|---|---|---|
| 10000 | UNKNOWN_ERROR | Unknown error; contact technical support |
3. Authentication and authorization (2xxxx)
| Code | Enum | Description |
|---|---|---|
| 20001 | API_KEY_MISSING | API key missing (not provided in the request) |
| 20002 | API_KEY_INVALID | Invalid API key (disabled, expired, or not approved) |
| 20010 | TIMESTAMP_MISSING | Timestamp missing (not provided in the request) |
| 20011 | TIMESTAMP_FORMAT_ERROR | Invalid timestamp format (must be 10 or 13 digits) |
| 20012 | TIMESTAMP_EXPIRED | Timestamp expired (request timed out; regenerate and retry) |
| 20020 | SIGNATURE_MISSING | Signature missing (not provided in the request) |
| 20021 | SIGNATURE_VERIFY_FAILED | Signature verification failed (wrong signing rules or tampered parameters) |
4. Request / parameter validation (4xxxx)
| Code | Enum | Description |
|---|---|---|
| 400 | INVALID_REQUEST | Request body cannot be parsed (check parameter format per docs) |
| 404 | NOT_FOUND | Endpoint path does not exist (check the request path) |
| 405 | REQUEST_METHOD_NOT_ALLOWED | Method not allowed (check the HTTP method per docs) |
| 40001 | REQUIRED_PARAMS_EMPTY | Required parameter missing |
| 40002 | REQUIRED_PARAMS_ILLEGAL | Invalid parameter (format or value out of range) |
5. Endpoint errors (5xxxx)
| Code | Enum | Description |
|---|---|---|
| 50001 | INTERFACE_NOT_FOUND | API endpoint does not exist (wrong path) |
6. Rate limiting (6xxxx)
| Code | Enum | Description |
|---|---|---|
| 60001 | INTERFACE_RATE_LIMIT | Rate limit exceeded; retry later |
7. Business logic (7xxxx)
| Code | Enum | Description |
|---|---|---|
| 70001 | NOT_ENOUGH_CREDIT | Insufficient account balance; please top up |