Errors
In this guide, we will talk about what happens when something goes wrong while you work with the API. Let's look at some status codes and error types you might encounter.
You can tell if your request was successful by checking the status code when receiving an API response. If a response comes back unsuccessful, you can use the error message to figure out what has gone wrong and do some debugging.
Status codes
Here is a list of the different categories of status codes returned by the Open Scripture API. Use these to understand if a request was successful.
- Name
2xx- Type
- Description
- A 2xx status code indicates a successful response.
- Name
4xx- Type
- Description
- A 4xx status code indicates a client error — this means there's something wrong with how your request was formatted
- Name
5xx- Type
- Description
- A 5xx status code indicates a server error — you generally won't see this type of error
Error types
Whenever a request is unsuccessful, the Open Scripture API will return an error response with an error message. You can use this information to understand better what has gone wrong and how to fix it. Most of the error messages are pretty helpful and actionable.
Error response
{
"error": "Missing API key in query params",
}