Skip to main content

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:

MessageCause
apikey is not correctThe API key in the x-api-key header is invalid or does not exist
number of calls per day has been exceededYou have exhausted your 1,000 live requests for the day
this route does not existThe endpoint path is incorrect
wrong param givenA query parameter has an invalid value

Example error response:

{
"message": "apikey is not correct",
"success": false,
"source": null,
"data": null
}

HTTP Status Codes

CodeMeaningCommon Cause
200OK (may still be a logical error)Check success field
304Not ModifiedETag match — your cached copy is current
404Not FoundThe API is unreachable, or the requested resource does not exist
405Method Not AllowedUnexpected HTTP method for this route
500Internal Server ErrorAn unexpected error occurred on the server
503Service UnavailableThe API is in maintenance mode, or the database is temporarily unavailable

Best Practices

  • Check success first. A 200 OK response can still be an error if success is false.
  • Do not switch logic on message. The message field is human-readable and may change.
  • Retry on 503. Maintenance windows are typically brief.
  • Handle 404 gracefully. This can occur when the RSI website is unreachable in live mode.