Website Screenshot API 📸

Turn any URL or raw HTML into a pixel-perfect screenshot, PDF, or Open Graph card. Full-page & device capture, dark mode, ad/tracker/cookie-banner blocking, PII redaction, visual diffing, base64-to-image conversion, and DOM + console-error extraction — all in a single run.

Four tools in one Actor

Pick a Mode and get exactly one result per run — every mode is billed the same (one result = one charge):

Mode	What you get	Key inputs
screenshot (default)	PNG / JPEG / WebP / Chrome-rendered PDF of any URL or raw HTML	url or html, format, fullPage, device
og	Branded 1200×630 Open Graph / social-share card — no URL needed	ogTitle, ogSubtitle, ogTheme, ogLogoUrl
diff	Highlighted pixel-diff image of two URLs + percentChanged score	url, compareUrl, diffThreshold
decode	A base64 image string converted back to a downloadable file	base64Image

Screenshot mode features:

• Full page or viewport — capture the whole scrollable page or just the fold
• Device emulation — iPhone 14, iPhone SE, Pixel 7, iPad Pro, desktop, or a custom viewport
• Dark mode, timezone, and locale emulation
• Blocking — strip ads, trackers, and cookie-consent banners before capture
• Redaction — hide or blur any CSS selector (e.g. account numbers, emails)
• Wait strategies — wait for a selector, network idle, or fonts + images to finish
• DOM extraction — return page text, links, and metadata alongside the image
• Console capture — collect JavaScript errors and warnings for QA / page-health checks

Input

Screenshot (default mode)

Provide at least a url (or raw html). All other fields are optional:

{
  "url": "https://example.com",
  "format": "png",
  "fullPage": true,
  "device": "iphone_14",
  "blockCookieBanners": true,
  "extract": ["metadata", "links"]
}

Open Graph card

{
  "mode": "og",
  "ogTitle": "Ship Faster with Our API",
  "ogSubtitle": "One call. Any page. Pixel-perfect.",
  "ogTheme": "gradient"
}

The input above produces this card:

Visual diff

{
  "mode": "diff",
  "url": "https://example.com",
  "compareUrl": "https://example.com/v2",
  "diffThreshold": 10
}

Changed pixels are highlighted, unchanged areas are greyed out (example.com vs iana.org — 7.09% changed):

Decode base64

{
  "mode": "decode",
  "base64Image": "iVBORw0KGgoAAAANSUhEUg..."
}

See the Input tab for the full, documented list of fields with defaults and bounds.

Output

• Key-value store — the produced image is stored under screenshot.<ext>, og-card.<ext>, diff.png, or decoded.<ext> depending on the mode.
• Dataset — one record per run:

{
  "mode": "screenshot",
  "url": "https://example.com",
  "format": "png",
  "width": 1920,
  "height": 1080,
  "captureTimeMs": 2184,
  "screenshotUrl": "https://api.apify.com/v2/key-value-stores/.../records/screenshot.png",
  "extraction": { "metadata": { "title": "Example Domain", "lang": "en" } },
  "consoleErrors": []
}

Diff runs additionally include percentChanged, changedPixels, and totalPixels.

screenshotUrl is a direct public link to the stored image — embed it, download it, or pass it downstream.

Common uses

• Website thumbnails and preview images
• URL-to-PDF archiving and reporting
• Visual QA and page-health monitoring (console errors)
• Visual regression checks between two deployments or page versions
• Open Graph / social-share card generation
• Scraping page metadata and links together with a visual snapshot

---