Errors

Every response uses a consistent JSON envelope, so an integration can branch on one shape. These are the conventions the public API follows.

Response envelope

A successful response carries a success flag, a message and the data payload:

{ "success": true, "message": "Success", "data": { } }

An error response carries the flag and a human-readable message:

{ "success": false, "message": "Reason for the error" }

Status codes

• 400 Bad Request — the request was malformed or a parameter was invalid.
• 401 Unauthorized — the API key is missing or invalid.
• 403 Forbidden — the key is valid but not permitted for this resource.
• 404 Not Found — the resource or route does not exist.
• 429 Too Many Requests — a rate limit was exceeded (see Rate Limits).
• 500 Internal Server Error — an unexpected error on the platform.