Website screenshot API: how to turn a URL into a PNG, JPEG or WEBP image (Python, cURL, no code)

Q: How do I use the Website screenshot API from Python?

Install the apify-client package, create a client with your Apify API token, call the Actor v0iddo/url-screenshot with an input like the one above, and read the rows from the run's dataset. The Python snippet above does exactly that.

Capture a public web page as a PNG, JPEG or WEBP image: any viewport size, full page, retina scaling, optional cookie-banner hiding. This guide shows the output fields, a working input, and Python, JavaScript and cURL code for the Actor v0iddo/url-screenshot on Apify.

Open Website screenshot API on Apify

What data you get

One row per result. Every row can be downloaded as JSON, CSV, Excel or HTML, or read through the API.

Field	Label	Type	Example
`index`	#	number	0
`file_url`	File	URL	https://api.apify.com/v2/key-value-stores/Gmq1hy2PAfT6TQ7Bt/records...
`filename`	File name	text	screenshot.png
`mime`	Type	text	image/png
`bytes`	Bytes	number	71152
`credits`	Credits	number	3
`ms`	Time (ms)	number	1283
`file_key`		text	result-001-screenshot.png
`width`		number	1280
`height`		number	800
`format`		text	png
`final_url`		text	https://example.com/
`http_status`		number	200
`title`		text	Example Domain
`load_state`		text	networkidle
`truncated`		true/false	false
`blocked_requests`		number	0

Input example

This is the input that is pre-filled on the Actor page. Change the values for your own run.

{
  "url": "https://example.com"
}

Input field	Type	What it does
`url` (required)	string	Public http(s) URL (robots.txt is honoured), or an inline data:text/html URL
`width`	integer	Viewport width in CSS px
`height`	integer	Viewport height in CSS px
`full_page`	boolean	Capture the whole scrollable page (capped at 16384 CSS px / 50 megapixels)
`format`	string	File format of the result.
`quality`	integer	jpeg / webp quality
`delay_ms`	integer	Extra wait after load, before the shot
`device_scale_factor`	string	Pixel density (2 = retina) (a number)
`block_cookie_banners`	boolean	Hide common cookie-consent dialogs (best effort)
`items`	array	Optional. A list of input objects with the same fields as above; every object is processed in its own right and the top-level fields act as shared defaults.

Output sample

Real rows from a run of the Actor. Fields that name people are left out of the sample.

[
  {
    "index": 0,
    "file_url": "https://api.apify.com/v2/key-value-stores/Gmq1hy2PAfT6TQ7Bt/records/result-001-screenshot.png?signature=1zfATwZwqmmlfl8OgA6Um",
    "file_key": "result-001-screenshot.png",
    "filename": "screenshot.png",
    "mime": "image/png",
    "bytes": 71152,
    "width": 1280,
    "height": 800,
    "format": "png",
    "final_url": "https://example.com/",
    "http_status": 200,
    "title": "Example Domain",
    "load_state": "networkidle",
    "truncated": false,
    "blocked_requests": 0,
    "credits": 3,
    "ms": 1283
  }
]

Code: Python, JavaScript and cURL

Get your API token in Apify Console under Settings, then Integrations. The Actor id is v0iddo/url-screenshot.

Python (apify-client)

from apify_client import ApifyClient

client = ApifyClient("YOUR_APIFY_TOKEN")

run_input = {'url': 'https://example.com'}

run = client.actor("v0iddo/url-screenshot").call(run_input=run_input)
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

JavaScript (apify-client)

import { ApifyClient } from 'apify-client';

const client = new ApifyClient({ token: 'YOUR_APIFY_TOKEN' });

const input = {
  "url": "https://example.com"
};

const run = await client.actor('v0iddo/url-screenshot').call(input);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
console.log(items);

cURL

curl -X POST "https://api.apify.com/v2/acts/v0iddo~url-screenshot/run-sync-get-dataset-items" \
  -H "Authorization: Bearer YOUR_APIFY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}'

Price

$4.25 per 1,000 results. You pay per result row. There is no separate charge per run. Higher Apify plans pay less per result, down to $2.98 per 1,000. See the pricing tab for your plan. A new Apify account gets $5 of platform credit every month.

FAQ

What data does the Website screenshot API return?

Each result is one row in an Apify dataset. Fields include index, file_url, filename, mime, bytes, credits, ms, file_key, and more. The table above shows every field with an example value.

How do I use the Website screenshot API from Python?

Install the apify-client package, create a client with your Apify API token, call the Actor v0iddo/url-screenshot with an input like the one above, and read the rows from the run's dataset. The Python snippet above does exactly that.

Can I use it without writing code?

Yes. Open the Actor page on Apify, fill in the input form (an example is already filled in), press Start, and download the results as JSON, CSV, Excel or HTML. You can also schedule runs there.

How much does it cost?

$4.25 per 1,000 results. You pay per result row. There is no separate charge per run. Higher Apify plans pay less per result, down to $2.98 per 1,000. A new Apify account gets $5 of platform credit every month.

How do I limit the number of results?

Set a maximum cost for a run in the run options on Apify, and the run stops when it is reached.

Can I send the results to Google Sheets, Make, Zapier or n8n?

Yes. Apify datasets connect to Google Sheets, Slack, Make, Zapier and n8n, and a webhook can call your own service when a run finishes. You can also export the dataset as JSON, CSV or Excel.

Open Website screenshot API on Apify

Related guides

Google Maps Scraper: Scrape Google Maps business listings by search and place: name, category, address, coordinates, rating, rev...
Bulk file and image downloader: Download files in bulk from direct links, or every image, video, audio file, PDF, document or archive on a...
Video frame extractor: Extract still frames from video files as JPEG, PNG or WebP images with timecodes: one every N seconds, a nu...