Full Page Website Screenshot API

API ID 10190

Viewport or full page - Fast, reliable, and developer-smart - CSS ignore & custom delay options.

100% uptime 3,262 ms avg response

API Documentation

Endpoints

Request

Allows user's to input a URL and receive a screenshot of the website.

Endpoint ID: 19561
GET https://docs.zylalabs.com/api/10190/full+page+website+screenshot+api/19561/capture+screenshot
INPUT PARAMETERS

Capture Screenshot — Endpoint Features

Object Description
url Required The URL of the page you want a screenshot of.
viewport_width Optional The viewport width of the screenshot, eg: 1920
viewport_height Optional The viewport height of the screenshot, eg: 1080
delay_ms Optional The delay you want to place for the website to load before taking a screenshot.
full_page Optional Input: true or false, To decide if you want a full page screenshot or just the viewable area.
css_classes_to_hide Optional CSS classes of elements you want to hide on the page in the screenshot. eg: footer classes, ads, etc.

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

url
viewport_width
viewport_height
delay_ms
full_page
css_classes_to_hide
API EXAMPLE RESPONSE
JSON
{"status_code":200,"screenshot_url":"https://data.forkthis.io/assets/435c88fb-ea11-43d9-87e9-d6de6976a489.png"}
Capture Screenshot — CODE SNIPPETS

curl --location --request GET 'https://zylalabs.com/api/10190/full+page+website+screenshot+api/19561/capture+screenshot?url=https://www.google.com/' --header 'Authorization: Bearer YOUR_API_KEY' 


    

API Access Key & Authentication

After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Full Page Website Screenshot API simply include your bearer token in the Authorization header.

Headers
Header Description
Authorization Required Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.

No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.

(Save 2 months with annual billing 🎉)

🚀 Enterprise Plan

Starts at
$ 10,000/Year


  • Custom Volume
  • Custom Rate Limit
  • Specialized Customer Support
  • Real-Time API Monitoring
zeiss-logo amazon-logo zoom-logo decathlon-logo

Trusted by leading companies

Overview

Full Page Website Screenshot API is a reliable, flexible tool that generates high-quality screenshots of any webpage—full-page or custom viewport—with precise control over timing and content.

We are a mid sized marketing agency, with an in-house code team. We developed many of our own in house tools. Now we're sharing them with you - Enjoy.

Built for developers, it’s easy to integrate and comes with clear documentation and low-friction setup.
Capture pixel-perfect images for monitoring, previews, reporting, or automation—with advanced features that give you full control over how and when the shot is taken.

Key capabilities include:

  • Fast execution --- For real-time or high-frequency use
  • Simple configuration --- With clean, endpoint documentation
  • Full-page or viewport options --- To suit your use case
  • High-quality image output --- PNG format
  • Ignore specific CSS classes --- To hide modals, popups, or dynamic elements
  • Post-DOMContentLoaded delay --- To capture only after the page is visually ready
  • HTTP status code returned --- Alongside the image for robust site monitoring

 
Whether you’re building previews, running automated tests, or capturing visual archives—Full Page Website Screenshot API helps you capture exactly what you want, when you need it.

Full Page Website Screenshot API FAQs

The Screenshot API allows developers to capture full-page or viewport-based screenshots of any publicly accessible URL.

To ensure reliability and speed, especially for pages with heavy scripts or slow load times, our API follows an asynchronous two-step flow. When you make a request, the screenshot job is queued instantly, and we return either the screenshot or (for slower pages) a result URL you can poll to retrieve the result.

You can capture any public webpage over HTTP or HTTPS. Private, gated, or authentication-required URLs are not currently supported.

Yes. You can specify full_page: true in the request parameters to capture an entire scrollable page, not just the viewport.

