# URL Screenshot Generator (`room_js/url-screenshot-generator`) Actor Generate screenshots for provided list of URLs and crop them on the go! - **URL**: https://apify.com/room\_js/url-screenshot-generator.md - **Developed by:** [JavaScript Room](https://apify.com/room_js) (community) - **Categories:** Automation, Developer tools - **Stats:** 47 total users, 4 monthly users, 100.0% runs succeeded, 1 bookmarks - **User rating**: 5.00 out of 5 stars ## Pricing from $0.001 / result This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## 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 ## URL Screenshot Generator This actor visits a list of websites and captures screenshots, then returns input urls with attached links to taken screenshots. ### Features - Capture full-page screenshots (JPG or PNG). - Optional cropping via `topOffset` and `height`. - Configurable viewport `width`, page `waitUntil`, `delay`, and `timeout`. ### Inputs - **`urls`**: array (required) - Description: List of sources. Each item should be an object like `{ "url": "https://example.com" }`. You can provide URLs manually, upload a file, or use a Google Sheet. - **`format`**: string (required) - Allowed values: `jpg` (default), `png` - Description: Output image format. `jpg` uses a quality of 80. - **`waitUntil`**: string (required) - Allowed values: `load` (default), `domcontentloaded`, `networkidle0` - Description: Puppeteer `page.goto` `waitUntil` option; controls when the page is considered loaded. - **`delay`**: number (required) - Unit: milliseconds - Default: `500` - Description: Wait this long after navigation before taking the screenshot. Useful for client-side rendering or animations. - **`timeout`**: number (required) - Unit: milliseconds - Default: `30000` - Description: Navigation timeout for `page.goto`. - **`width`**: number (required) - Unit: pixels - Default: `1280` - Description: Viewport width used when launching the browser. - **`height`**: number (optional) - Unit: pixels - Description: When specified together with `topOffset`, defines a rectangular crop height to extract from the full-page screenshot. - **`topOffset`**: number (optional) - Unit: pixels - Description: How many pixels from the top to begin the crop. Combined with `height` to extract a portion of the page. - **`proxyConfig`**: object (optional, recommended) - Description: Proxy configuration for crawling. Use Apify Proxy (recommended) or custom proxies to avoid throttling and geo-based blocks. #### Required fields The schema marks the following fields as required: `urls`, `format`, `timeout`, `delay`, `width`, `waitUntil`. ### Example input Example JSON you can paste into the actor input panel: ```json { "urls": [ { "url": "https://example.com" }, { "url": "https://roomjs.com" } ], "format": "jpg", "waitUntil": "load", "delay": 500, "timeout": 30000, "width": 1280, "topOffset": 0, "height": 800, "proxyConfig": { "useApifyProxy": true } } ```` Adjust or remove `topOffset` / `height` if you want full-page screenshots instead of a cropped fragment. ### Output - Screenshots are saved into the default Key-Value Store (`Actor.setValue`). Each image record key is generated from the page URL and a timestamp. - For every stored screenshot the actor pushes a dataset record with the shape: ```json { "url": "https://example.com", "screenshotUrl": "https://api.apify.com/v2/key-value-stores//records/" } ``` ### Notes & Tips - Use the `proxyConfig` to avoid IP blocks for large crawls. The schema pre-fills `useApifyProxy: true`. - If you need a very tall viewport for full-length screenshots, the actor takes a full-page screenshot and then extracts a portion when `topOffset`/`height` are provided. - JPG is generally smaller than PNG. Use `png` if you need lossless screenshots. # Actor input Schema ## `urls` (type: `array`): Enter URLs manually, upload a file, or link a Google Sheet. ## `format` (type: `string`): Output file format ## `waitUntil` (type: `string`): Wait until the following event occurs ## `delay` (type: `number`): Delay in milliseconds before taking the screenshot ## `timeout` (type: `number`): Timeout in milliseconds for each website ## `width` (type: `number`): Width of the website's viewport ## `height` (type: `number`): Height of the fragment to take a screenshot of ## `topOffset` (type: `number`): Set how far from the top the screenshot should begin ## `proxyConfig` (type: `object`): Select proxies to be used by your crawler ## Actor input object example ```json { "urls": [ { "url": "https://roomjs.com" } ], "format": "jpg", "waitUntil": "load", "delay": 500, "timeout": 30000, "width": 1280, "proxyConfig": { "useApifyProxy": true } } ``` # Actor output Schema ## `overview` (type: `string`): No description # 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://roomjs.com" } ], "delay": 500, "timeout": 30000, "width": 1280, "proxyConfig": { "useApifyProxy": true } }; // Run the Actor and wait for it to finish const run = await client.actor("room_js/url-screenshot-generator").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://roomjs.com" }], "delay": 500, "timeout": 30000, "width": 1280, "proxyConfig": { "useApifyProxy": True }, } # Run the Actor and wait for it to finish run = client.actor("room_js/url-screenshot-generator").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://roomjs.com" } ], "delay": 500, "timeout": 30000, "width": 1280, "proxyConfig": { "useApifyProxy": true } }' | apify call room_js/url-screenshot-generator --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=room_js/url-screenshot-generator", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "URL Screenshot Generator", "description": "Generate screenshots for provided list of URLs and crop them on the go!", "version": "0.0", "x-build-id": "Nj3pGDeS4CVG2ddoa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/room_js~url-screenshot-generator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-room_js-url-screenshot-generator", "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/room_js~url-screenshot-generator/runs": { "post": { "operationId": "runs-sync-room_js-url-screenshot-generator", "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/room_js~url-screenshot-generator/run-sync": { "post": { "operationId": "run-sync-room_js-url-screenshot-generator", "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", "format", "timeout", "delay", "width", "waitUntil" ], "properties": { "urls": { "title": "List of URLs", "type": "array", "description": "Enter URLs manually, upload a file, or link a Google Sheet.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "format": { "title": "Format", "enum": [ "jpg", "png" ], "type": "string", "description": "Output file format", "default": "jpg" }, "waitUntil": { "title": "Wait Until", "enum": [ "load", "domcontentloaded", "networkidle0" ], "type": "string", "description": "Wait until the following event occurs", "default": "load" }, "delay": { "title": "Delay", "type": "number", "description": "Delay in milliseconds before taking the screenshot" }, "timeout": { "title": "Timeout", "minimum": 10000, "type": "number", "description": "Timeout in milliseconds for each website" }, "width": { "title": "Width", "type": "number", "description": "Width of the website's viewport" }, "height": { "title": "Height", "type": "number", "description": "Height of the fragment to take a screenshot of" }, "topOffset": { "title": "Top Offset", "type": "number", "description": "Set how far from the top the screenshot should begin" }, "proxyConfig": { "title": "Proxy configuration (RECOMMENDED)", "type": "object", "description": "Select proxies to be used by your crawler" } } }, "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 } } } } } } } } } } ```