Request Status Codes

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). A successful request will be returned with status code 200.

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
    200
    Type
    Description

    A 200 status code indicates a successful response.

  • Name
    403
    Type
    Description

    A 403 status code indicates that you are not allowed to use this endpoint, please upgrade your plan.

  • Name
    404
    Type
    Description

    A 404 status code indicates that a requested endpoint does not exist.

  • Name
    422
    Type
    Description

    A 422 status code indicates that a requested endpoint does not exist.

  • Name
    429
    Type
    Description

    A 429 status code indicates that you have hit your rate limit or your monthly limit. For more requests please upgrade your plan.

  • Name
    500
    Type
    Description

    A 500 status code indicates a internal server error - let us know: [email protected]

Validation errors

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
    Invalid IP
    Type
    Description

    The ip must be a valid IP address.

  • Name
    Missing IP
    Type
    Description

    The ip parameter is required.

  • Name
    Invalid language
    Type
    Description

    The selected language is invalid and should be an ISO Alpha 2 Language Code for localising the ip data.