Helping Material about

Screenshot

We can't restrict the API key to a certain domain right now.

For the free tier, we only keep the shot image (depending on the ttl) up to 30 days.
For the paid tier, we keep it for 6 months.

GET : https://shot.screenshotapi.net/v3/screenshot?token=TOKEN&url=URL&[OPTIONS]
The following options for the API call are:

TOKEN: The TOKEN or your API key should be replaced by your real ScreenshotAPI API, you can find your API key after you Sign Up or Log In to the service via the Dashboard page.

Note: If for any reason you need to get a new API key, simply click 'Roll API Key' in the 'Settings' card on the Dashboard. This will issue you a fresh API key and revoke access from the previous key.

URL: Website URL for the site you would like to render for the screenshot. We support a wide variety of websites types, such as single page apps, very long-content, and sites that require lazy loading or delays ensuring accurate and complete screenshots of these unique sites.

OPTIONS: Options indicates the different URL parameters keys and values that can be used to render your 'perfect' screenshot.

Yes, we do! ScreenshotAPI can help you grab bulk screenshots from a CSV column.

This feature is only available on our paid tier!

Currently the timezone is default by UTC+0. There is the option to setup the geolocation, but not to set the browser timezone.

There is a functionality for injecting css into the screenshot. 

@import url('https://fonts.googleapis.com/css2?family=Splash&display=swap');
body
{
font-family: 'Splash', cursive;
color:blue !important;
}
h1,h2,h3,h4,h5
{
font-family: 'Splash', cursive;
color:red !important;
}

All headings or at least some of them should be appear with the custom font 'splash' and a different color.

There's not a single way to take screenshot from a site that requires authentication. There are multiple ways to implement auth in a site so you need to find out which one the site you're looking to shot is using and then try to use our parameters to complete or shortcut the authentication flow.

Yes, you can capture a screenshot of a protected page. For detailed guidance on handling authentication and capturing content behind protected screens, please refer to the following article: How to Take a Screenshot of a Protected Page.

You can pass the parameters no_cookie_banners=true and block_ads=true in your API request. These options automatically remove most cookie consent banners and block ad scripts before the screenshot is captured, resulting in a cleaner output.

Setting the appropriate browser height size is the best way to capture a screenshot of the entire spreadsheet. If you don't know the exact height, you can use an approximation.

Also, make sure to check 'full page' option.

Screenshot of the spreadsheet

Inject Javascript field is a javascript code that the browser can execute before taking the screenshot for example:

Try taking a screenshot of xo.capital and paste this code in the "Inject JS code" input of the query builder: document.getElementsByClassName('display-heading')[0].innerHTML = 'This is a test to help the customer'

This is the outcome of the screenshot you're getting:

Screenshot of xo.capital

Destroy screenshot means that we wont store the screenshot.

For the Mobile view, you can use the browser width and height fields.

Screenshot of the browser width and height


You can follow these example dimensions:

Screenshot of the responsive screen example

Our query builder offers advanced features that include a dark mode option. By clicking the dark mode option, it will allow you to take screenshots in that specific mode.

Please note that this functionality will only be available if the website offers a dark mode interface option.

Screenshot of the dark mode example

Users currently are unable to delete the screenshots by themselves, but we can certainly help you do so.

You can just send us a request via ticket, provide us the URL and we'll execute it.

Billing & Subscriptions

A unique screenshot is defined by the exact URL and parameters that were used for the render.

If you need to cancel your account for any reason you can simply do it from in the app's billing portal or by contacting us via email at [email protected] or by using the chat tool in the bottom right of the screen.

We highly value our customers. Most support requests get answered within 24 hours but should never be longer than 3 working days.

The ScreenshotAPI team uses industry gold standard approaches to ensure your data is safe. Data is encrypted at rest and in-transit. Our tool leverages Google Cloud to ensure we offer the best-in-class solution for your screenshot needs, scalability, and the highest levels of security.

While we do not have 24/7 support, the team is highly responsive (generally 24 hours). If you have special support needs please contact us to discuss an enterprise level plan and the level of support you need, the ScreenshotAPI team is dedicated to making your rollout a success.

Please do not worry, our service will not suddenly block you if you go over your quota. All overages are charged according to your plan. The Screenshot API team will reach out and discuss your options if you require another plan or approach to your screenshot needs.

Unless you opt into only rendering 'fresh' screenshots we will cache them. Cached screenshots will not count toward your quota.

Unfortunately, our payment portal, Stripe, does not accept PayPal.

You can see other payment methods in this article.

Before adding a team member, make sure that they don't have an existing account with ScreenshotAPI.

You can add a team member by following the instructions below:

Screenshot of the add team member example

Rate & Limiting

Yes, ScreenshotAPI enforces a rate limit ranging from 20 to 80 requests per minute, depending on your subscription plan.

You'll receive a message after you exceed the 100 free screenshots in a month.

Your free requests will reset on the same day of the prior month you registered with ScreenshotAPI.

If you wish to upgrade your account after the free trial, you can go to Billing tab and choose the best plan for you.

No, only successfully rendered screenshots are counted towards the usage limits of your plan. Failed screenshot attempts do not impact your plan's quota.

Only unique and fresh screenshots, defined by a unique combination of options, are counted toward your plan's usage.

ScreenshotAPI stores cached screenshots for a duration of 30 days. After this period, the cached screenshot is cleared and may be rerendered if requested again.

Yes, you will receive email notifications when your usage reaches 80%, 90%, and 100% of your screenshot limit.

If you approach or exceed your monthly quota, you will receive an error with the code screenshot_limit_reached and a status code of 403. This indicates that the screenshot limit for your plan has been reached.

After the trial period expires, your data will be removed after 30 days.

Errors & Status

To prevent hitting the screenshot_limit_reached (403) error, you can upgrade your plan to increase your screenshot quota, allowing you to exceed the current limits.

The url_required (400) error may occur if the url parameter is missing or misnamed (case-sensitive).

Additionally, ensure that the URL you provide starts with https://, as this is a required format.

The invalid_clipped_area (400) error occurs when the specified clipping area, such as the width, height, or coordinates, exceeds the bounds of the page.

To avoid this error, ensure that the clipping area's dimensions fit within the page size and validate the coordinates to avoid negative or oversized values.

Tools like the browser's developer console can help verify the specified values and ensure they align with the page layout.

The Invalid_geolocation_parameter (400) error occurs when the provided geolocation parameters are outside the valid range.

To resolve this issue, ensure that the latitude value is between -90 and 90, and the longitude value is between -180 and 180.

Cookies & Captcha

You need to figure out how the browser knows that user already passed the challenge (sometimes a cookie) and then pass those cookies to ScreeenshotAPI.

You can avoid consent forms for cookies by enabling the no cookies banners option and setting it to true while capturing the screenshot. This ensures that cookie banners are bypassed during the screenshot process.

Yes, you can add custom cookies while capturing a screenshot. This allows you to simulate a specific user session or customize the browsing context according to your requirements.

Be sure to configure the cookies properly in your request parameters.

Yes, you can capture screenshots of pages that require cookie-based authentication by setting custom cookies in your request. This allows you to simulate an authenticated session and access pages that are otherwise restricted.

Yes, you can clear cookies before capturing a screenshot to simulate a fresh session. Ensure no cookies are included in the request to create a clean browsing context.