# 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:** 69 total users, 9 monthly users, 93.1% 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/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
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.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## 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.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# 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/<STORE_ID>/records/<KEY>"
}
```

### 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 '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_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 '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# 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(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).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": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,room_js/url-screenshot-generator"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/4ApNpBE3IfhkdTh3f/builds/Nj3pGDeS4CVG2ddoa/openapi.json