Helping Material about

Screenshot

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

A cached screenshot is kept for the ttl you set, in seconds. The default is 2,592,000 seconds, which is 30 days. A longer value is cut to 30 days.

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.net 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. CSV bulk is on every plan. Free allows 50 URLs, Essential 200, Startup 1,000, Growth 5,000, and Business has no CSV cap. POST /bulk/json is on every plan, including Free, and accepts 50 URLs.

Yes. Set timezone to an IANA name, such as America/New_York or Europe/London. The field is in the timezone docs.

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

Sending destroy_screenshot does not stop the screenshot from being stored. The capture is saved either way.

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 info@screenshotapi.net or by using the chat tool in the bottom right of the screen.

Free uses the help center. Essential is answered within 2 business days. Startup and Growth are answered within 1 business day. Business has priority support with an 8-hour response.

The ScreenshotAPI.net 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.

Support is not 24/7. Free uses the help center. Essential is answered within 2 business days, Startup and Growth within 1 business day, and Business within 8 hours. For a higher volume than Business, contact us.

Free and Essential do not allow overage, so captures stop at the monthly allowance. Startup, Growth, and Business charge overage until a monthly cap: $5 per 650 credits up to 15,000 total on Startup, $5 per 1,450 up to 60,000 on Growth, and $5 per 1,600 up to 187,500 on Business. Above that, move up a plan or contact us.

A successful response uses the credit, including when the screenshot comes from cache. Send fresh=true for a new capture. A failed capture does not.

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. The limit depends on the plan: 10 requests a minute on Free, 30 on Essential, 60 on Startup, 100 on Growth, and 150 on Business.

The Free plan includes 100 credits each month and does not allow overage. When they are used, captures stop until the next month, or until you choose a paid plan in the Billing tab.

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

Yes. A cached response uses the credit for that request. A failed capture does not.

A cached screenshot is kept for the ttl you set, in seconds. The default is 2,592,000 seconds, which is 30 days. A longer value is cut to 30 days.

The current credit plans do not send an email at 80%, 90%, or 100% of the monthly allowance.

The status is 403. On /v2 and /v3 the error field is screenshots_limit_reached, and the message is You're out of credits for the month. or You're out of free screenshots. Please upgrade. On / and /screenshot the error field is that sentence itself.

Errors & Status

Move to a plan with a higher monthly allowance, or use a plan that includes overage. Free and Essential stop at the included credits. Startup, Growth, and Business can continue until their overage cap.

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

A URL may start with https:// or http://. A URL with no scheme is treated as http://.

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

A text captcha drawn in a picture can be solved before the screenshot. Set solve_captcha to true and name the picture and the text box with CSS selectors. A checkbox, or a challenge that asks you to pick pictures, is not solved this way. The solver is on Growth and Business, and it adds 3 credits when solve_captcha is on and the capture succeeds. You can still pass cookies from a challenge you solved yourself. The fields are in the captcha docs.

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.