ScreenshotBasescreenshotbase

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 screenshotbase.com support ([email protected]).

Status codes

Here is a list of the different categories of status codes returned by the screenshotbase.com API. Use these to understand if a request was successful.

  • Name
    200
    Type
    Description

    A 200 status code indicates a successful response.

  • Name
    400
    Type
    Description

    A 400 status code indicates that the hostname of the target website could not be resolved (DNS failure). Check that the URL you passed actually exists.

  • Name
    401
    Type
    Description

    A 401 status code indicates that your API key is missing or invalid. A missing key returns the message No API key found in request (error code missing_api_key); an invalid key returns Invalid authentication credentials (error code invalid_api_key).

  • Name
    403
    Type
    Description

    A 403 status code indicates that your request was refused: either the API key belongs to a different everapi product (error code key_not_allowed_for_product), or the request came from a referrer that is not on your API key's whitelist (error code referrer_not_allowed).

  • Name
    404
    Type
    Description

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

  • Name
    408
    Type
    Description

    A 408 status code indicates that the target website took too long to load within the configured timeout. Try increasing the timeout parameter or a less strict wait_until value.

  • Name
    422
    Type
    Description

    A validation error has occured. Parameter validation failures return a JSON response with an errors object describing which parameter failed and why. URL-safety rejections return a plain message instead, such as Only http and https URLs are allowed. or URLs targeting private or reserved IP ranges are not allowed.

  • 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]

  • Name
    502
    Type
    Description

    A 502 status code indicates that the target website could not be loaded. The message includes the underlying network error, e.g. The target website could not be loaded (ERR_CONNECTION_REFUSED).