Last updated

API Status Codes

This section outlines the standard status codes returned by our API. These codes provide information about what went wrong with a request and help developers diagnose and resolve issues effectively. Each code is accompanied by a human-readable message to assist in understanding the context of the error.

In every API response, you’ll find a meta object that contains the code and message fields. The code is a machine-readable identifier representing the result of the request, while the message provides a human-readable explanation of the code when applicable. A successful response typically includes a code of 1000 and a message of null. For error responses, the code corresponds to one of the values listed below, and the message will contain a descriptive explanation to help guide error handling.

CodeNameMessage
500FAILEDnull
1000SUCCESSnull
1001SOMETHING WENT WRONGSomething went wrong. Please try again later.
1002BAD REQUESTBad Request
1003NOT FOUNDRoute not found.
1004UNAUTHORIZEDUnAuthorized
1005FORBIDDENForbidden
1006SERVICE UNAVAILABLEMaintenance mode
1007UNPROCESSABLE ENTITYThe given data is invalid.
1008TOO MANY REQUESTSToo many requests. Please try again later.
1009INTERNAL SERVER ERRORServer Error
1100USER SUSPENDEDYour account has been suspended.
1401REACH LIMIT CREDITYou reached credit limit.