# Screenshot Taker (`jancurn/screenshot-taker`) Actor
Takes a screenshot of one or more web pages using the Chrome browser. The actor enables the setting of custom viewport size, page load timeout, delay, proxies, and output image format.
- **URL**: https://apify.com/jancurn/screenshot-taker.md
- **Developed by:** [Jan ÄŒurn](https://apify.com/jancurn) (community)
- **Categories:** Developer tools, Open source
- **Stats:** 824 total users, 4 monthly users, 100.0% runs succeeded, 21 bookmarks
- **User rating**: No ratings yet
## Pricing
Pay per usage
This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.
Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage
## What's an Apify Actor?
Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".
## How to integrate an Actor?
If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.
In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):
```bash
npm install apify-client
```
In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):
```bash
pip install apify-client
```
In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):
````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash
In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).
If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).
For usage examples, see the [API](#api) section below.
For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).
# README
## Screenshot taker
This Apify actor takes a screenshot of one or more
web pages using Chrome browser.
The actor enables the setting of custom viewport size,
page load timeout, delay, proxies, and output image format.
### Results
The screenshots are stored in the the default key-value store
associated with the actor run. For each web page on input,
the dataset contains a record such as:
````
{
"request": {
"url": "https://www.example.com",
"method": "GET",
"payload": null,
"userData": {}
},
"response": {
"status": 200,
"headers": {
"status": "200",
"content-encoding": "gzip",
"cache-control": "max-age=604800",
"content-type": "text/html; charset=UTF-8",
"content-length": "606"
}
},
"finishedAt": "2019-07-14T16:16:56.230Z",
"screenshotUrl": "https://api.apify.com/v2/key-value-stores/x2xiRLsycdTpFQFSo/records/screenshot-2c730012.jpeg"
}
```
If an error occurs during loading or processing of a web page,
the page is retried (up to `pageMaxRetryCount` times - see input schema).
If the error persists,
the resulting dataset will contain a record such as the following:
```
{
"request": {
"url": "https://non-existing-page.net",
"method": "GET",
"payload": null,
"userData": {}
},
"response": null,
"finishedAt": "2019-07-14T16:24:41.257Z",
"errorMessages": \[
"Error: net::ERR\_NAME\_NOT\_RESOLVED at https://non-existing-page.net\n at navigate ...",
"Error: net::ERR\_NAME\_NOT\_RESOLVED at https://non-existing-page.net\n at navigate ...",
"Error: net::ERR\_NAME\_NOT\_RESOLVED at https://non-existing-page.net\n at navigate ..."
]
}
````
# Actor input Schema
## `urls` (type: `array`):
List of URLs of web pages to take the screenshot of.
## `pageLoadTimeoutSecs` (type: `integer`):
Timeout for the web page load, in seconds. If the web page does not load in this time frame, it is considered to have failed and will be retried, similarly as with other page load errors.
## `pageMaxRetryCount` (type: `integer`):
How many times to retry to load the page on error or timeout.
## `waitUntil` (type: `string`):
Indicates when to consider the navigation to the page as succeeded. For more details, see waitUntil parameter of Page.goto() function in Puppeteer documention.
## `viewportWidth` (type: `integer`):
Width of the browser window.
## `viewportHeight` (type: `integer`):
Height of the browser window.
## `delaySecs` (type: `integer`):
How long time to wait after loading the page before taking the screenshot.
## `imageType` (type: `string`):
Format of the image.
## `proxyConfiguration` (type: `object`):
Specifies the type of proxy servers that will be used by the crawler in order to hide its origin.
## Actor input object example
```json
{
"urls": [
{
"url": "https://www.example.com"
},
{
"url": "https://sdk.apify.com"
}
],
"pageLoadTimeoutSecs": 60,
"pageMaxRetryCount": 2,
"waitUntil": "load",
"viewportWidth": 1200,
"viewportHeight": 900,
"delaySecs": 0,
"imageType": "jpeg"
}
````
# API
You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.
## JavaScript example
```javascript
import { ApifyClient } from 'apify-client';
// Initialize the ApifyClient with your Apify API token
// Replace the '' with your token
const client = new ApifyClient({
token: '',
});
// Prepare Actor input
const input = {
"urls": [
{
"url": "https://www.example.com"
},
{
"url": "https://sdk.apify.com"
}
]
};
// Run the Actor and wait for it to finish
const run = await client.actor("jancurn/screenshot-taker").call(input);
// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
console.dir(item);
});
// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs
```
## Python example
```python
from apify_client import ApifyClient
# Initialize the ApifyClient with your Apify API token
# Replace '' with your token.
client = ApifyClient("")
# Prepare the Actor input
run_input = { "urls": [
{ "url": "https://www.example.com" },
{ "url": "https://sdk.apify.com" },
] }
# Run the Actor and wait for it to finish
run = client.actor("jancurn/screenshot-taker").call(run_input=run_input)
# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
print(item)
# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start
```
## CLI example
```bash
echo '{
"urls": [
{
"url": "https://www.example.com"
},
{
"url": "https://sdk.apify.com"
}
]
}' |
apify call jancurn/screenshot-taker --silent --output-dataset
```
## MCP server setup
```json
{
"mcpServers": {
"apify": {
"command": "npx",
"args": [
"mcp-remote",
"https://mcp.apify.com/?tools=jancurn/screenshot-taker",
"--header",
"Authorization: Bearer "
]
}
}
}
```
## OpenAPI specification
```json
{
"openapi": "3.0.1",
"info": {
"title": "Screenshot Taker",
"description": "Takes a screenshot of one or more web pages using the Chrome browser. The actor enables the setting of custom viewport size, page load timeout, delay, proxies, and output image format.",
"version": "0.0",
"x-build-id": "BgjjMwMZtxEya2e1W"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/jancurn~screenshot-taker/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-jancurn-screenshot-taker",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/acts/jancurn~screenshot-taker/runs": {
"post": {
"operationId": "runs-sync-jancurn-screenshot-taker",
"x-openai-isConsequential": false,
"summary": "Executes an Actor and returns information about the initiated run in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/runsResponseSchema"
}
}
}
}
}
}
},
"/acts/jancurn~screenshot-taker/run-sync": {
"post": {
"operationId": "run-sync-jancurn-screenshot-taker",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"components": {
"schemas": {
"inputSchema": {
"type": "object",
"required": [
"urls"
],
"properties": {
"urls": {
"title": "Page URLs",
"type": "array",
"description": "List of URLs of web pages to take the screenshot of.",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"pageLoadTimeoutSecs": {
"title": "Page load timeout",
"minimum": 1,
"maximum": 180,
"type": "integer",
"description": "Timeout for the web page load, in seconds. If the web page does not load in this time frame, it is considered to have failed and will be retried, similarly as with other page load errors.",
"default": 60
},
"pageMaxRetryCount": {
"title": "Page retry count",
"minimum": 0,
"maximum": 10,
"type": "integer",
"description": "How many times to retry to load the page on error or timeout.",
"default": 2
},
"waitUntil": {
"title": "Wait until",
"enum": [
"load",
"domcontentloaded",
"networkidle0",
"networkidle2"
],
"type": "string",
"description": "Indicates when to consider the navigation to the page as succeeded. For more details, see waitUntil parameter of Page.goto() function in Puppeteer documention.",
"default": "load"
},
"viewportWidth": {
"title": "Viewport width",
"minimum": 1,
"maximum": 10000,
"type": "integer",
"description": "Width of the browser window.",
"default": 1200
},
"viewportHeight": {
"title": "Viewport height",
"minimum": 1,
"maximum": 10000,
"type": "integer",
"description": "Height of the browser window.",
"default": 900
},
"delaySecs": {
"title": "Delay before screenshot",
"minimum": 0,
"maximum": 120,
"type": "integer",
"description": "How long time to wait after loading the page before taking the screenshot.",
"default": 0
},
"imageType": {
"title": "Image type",
"enum": [
"jpeg",
"png"
],
"type": "string",
"description": "Format of the image.",
"default": "jpeg"
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Specifies the type of proxy servers that will be used by the crawler in order to hide its origin."
}
}
},
"runsResponseSchema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"actId": {
"type": "string"
},
"userId": {
"type": "string"
},
"startedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"finishedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"status": {
"type": "string",
"example": "READY"
},
"meta": {
"type": "object",
"properties": {
"origin": {
"type": "string",
"example": "API"
},
"userAgent": {
"type": "string"
}
}
},
"stats": {
"type": "object",
"properties": {
"inputBodyLen": {
"type": "integer",
"example": 2000
},
"rebootCount": {
"type": "integer",
"example": 0
},
"restartCount": {
"type": "integer",
"example": 0
},
"resurrectCount": {
"type": "integer",
"example": 0
},
"computeUnits": {
"type": "integer",
"example": 0
}
}
},
"options": {
"type": "object",
"properties": {
"build": {
"type": "string",
"example": "latest"
},
"timeoutSecs": {
"type": "integer",
"example": 300
},
"memoryMbytes": {
"type": "integer",
"example": 1024
},
"diskMbytes": {
"type": "integer",
"example": 2048
}
}
},
"buildId": {
"type": "string"
},
"defaultKeyValueStoreId": {
"type": "string"
},
"defaultDatasetId": {
"type": "string"
},
"defaultRequestQueueId": {
"type": "string"
},
"buildNumber": {
"type": "string",
"example": "1.0.0"
},
"containerUrl": {
"type": "string"
},
"usage": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "integer",
"example": 1
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
}
}
},
"usageTotalUsd": {
"type": "number",
"example": 0.00005
},
"usageUsd": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "number",
"example": 0.00005
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}
```