ScreenshotAPI

Capture website screenshots and PDFs from any URL with a simple developer API. Supports full-page capture, custom viewports, dark mode, ad/cookie popup cleanup, caching, HTML rendering, and PNG/JPEG/WebP/PDF output.

原始信息汇总

ScreenshotAPI 数据集概述

ScreenshotAPI 是一个通过单次 HTTP 请求将任意 URL 或 HTML 文档转换为截图或 PDF 的 API，专为需要生成链接预览、网站缩略图、视觉监控、报告、OG 图像、QA 工作流和 Web 存档的开发者设计。

核心功能

• 输出格式：支持 PNG、JPEG、WebP、PDF。
• 截图模式：支持整页截图或视口截图。
• 视口控制：可自定义宽度和高度。
• 渲染模式：支持暗色模式和亮色模式渲染。
• 等待策略：包括 load、DOMContentLoaded、network idle、选择器等待、自定义延迟。
• 页面净化：支持广告拦截、Cookie 横幅移除、弹窗移除、元素移除。
• HTML 渲染：支持通过 POST 请求直接渲染 HTML。
• 自定义注入：支持 CSS 和 JavaScript 注入。
• 高清捕获：支持 Retina/HiDPI 捕获，缩放因子可选 1、2、3。
• 环境模拟：支持时区、区域设置和地理位置模拟。
• 缓存机制：支持响应缓存，缓存时长可自定义（0-604800秒）。
• 框架外框：可添加浏览器、iPhone 或 MacBook 外框（mockupDevice 参数）。
• SDK 支持：提供 JavaScript/TypeScript、Python、Go、Ruby、PHP 官方 SDK。

主要参数

参数	方法	说明
url	GET, POST	需要捕获的绝对 http/https URL（POST 模式下若提供了 html 参数则可省略）。
html	POST	需要渲染的原始 HTML。
type	GET, POST	输出格式（png/jpeg/webp/pdf），默认 png。
width	GET, POST	视口宽度像素（1-1920），默认 1440。
height	GET, POST	视口高度像素（1-10000），默认 900。
fullPage	GET, POST	是否捕获完整的可滚动页面。
quality	GET, POST	JPEG/WebP 质量（1-100），PNG/PDF 忽略。
colorScheme	GET, POST	强制 light 或 dark 模式。
waitUntil	GET, POST	浏览器导航等待条件（load/domcontentloaded/networkidle0/networkidle2）。
waitForSelector	GET, POST	等待的 CSS 选择器。
delay	GET, POST	捕获前额外延迟（毫秒，0-30000）。
blockAds	GET, POST	是否拦截广告和跟踪器。
removeCookieBanners	GET, POST	是否隐藏/接受 Cookie 横幅。
removePopups	GET, POST	是否隐藏弹窗和覆盖层。
removeElements	GET, POST	捕获前移除指定元素。
cssInject / jsInject	GET, POST	注入的 CSS/JavaScript（最多10000字符）。
devicePixelRatio	GET, POST	设备比例因子（1/2/3）。
timezone / locale	GET, POST	IANA 时区 / BCP 47 区域设置。
cacheTtl	GET, POST	缓存时长（秒，0-604800），0 或省略为不缓存。
mockupDevice	GET, POST	可选外框（browser/iphone/macbook）。

认证方式

通过 RapidAPI 调用时，使用以下两个 HTTP 头进行认证：

• X-RapidAPI-Key: 您的 RapidAPI Key
• X-RapidAPI-Host: screenshotapi6.p.rapidapi.com

注意：通过 RapidAPI 调用时，请勿发送 ScreenshotAPI 的 x-api-key 头。

响应信息

• 成功响应的直接返回二进制内容，并根据输出格式自动设置 Content-Type（image/png, image/jpeg, image/webp, application/pdf）。
• 响应头中包含 x-screenshot-id（截图ID）、x-duration-ms（捕获耗时）、x-cache（缓存状态）、x-credits-remaining（剩余配额）。

错误状态码

状态码	含义
400	截图选项无效、参数值不支持或参数组合不兼容。
401	缺少或无效的认证信息。
402	计划配额已用尽。
403	API Key 或订阅无权限访问。
500	截图捕获失败（如目标URL不可达），建议检查URL并重试。

输入端点

API 通过 RapidAPI 暴露，基础 URL 为 https://screenshotapi6.p.rapidapi.com。提供两个端点：

• GET /screenshot：捕获给定 URL 的截图或 PDF。
• POST /screenshot：渲染原始 HTML 文档。

常见用例

• 生成网站缩略图
• 构建链接预览图像
• 为报告捕获整页截图
• 存档公共网页
• 监控视觉变化
• 将 HTML 渲染为图片或 PDF
• 测试响应式布局