Errors
In this guide, we will talk about what happens when something goes wrong while you work with the API. Mistakes happen, and mostly they will be yours, not ours. 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 type and error message to figure out what has gone wrong and do some rudimentary debugging (before contacting support).
Before reaching out to support with an error, please be aware that 99% of all reported errors are, in fact, user errors. Therefore, please carefully check your code before contacting Protocol support.
Status codes
Here is a list of the different categories of status codes returned by the Protocol API. Use these to understand if a request was successful.
- Name
2xx- Description
- A 2xx status code indicates a successful response.
- Name
4xx- Description
- A 4xx status code indicates a client error — this means it's a you problem.
- Name
5xx- Description
- A 5xx status code indicates a server error — you won't be seeing these.
Error types
Whenever a request is unsuccessful, the Protocol API will return an error response with an error type and 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.
Here is a list of the two error types supported by the Protocol API — use these to understand what you have done wrong.
- Name
200- Description
- OK - Everything worked as expected.
- Name
400- Description
- Bad Request - The request was unacceptable, often due to missing a required parameter.
- Name
401- Description
- Unauthorized - Invalid token provided in Authorization header.
- Name
402- Description
Payment Required - You don’t have enough credits on your account to perform the request.
- Name
403- Description
- Forbidden - The API key doesn’t have permissions to perform the request.
- Name
404- Description
- Not Found - The API didn’t find any result for this query.
- Name
429- Description
Too Many Requests - The request was unacceptable due to too many requests (see Rate limit below).
- Name
500- Description
- Server Error - The request failed due to a server error.
Error response
{
"statusCode": 402,
"message": "Insufficient credits"
}