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:

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

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

Full Page Screenshot

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

Custom Dimensions

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

URL Without Protocol

{
  "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.