Status Codes

Here is a list of the different HTTP status codes returned by our API services. Use these to understand if a request was successful.

  • Name
    200
    Description

    A 200 status code indicates a success and no API errors.

  • Name
    400
    Description

    A 400 status code indicates a validation error — this means it's a you problem. No quota is consumed if a 400 is returned.

  • Name
    401
    Description

    A 401 status code indicates a authorization error. It could mean your API key is invalid. All our APIs allow you to test authentication by hitting the root path - so test first before contacting support. You will also receive a 401 when you've reached your API quota for the day and the "error" message included in the response will set to "quota exceeded".

  • Name
    5xx
    Description

    A 5xx status code indicates a server error — you won't be seeing these, but if you do, no quota is consumed.


Error messages

Whenever a request is unsuccessful, the our API services will return an error response with an error message. You can use this message to understand what has gone wrong and how to fix it.

Error response

{
  "error": "invalid url parameter: proto://invalid",
}

Unauthorized response

{
  "error": "unauthorized"
}

Quota exceeded response

{
  "error": "quota exceeded"
}