# Website Screenshot API — Capture Screenshots from Any URL (`weeknds/website-screenshot-api`) Actor Capture PNG or JPEG screenshots from any website with configurable viewports, full-page mode, dark mode, and custom delays. Built on Playwright for pixel-perfect rendering. Ideal for web monitoring, visual testing, archiving, and competitive research. - **URL**: https://apify.com/weeknds/website-screenshot-api.md - **Developed by:** [C R](https://apify.com/weeknds) (community) - **Categories:** Developer tools - **Stats:** 1 total users, 0 monthly users, 75.0% runs succeeded, 0 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 ## Website Screenshot API A serverless Apify Actor that captures clean, high-resolution PNG/JPEG screenshots of any website using Playwright. ### Features - **Configurable viewports** — Desktop (1920×1080), Tablet (768×1024), Mobile (375×812), or custom dimensions - **Full-page capture** — Capture the entire scrollable page, not just the visible viewport - **Delay support** — Wait for lazy-loaded content before capturing - **PNG & JPEG output** — Choose lossless PNG or smaller JPEG files - **Dark mode emulation** — Capture pages as they appear in dark mode (`prefers-color-scheme: dark`) - **Robust error handling** — Clear, structured error messages for timeouts, DNS failures, SSL errors, and invalid URLs - **Structured metadata** — Every capture records URL, viewport, format, timestamp, and the public screenshot URL ### Input | Field | Type | Default | Description | |-------|------|---------|-------------| | `url` | string | *(required)* | Website URL to capture (must start with `http://` or `https://`) | | `viewport` | string | `desktop` | `desktop`, `tablet`, `mobile`, or `custom` | | `width` | integer | 1920 | Custom viewport width (when `viewport=custom`) | | `height` | integer | 1080 | Custom viewport height (when `viewport=custom`) | | `fullPage` | boolean | false | Capture entire scrollable page | | `delay` | integer | 0 | Milliseconds to wait before capture | | `format` | string | `png` | `png` or `jpeg` | | `darkMode` | boolean | false | Emulate dark color scheme | ### Output Each run pushes a single item to the default dataset: ```json { "url": "https://example.com", "screenshotUrl": "https://api.apify.com/v2/key-value-stores/.../records/screenshot", "viewport": {"width": 1920, "height": 1080}, "format": "png", "fullPage": false, "darkMode": false, "timestamp": "2026-07-07T12:00:00.000000+00:00", "success": true, "error": null } ```` The screenshot binary is stored in the key-value store and accessible via the `screenshotUrl`. ### Example Usage #### Via Apify API ```bash curl -X POST "https://api.apify.com/v2/acts/~website-screenshot-api/runs?token=" \ -H "Content-Type: application/json" \ -d '{"url": "https://example.com", "viewport": "desktop", "fullPage": true, "delay": 2000}' ``` #### Mobile Screenshot ```json { "url": "https://example.com", "viewport": "mobile", "fullPage": true, "format": "jpeg" } ``` #### Dark Mode ```json { "url": "https://example.com", "viewport": "desktop", "darkMode": true } ``` # Actor input Schema ## `url` (type: `string`): The website URL to capture a screenshot of. ## `viewport` (type: `string`): Choose a preset viewport or select custom for manual dimensions. ## `width` (type: `integer`): Viewport width in pixels (only used when viewport is 'custom'). ## `height` (type: `integer`): Viewport height in pixels (only used when viewport is 'custom'). ## `fullPage` (type: `boolean`): Capture the entire scrollable page instead of just the visible viewport. ## `delay` (type: `integer`): Milliseconds to wait before taking the screenshot (useful for lazy-loaded content). ## `format` (type: `string`): Output image format. ## `darkMode` (type: `boolean`): Emulate prefers-color-scheme: dark when capturing the page. ## Actor input object example ```json { "url": "https://example.com", "viewport": "desktop", "width": 1920, "height": 1080, "fullPage": false, "delay": 0, "format": "png", "darkMode": false } ``` # 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 = { "url": "https://example.com" }; // Run the Actor and wait for it to finish const run = await client.actor("weeknds/website-screenshot-api").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 = { "url": "https://example.com" } # Run the Actor and wait for it to finish run = client.actor("weeknds/website-screenshot-api").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 '{ "url": "https://example.com" }' | apify call weeknds/website-screenshot-api --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=weeknds/website-screenshot-api", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Website Screenshot API — Capture Screenshots from Any URL", "description": "Capture PNG or JPEG screenshots from any website with configurable viewports, full-page mode, dark mode, and custom delays. Built on Playwright for pixel-perfect rendering. Ideal for web monitoring, visual testing, archiving, and competitive research.", "version": "1.0", "x-build-id": "8IqGfHWxjqUVCVgfA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/weeknds~website-screenshot-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-weeknds-website-screenshot-api", "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/weeknds~website-screenshot-api/runs": { "post": { "operationId": "runs-sync-weeknds-website-screenshot-api", "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/weeknds~website-screenshot-api/run-sync": { "post": { "operationId": "run-sync-weeknds-website-screenshot-api", "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": [ "url" ], "properties": { "url": { "title": "URL", "pattern": "^https?://.+", "minLength": 8, "type": "string", "description": "The website URL to capture a screenshot of." }, "viewport": { "title": "Viewport", "enum": [ "desktop", "tablet", "mobile", "custom" ], "type": "string", "description": "Choose a preset viewport or select custom for manual dimensions.", "default": "desktop" }, "width": { "title": "Custom Width", "minimum": 320, "maximum": 5120, "type": "integer", "description": "Viewport width in pixels (only used when viewport is 'custom').", "default": 1920 }, "height": { "title": "Custom Height", "minimum": 240, "maximum": 5120, "type": "integer", "description": "Viewport height in pixels (only used when viewport is 'custom').", "default": 1080 }, "fullPage": { "title": "Full Page Capture", "type": "boolean", "description": "Capture the entire scrollable page instead of just the visible viewport.", "default": false }, "delay": { "title": "Delay Before Capture", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Milliseconds to wait before taking the screenshot (useful for lazy-loaded content).", "default": 0 }, "format": { "title": "Image Format", "enum": [ "png", "jpeg" ], "type": "string", "description": "Output image format.", "default": "png" }, "darkMode": { "title": "Dark Mode", "type": "boolean", "description": "Emulate prefers-color-scheme: dark when capturing the page.", "default": false } } }, "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 } } } } } } } } } } ```