# Web Screenshot Api (`simplifysme/web-screenshot-api`) Actor

📸 Capture high-quality screenshots of any web page and get them as downloadable images. Perfect for website monitoring, visual regression testing, and UI snapshots.

- **URL**: https://apify.com/simplifysme/web-screenshot-api.md
- **Developed by:** [SimplifySME Toolbox](https://apify.com/simplifysme) (community)
- **Categories:** Automation, Developer tools, Other
- **Stats:** 9 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $48.00 / 1,000 results

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?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
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.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — 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

## Web Screenshot API

📸 **Capture high-quality screenshots of any web page** and get them as downloadable images. Perfect for website monitoring, visual regression testing, and UI snapshots.

***

### 📺 What It Captures

- **Full Page Screenshots**: Complete scrollable page captures
- **Viewport Screenshots**: Visible area only
- **Custom Dimensions**: Configurable width and height
- **High Quality**: Full-resolution PNG images

***

### 🚀 Key Features

| Feature | Description |
|---------|-------------|
| 📸 **High Quality** | Full-resolution PNG screenshots |
| 🖼️ **Flexible Capture** | Full page or viewport-only options |
| 📐 **Custom Dimensions** | Configurable viewport width and height |
| 💾 **Apify Storage** | Screenshots stored in Key-Value Store |
| 🔗 **Public URLs** | Direct public URLs for easy access |
| ⏱️ **Smart Timeouts** | 60-second navigation timeout with load event waiting |
| 🤖 **Anti-Bot Measures** | Includes viewport and browser fingerprinting evasion |

***

### 📥 Input

#### Required

- **`url`** (string): The URL to screenshot
  - Example: `"https://example.com/"`
  - Automatically adds `https://` if protocol is missing

#### Optional

- **`fullPage`** (boolean, default: false): Capture full scrollable page
- **`width`** (integer, default: 1920): Viewport width in pixels
- **`height`** (integer, default: 1080): Viewport height in pixels

***

### 📤 Output

Returns screenshot metadata:

```json
{
  "screenshotKey": "screenshot-abc123",
  "screenshotUrl": "https://api.apify.com/v2/key-value-stores/.../screenshot.png",
  "url": "https://example.com/",
  "width": 1920,
  "height": 1080,
  "fullPage": false,
  "timestamp": "2024-01-01T12:00:00.000Z",
  "success": true,
  "message": "Screenshot captured successfully",
  "_metadata": {
    "runId": "abc123",
    "actorId": "user/web-screenshot-api",
    "completedAt": "2024-01-01T12:00:00.000Z",
    "totalTimeMs": 3500
  }
}
```

***

### 💡 Use Cases

- ✅ **Website Monitoring** - Track website changes visually
- ✅ **Ads Tracking** - Monitor ad placements and content
- ✅ **UI Snapshots** - Capture UI states for documentation
- ✅ **Visual Regression Testing** - Compare screenshots over time
- ✅ **Design Reviews** - Share visual snapshots with teams
- ✅ **Compliance Monitoring** - Verify website appearance

***

### ⚙️ Technical Details

- **Capture Method**: Browser-based screenshot using Playwright
- **Storage**: Screenshots stored in Apify Key-Value Store
- **Format**: PNG format for high quality
- **Timeout Strategy**: 60-second navigation timeout with load event waiting
- **URL Normalization**: Automatically adds `https://` if protocol is missing
- **Error Handling**: Validates screenshot capture and reports accurate success/failure

***

### 📝 Example Usage

#### Basic Screenshot

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

#### Full Page Screenshot

```json
{
  "url": "https://example.com/",
  "fullPage": true
}
```

#### Custom Dimensions

```json
{
  "url": "https://example.com/",
  "width": 1280,
  "height": 720,
  "fullPage": false
}
```

#### URL Without Protocol

```json
{
  "url": "example.com"
}
```

***

### ⚠️ Important Notes

- **URL Normalization**: Automatically adds `https://` if protocol is missing
- **Success Reporting**: Only reports success when screenshot is successfully captured and stored
- **Storage**: Screenshots are stored in Apify Key-Value Store and accessible via public URLs
- **Timeout**: 60-second timeout for page loading. Some slow-loading pages may timeout.

# Actor input Schema

## `url` (type: `string`):

The URL to screenshot

## `fullPage` (type: `boolean`):

Capture full scrollable page

## `width` (type: `integer`):

Viewport width in pixels

## `height` (type: `integer`):

Viewport height in pixels

## `useResidentialProxy` (type: `boolean`):

Enable to use Apify Residential proxies for potentially better success rates and to avoid IP blocks. Note: Residential proxies incur additional cost.

## Actor input object example

```json
{
  "url": "https://example.com/",
  "fullPage": false,
  "width": 1920,
  "height": 1080,
  "useResidentialProxy": 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 '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "url": "https://www.apify.com/"
};

// Run the Actor and wait for it to finish
const run = await client.actor("simplifysme/web-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 '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "url": "https://www.apify.com/" }

# Run the Actor and wait for it to finish
run = client.actor("simplifysme/web-screenshot-api").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 '{
  "url": "https://www.apify.com/"
}' |
apify call simplifysme/web-screenshot-api --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,simplifysme/web-screenshot-api"
        }
    }
}

```

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/amyuA3ubozAuW2kWE/builds/abm4ewizdJlAf0e8g/openapi.json