# Complete Website 🖥️ Screenshot Tool 📸 (`elizaga-applied-ai-labs-llc/bfs-crawl-website-screenshot`) Actor

Enter, screen(shot), and scrape! 😄

Many tools help screenshot *a single page*.

This tool helps you screenshot EVERY page.

How does it work?

Give us a url and see!

(One URL per run, for now ;) )

Have a  feature Request?  Reach out on: https://www.linkedin.com/company/elizaga-applied-ai-labs

- **URL**: https://apify.com/elizaga-applied-ai-labs-llc/bfs-crawl-website-screenshot.md
- **Developed by:** [Automations Expert Elizaga](https://apify.com/elizaga-applied-ai-labs-llc) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.00005 / actor start

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.

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

## Complete Website Screenshot Tool — Automated Website Crawler

A simple Actor that crawls a website and captures screenshots of its pages. It starts from a single URL, collects internal links, and generates screenshots for each page up to a configurable limit. Screenshots are stored in Key-Value Store, while metadata about each page can be saved in a Dataset.

##### Apex Crawler – Screenshotter

### Use cases

- Capture screenshots of an entire website for documentation or QA.
- Generate visual snapshots of pages for monitoring or archiving.
- Crawl a site and collect screenshots for design reviews or compliance checks.

### 🚀 How to use

1. Open the Actor in Apify Console.
2. Enter the website you want to capture in **Start URL**.
3. Adjust optional settings such as page limit, screenshot format, or proxy.
4. Click **Run**.

The Actor will crawl the site and generate screenshots of the pages it discovers.

### ⚙️ Input

The Actor accepts the following configuration:

- **startUrl** (string, required)\
  The website to begin crawling from. Default: `https://example.com`.

- **maxPages** (integer, default: 500)\
  Maximum number of pages the Actor will process during the crawl.

- **viewportWidth** (integer, default: 1920)\
  Browser viewport width used when capturing screenshots.

- **viewportHeight** (integer, default: 1080)\
  Currently unused. Viewport-based screenshots are still in development.

- **fullPageScreenshot** (boolean, default: true)\
  Capture the entire scrollable page instead of only the visible viewport.

- **screenshotFormat** (string, default: jpeg)\
  Image format for screenshots:
  - jpeg – smaller files (recommended)
  - webp – modern format with better compression
  - png – highest quality but larger files

- **pageLoadDelay** (integer, default: 30)\
  Number of seconds to wait for the page to fully load before taking the screenshot.

- **proxyConfig** (object)\
  Optional proxy configuration to avoid IP blocks during large crawls. Apify Proxy can be enabled by default.

### 📦 Storage

Key-Value Store – stores the generated screenshot images.

Screenshots themselves are stored in Key-Value Store, while metadata such as page URLs and screenshot references are stored in the Dataset.

**Example screenshot filename generated by the Actor:**

```
https://example.com/blog/page1 

url: https://example.com/

viewport:  1920w x 1080h (full screenshots ignore height)

pagepath: blog/page1

screenshotFormat: jpeg (default)
```

```
{hostname/url}_{viewportWidth}w{viewportHeight}h_blog_page1-screenshot.jpeg
example_com_1920w1080h_iphone-screenshot.jpeg
```

The filename includes the hostname, viewport size, and page path so screenshots are organized and easy to identify.

Storage layout:

- Key-Value Store → screenshot image files
- Dataset → structured metadata about each screenshot (WIP)

This separation keeps the actual image files and their structured metadata organized and easy to export.

### Output (WIP)

The Actor stores results in two places:

- **Key-Value Store** – stores the generated screenshot image files.
- **Dataset** – stores structured metadata about each screenshot.

Example dataset record:

{
"url": "https://example.com",
"screenshotKey": "screenshots/page\_1.jpeg"
}

### More Features

Elizaga Applied AI Labs LLC is welcoming new clients and requesting feature requests.  If you need a custom built solution OR if you need this run on your machine locally, reach out at: https://www.linkedin.com/company/elizaga-applied-ai-labs or sales-affiliate@elizaga.dev . God bless you!

### Notes

- The Actor crawls internal links from the starting URL.
- The number of processed pages is limited by **maxPages**.
- Using proxies can help avoid IP blocks during large crawls. (WIP)

# Actor input Schema

## `startUrl` (type: `string`):

The website to screenshot

## `maxPages` (type: `integer`):

No description

## `viewportWidth` (type: `integer`):

Set the width of your screenshot viewport.

## `viewportHeight` (type: `integer`):

Currently unused. Viewport-based screenshots are still in development.

## `fullPageScreenshot` (type: `boolean`):

Capture the entire scrollable page instead of only the visible viewport. 'false' may apply viewportHeight condition and is still in development.

## `screenshotFormat` (type: `string`):

Choose the output format. JPG is recommended because it produces smaller files. PNG can use significantly more storage and bandwidth.

## `pageLoadDelay` (type: `integer`):

Number of seconds to wait for the page to fully load before taking the screenshot. The crawler also waits for network idle with a 3‑second timeout when collecting links to crawl. The actual page load time is this timer plus the selected load mode.

## `proxyConfig` (type: `object`):

Optional proxy settings. Enable Apify Proxy or add custom proxies to avoid IP blocks and rate limits during large crawls.

## Actor input object example

```json
{
  "startUrl": "https://example.com",
  "maxPages": 500,
  "viewportWidth": 1920,
  "viewportHeight": 1080,
  "fullPageScreenshot": true,
  "screenshotFormat": "jpeg",
  "pageLoadDelay": 30,
  "proxyConfig": {
    "useApifyProxy": true,
    "apifyProxyGroups": []
  }
}
```

# Actor output Schema

## `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 = {};

// Run the Actor and wait for it to finish
const run = await client.actor("elizaga-applied-ai-labs-llc/bfs-crawl-website-screenshot").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 = {}

# Run the Actor and wait for it to finish
run = client.actor("elizaga-applied-ai-labs-llc/bfs-crawl-website-screenshot").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 '{}' |
apify call elizaga-applied-ai-labs-llc/bfs-crawl-website-screenshot --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,elizaga-applied-ai-labs-llc/bfs-crawl-website-screenshot"
        }
    }
}
```

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/aPdOo8Smh6WRhr9L4/builds/b8ErtOmTlrJ6mWUMx/openapi.json