Handle errors and rate limits

API errors should be handled as part of the normal workflow. Read the complete response, identify the exact cause and correct it before deciding whether to retry. Do not retry an order or position request until you have checked whether the earlier action succeeded.

Step-by-step workflow

1. 1

   Capture the complete response

   Record the operation, time, response code and response message. Keep App Secrets, access tokens and other sensitive values out of logs.

2. 2

   Read the error message first

   The response message explains the specific reason returned for that request. Use it to understand the affected field, token, order, position or limit.

3. 3

   Review the error code

   Use the code to identify the error category. Then refer to Appendix → Common API Error Codes for the standard description and recommended action.

4. 4

   Correct the cause before retrying

   Fix invalid inputs, renew an expired token, use the correct App ID or symbol, or wait for the applicable rate-limit window. Do not repeat an unchanged request.

5. 5

   Retry only when it is safe

   Read requests may be retried after a temporary failure. Before retrying an order, exit, conversion or other account-changing request, check the latest account state.

6. 6

   Verify the final state

   Use the relevant Order Book, positions, portfolio or market-data API to confirm the result. Keep the original code and message for troubleshooting if the issue continues.

7. 7

   Verify the result

   Confirm that the corrected request succeeds or that the expected account state is visible. If the request still fails, compare the latest response code and message with the Common API Error Codes table before taking another action.

Common issues

{"s":"error","code":-50,"message":"Please provide valid order parameters"}

HTTP/1.1 400 Bad Request
{"s":"error","message":"Invalid symbol"}

{"s":"ok","orderStatus":"6","message":"Pending"}

HTTP/1.1 429 Too Many Requests
Retry-After: 1

Authorization: appId:access_token

Related API reference

Continue with AI