Screenshot API

Screenshot API

Takes a screenshot of a website as it is displayed on a Chrome browser, just by passing its url only.
Free Plan $0.00 Monthly Subscribe
300 Requests / Monthly
Free for Lifetime
No Credit Card Required
MOST POPULAR
Starter Plan $19.99 Monthly Subscribe
7,500 Requests / Monthly
Standard Support
Fast and simple
High resolution PNG file output
Pro Plan $59.99 Monthly Subscribe
30,000 Requests / Monthly
Standard Support
Fast and simple
High resolution PNG file output
Custom Plan Volume Monthly Contact Us
Any requests volume you need
Fast and simple
High resolution PNG file output
Screenshot API Code Sample

Takes a screenshot of a website as it is displayed on a Chrome browser, just by passing its url only. The output of this API is a png file with dimensions 1420x1080.

It can also take full page screenshots. Just pass full=true to the URL and it will scroll automatically and take a full height screenshot of your URL. (max height: 10.000 pixels)

You can also customize the wait time (in seconds) for taking a screenshot with the timeout parameter. Just pass timeout=5 or any value you desire for your needs. (max timeout value is 15 seconds)

We use up to date Up to date Chrome browsers to make pixel perfect screenshots and ensure support for all modern web features.

We both support HTTP and HTTPS endpoints.

Specifying width and height

You can also customize the width and height value of the Chrome browser window. If you wish to have a screenshot of how the remote site is displayed on a mobile screen you can specify width=640 or less. Max allowed width value is 3200 and it defaults to 1440 pixels.

You can also specify the height parameter. It is also a good alternative for full page screenshots.

Screenshot API Reference

This API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Just Getting Started?

Check out our development quickstart guide.

Authentication

Screenshot API uses API keys to authenticate requests. You can view and manage your API keys in the Accounts page.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

All requests made to the API must hold a custom HTTP header named "apikey". Implementation differs with each programming language. Below are some samples.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Endpoints

Takes a screenshot of a url and dumps it back as a PNG image

Parameters

url (required)

URL to fetch

Location: Query, Data Type: string

full (optional)

Take a full page screenshot or not. Possible values: true/false.

Location: Query, Data Type: string

height (optional)

Optional: Browser height in pixels (Max: 8000). Defaults to 1080

Location: Query, Data Type: string

timeout (optional)

Timeout for screenshot (default to 5 seconds)

Location: Query, Data Type: string

width (optional)

Optional: Browser width in pixels (Max: 3200). Defaults to 1440

Location: Query, Data Type: string

** A word enclosed with curly brackets "{ }" in the code means that it is a parameter and it should be replaced with your own values when executing. (also overwriting the curly brackets).
Returns

Below is a sample response from the endpoint


If you wish to play around interactively with real values and run code, see...

Rate Limiting

Each subscription has its own rate limit. When you become a member, you start by choosing a rate limit that suits your usage needs. Do not worry; You can upgrade or downgrade your plan at any time. For this reason, instead of starting with a larger plan that you do not need, we can offer you to upgrade your plan after you start with "free" or "gold plan" options and start using the API.

When you reach a rate limit (both daily and monthly), the service will stop responding and returning the HTTP 429 response status code (Too many requests) for each request with the following JSON string body text.

{
"message":"You have exceeded your daily\/monthly API rate limit. Please review and upgrade your subscription plan at https:\/\/apilayer.com\/subscriptions to continue."
}

A reminder email will be sent to you when your API usage reaches both 80% and 90%, so that you can take immediate actions such as upgrading your plan in order to prevent your application using the API from being interrupted.

You can also programmatically check your rate limit yourself. As a result of each request made to the APILayer, the following 4 fields provide you with all the necessary information within the HTTP Headers.

x-ratelimit-limit-month: Request limit per month
x-ratelimit-remaining-month: Request limit remaining this month
x-ratelimit-limit-day: Request limit per day
x-ratelimit-remaining-day: Request limit remaining today

You can contact our support unit if you need any assistance with your application regarding to handle the returned result by looking at the header information.

Error Codes

APILayer uses standard HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate a clientside error, which means that failed given the information provided (e.g., a missing parameter, unauthorized access etc.). Codes in the 5xx range indicate an error with APILayer's servers (normally this should'nt happen at all).

If the response code is not 200, it means the operation failed somehow and you may need to take an action accordingly. You can check the response (which will be in JSON format) for a field called 'message' that briefly explains the error reported.

Status Code Explanation
400 - Bad Request The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized No valid API key provided.
404 - Not Found The requested resource doesn't exist.
429 - Too many requests API request limit exceeded. See section Rate Limiting for more info.
5xx - Server Error We have failed to process your request. (You can contact us anytime)

You can always contact for support and ask for more assistance. We'll be glad to assist you with building your product.