Use the GET endpoint in our docs and set the parameters as follows. 1. url: string 2. full_page: pass either “true” or “false” (default is false) 3. viewport_width: integer (default is 1920) 4. viewport_height: integer (default is 1080) 5. delay_ms : integer (default is 0) 6. css_classes_to_hide: a string of “space separated” css classes (no dots required. Eg: “container nav-bar chat-popup”

Once you make your we will either send you the screenshot URL or a result URL to check the status of your screenshot task. This result URL will returns either a completed screenshot URL or a status indicating it’s still processing. No authentication is required to access this “result URL”

Most screenshots are ready in 2–6 seconds, but webpages that are slow to load / media asset heavy may take longer.

Yes, use the delay_ms parameter to delay the capture by a specific number of milliseconds. This is useful for waiting on animations or content that takes a while to load.

Yes. Pass an array to css_classes_to_hide with selectors you want hidden (e.g., ads, popups) before capture.

Users can customize their requests by setting parameters such as "full_page," "viewport_width," "viewport_height," "delay_ms," and "css_classes_to_hide" to tailor the screenshot capture to their specific needs.

The Screenshot API returns a JSON object containing the HTTP status code and the URL of the generated screenshot image. For example, a successful response includes fields like "status_code" and "screenshot_url."

The key fields in the response data are "status_code," which indicates the success of the request, and "screenshot_url," which provides the direct link to the captured screenshot image.

The response data is structured in JSON format, with key-value pairs. The "status_code" indicates the request's outcome, while "screenshot_url" contains the link to the image, making it easy to parse and use programmatically.

The endpoint accepts parameters such as "url," "full_page," "viewport_width," "viewport_height," "delay_ms," and "css_classes_to_hide." These allow users to customize their screenshot requests based on specific needs.

Users can utilize the returned data by checking the "status_code" to confirm success and using the "screenshot_url" to display or store the image. This is useful for monitoring website changes or generating previews.

Typical use cases include generating visual previews for marketing materials, automating website testing, capturing visual archives for documentation, and monitoring website changes over time.

Data accuracy is maintained through robust error handling and status code reporting. The API ensures that only successfully captured screenshots are returned, allowing users to trust the output.

If an error status code is received, users should check the URL for correctness and ensure the page is publicly accessible. They can also refer to the API documentation for troubleshooting common issues.

General FAQs

To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.

You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.

The free trial lasts for 7 days and allows you to make up to 50 API requests.

No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.

Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.

Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.

Prices are listed in USD (United States Dollar), EUR (Euro), CAD (Canadian Dollar), AUD (Australian Dollar), and GBP (British Pound). We accept all major debit and credit cards. Our payment system uses the latest security technology and is powered by Stripe, one of the world's most reliable payment companies. If you have any trouble paying by card, just contact us at [email protected]

Additionally, if you already have an active subscription in any of these currencies (USD, EUR, CAD, AUD, GBP), that currency will remain for subsequent subscriptions. You can change the currency at any time as long as you don't have any active subscriptions.
The local currency shown on the pricing page is based on the country of your IP address and is provided for reference only. The actual prices are in USD (United States Dollar). When you make a payment, the charge will appear on your card statement in USD, even if you see the equivalent amount in your local currency on our website. This means you cannot pay directly with your local currency.
Occasionally, a bank may decline the charge due to its fraud protection settings. We suggest reaching out to your bank initially to check if they are blocking our charges. Also, you can access the Billing Portal and change the card associated to make the payment. If these does not work and you need further assistance, please contact our team at [email protected]
Prices are determined by a recurring monthly or yearly subscription, depending on the chosen plan.
API calls are deducted from your plan based on successful requests. Each plan comes with a specific number of calls that you can make per month. Only successful calls, indicated by a Status 200 response, will be counted against your total. This ensures that failed or incomplete requests do not impact your monthly quota.
Zyla API Hub works on a recurring monthly subscription system. Your billing cycle will start the day you purchase one of the paid plans, and it will renew the same day of the next month. So be aware to cancel your subscription beforehand if you want to avoid future charges.
To upgrade your current subscription plan, simply go to the pricing page of the API and select the plan you want to upgrade to. The upgrade will be instant, allowing you to immediately enjoy the features of the new plan. Please note that any remaining calls from your previous plan will not be carried over to the new plan, so be aware of this when upgrading. You will be charged the full amount of the new plan.
To check how many API calls you have left for the current month, refer to the 'X-Zyla-API-Calls-Monthly-Remaining' field in the response header. For example, if your plan allows 1,000 requests per month and you've used 100, this field in the response header will indicate 900 remaining calls.

You can monitor your API usage through the response headers included with every request:

x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.

The 'X-Zyla-RateLimit-Reset' header shows the number of seconds until your rate limit resets. This tells you when your request count will start fresh. For example, if it displays 3,600, it means 3,600 seconds are left until the limit resets.

Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.

Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.

After 7 days, you will be charged the full amount for the plan you were subscribed to during the trial. Therefore, it's important to cancel before the trial period ends. Refund requests for forgetting to cancel on time are not accepted.
When you subscribe to an API free trial, you can make up to 50 API calls. If you wish to make additional API calls beyond this limit, the API will prompt you to perform an "Start Your Paid Plan." You can find the "Start Your Paid Plan" button in your profile under Subscription -> Choose the API you are subscribed to -> Pricing tab.
You can contact us through our chat channel to receive immediate assistance. We are always online from 8 am to 5 pm (EST). If you reach us after that time, we will get back to you as soon as possible. Additionally, you can contact us via email at [email protected]

Please have a look at our Refund Policy: https://zylalabs.com/terms#refund


Related APIs