# Screenshot API (`brunofin/website-screenshot-api`) Actor

Take high-quality screenshots of any website. Specify URL, viewport size, and format. Returns the screenshot as a downloadable image. Perfect for link previews, monitoring, and archival.

- **URL**: https://apify.com/brunofin/website-screenshot-api.md
- **Developed by:** [Bruno Finger](https://apify.com/brunofin) (community)
- **Categories:** Developer tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$0.005 / actor start

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

## Screenshot API

Takes a headless Chromium screenshot of any webpage using Playwright. Stores the screenshot in Apify Key-Value Store and returns a public URL.

### Input

| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| `url` | string | yes | — | The URL to screenshot. |
| `width` | integer | no | `1280` | Viewport width in pixels (320–3840). |
| `height` | integer | no | `720` | Viewport height in pixels (240–2160). |
| `format` | string | no | `"png"` | Image format: `png`, `jpeg`, or `webp`. |
| `fullPage` | boolean | no | `false` | Capture full scrollable page instead of viewport only. |

### Output

Each dataset item contains:

- `url` — the input URL
- `screenshotUrl` — public URL to the screenshot file in Apify KV Store
- `format` — image format
- `width`, `height` — viewport dimensions
- `fullPage` — whether full-page mode was used

### Usage

```json
{
  "url": "https://apify.com",
  "width": 1920,
  "height": 1080,
  "format": "png",
  "fullPage": false
}
```

# Actor input Schema

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

The URL of the website to screenshot.

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

Browser viewport width in pixels.

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

Browser viewport height in pixels.

## `format` (type: `string`):

Output image format.

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

Capture the full scrollable page instead of just the visible viewport.

## Actor input object example

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

# Actor output Schema

## `results` (type: `string`):

No description

## `screenshots` (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 = {
    "url": "https://apify.com"
};

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

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

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

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=brunofin/website-screenshot-api",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/acts/o8dgmuuQEQ8Mc0Pb9/builds/JWPW8dyrB8OF5ZC1y/openapi.json