Skip to main content

Error Handling

All API endpoints return standard HTTP status codes. In case of an error, the response will include an error message and, if applicable, additional error details.

Success Responses

  • 200 OK: The request was successful, and the server returned the requested data.
  • 201 Created: The request was successful, and a new resource was created.

Example success response:

{
"status": 200,
"message": "Request successful",
"data": {
"id": 12345,
"name": "Sample Resource"
}
}

Client Errors

  • 400 Bad Request: The server could not understand the request due to invalid syntax.
  • 401 Unauthorized: Authentication is required or has failed.
  • 403 Forbidden: The client does not have access rights to the content.
  • 404 Not Found: The server could not find the requested resource.
  • 429 Too Many Requests: The client has sent too many requests in a given amount of time (rate limiting).

Example error response:

{
"status": 404,
"message": "Resource not found",
"data": null
}

Server Errors

  • 500 Internal Server Error: The server encountered an unexpected condition that prevented it from fulfilling the request.
  • 502 Bad Gateway: The server received an invalid response from the upstream server.
  • 503 Service Unavailable: The server is not ready to handle the request, often due to maintenance or overload.
  • 504 Gateway Timeout: The server did not receive a timely response from the upstream server.

Example server error response:

{
"status": 500,
"message": "An unexpected error occurred",
"data": null
}

Rate Limiting

API requests are subject to rate limiting. The current limits are:

  • 100 requests per minute per client
  • 5,000 requests per day per client

If you exceed these limits, you will receive a 429 Too Many Requests response.

Support

For API support, please contact: