Error Reference
Response Errors (HTTP 200)
Some API errors are returned with a 200 OK HTTP status but with "success": 0 in the body. Always check the success field — do not rely on message for conditional logic.
Common message values for these errors:
| Message | Cause |
|---|---|
apikey is not correct | The API key in the x-api-key header is invalid or does not exist |
number of calls per day has been exceeded | You have exhausted your 1,000 live requests for the day |
this route does not exist | The endpoint path is incorrect |
wrong param given | A query parameter has an invalid value |
Example error response:
{
"message": "apikey is not correct",
"success": false,
"source": null,
"data": null
}
HTTP Status Codes
| Code | Meaning | Common Cause |
|---|---|---|
200 | OK (may still be a logical error) | Check success field |
304 | Not Modified | ETag match — your cached copy is current |
404 | Not Found | The API is unreachable, or the requested resource does not exist |
405 | Method Not Allowed | Unexpected HTTP method for this route |
500 | Internal Server Error | An unexpected error occurred on the server |
503 | Service Unavailable | The API is in maintenance mode, or the database is temporarily unavailable |
Best Practices
- Check
successfirst. A200 OKresponse can still be an error ifsuccessisfalse. - Do not switch logic on
message. The message field is human-readable and may change. - Retry on
503. Maintenance windows are typically brief. - Handle
404gracefully. This can occur when the RSI website is unreachable inlivemode.