The status codes indicates if the request is successfully served or not. There are codes for success results, deprecated results, errors from the client side, and errors from the server side. These responses are the most common results returned to the developers.
Error Response Format
status: This is an object containing details about the status of the response.
code: The HTTP status code indicating the type of error. For example, it's 401, which corresponds to "Unauthorized". This means that the request lacks valid authentication credentials.
text: A human-readable description of the error status. In this case, it's "Unauthorized", which provides additional context about the error.
message: A specific message detailing the reason for the error. Here, it says "Invalid token.", suggesting that the error occurred due to an authentication token that is either missing or invalid.
{
"status": {
"code": 401,
"text": "Unauthorized",
"message": "Invalid token."
}
}
2xx Success Results
A status code of 2xx indicates that the request was successfully completed. This indicates that our servers processed the request and delivered the appropriate result.
Status Code | Text | Description |
200 | OK | The request has been successfully sent and processed. |
4xx Errors from the Client Side
A status code 4xx indicates that the website or page could not be reached because of an error that usually due to a problem on the client's end. The examples can be - Invalid request body, invalid client token, grammatical mistakes in request body, unauthorized user etc.
Status Code | Text | Description |
400 | Bad Request | The parameter you submitted is not valid. Please recheck request body before submitting the request. |
401 | Unauthorized | The credentials are not valid. You don’t have an authorization to access, the permission can’t be given. Example messsages are "Invalid token" |
403 | Forbidden | The operation is not allowed, permission can’t be given. Example messages are "Account is disabled", "Insufficient balance", "Token is disabled" |
404 | Not Found | The data you requested does not exist or cannot be found. |
405 | Method Not Allowed | The method is not allowed by process. |
429 | Too Many Request | The request limit has already exceeded, try again later. |
5xx Errors from the Server Side
The status code 5xx (Server Error) indicates that the server is unable to perform the requested operation.
Although the request appears to be genuine, the server was unable to complete it due to some technical issues.
Status Code | Text | Description |
500 | Internal Server Error | There is a crash in the website server or within the API. Contact the administrator if this keeps happening. |
503 | Service Unavailable | The server is currently unavailable. |