Screenshot

High-fidelity screenshots of complex SPAs with viewport, scaling, and clip control. Capture any webpage with PuppeteerSharp-powered rendering.

原始信息汇总

Screenshot API 数据集概述

基本信息

• API名称: Screenshot
• 提供者: Colin McGraw
• 类别: Video, Images
• 子类别: Screenshot
• API地址: https://rapidapi.com/colinjamesmcgraw/api/screenshot37
• 版本: v1 (current)
• 流行度: 8.7
• 服务等级: 100%
• 延迟: 1262ms
• 订阅计划:
  • BASIC: $0.00 / mo
  • PRO: $5.00 / mo
  • ULTRA: $14.00 / mo

功能概述

Ghost Browser Screenshot API 用于捕获任何网页的高保真截图，包括使用 React、Vue、Angular 等现代框架构建的复杂单页应用程序。该 API 由 PuppeteerSharp 和无头 Chromium 实例驱动，能够像真实浏览器一样精确渲染页面。它提供对捕获过程的精细控制，允许指定精确的视口尺寸、视网膜显示器的设备缩放因子、输出格式，甚至用于部分捕获的裁剪区域。

主要特性

• 捕获任何 URL 或 HTML 内容的整页或视口截图。
• 支持自定义视口、视网膜设备缩放因子。
• 支持多种图像格式：PNG、JPEG、WebP。
• 支持裁剪区域、透明背景。
• 支持带有网络空闲检测的 SPA 渲染。
• 返回原始图像二进制数据或 base64 编码的 JSON。

端点

• 方法: POST
• 路径: /api/screenshot

认证

所有请求都需要 X-RapidAPI-Proxy-Secret 头（由 RapidAPI 自动处理）。

请求参数

字段	类型	必需	描述
url	string	条件性*	要捕获的 URL。必须是绝对的 HTTP(S) 地址。
html	string	条件性*	要渲染和捕获的原始 HTML 内容。
viewportWidth	integer	否	视口宽度（像素），范围 320–3840。默认值：1280。
viewportHeight	integer	否	视口高度（像素），范围 200–2160。默认值：800。
deviceScaleFactor	integer	否	视网膜设备的缩放因子，范围 1–3。默认值：1。
fullPage	boolean	否	捕获完整的可滚动页面。默认值：false。
imageType	string	否	图像格式：png、jpeg/jpg 或 webp。默认值：png。
quality	integer	否	JPEG 质量，范围 1–100。仅适用于 JPEG。默认值：80。
omitBackground	boolean	否	透明背景（仅适用于 PNG）。默认值：false。
delay	integer	否	页面加载后的额外延迟（毫秒），最大值 10000。
clipX	decimal	否	裁剪区域的 X 坐标（所有四个裁剪字段必须一起提供）。
clipY	decimal	否	裁剪区域的 Y 坐标。
clipWidth	decimal	否	裁剪区域的宽度。
clipHeight	decimal	否	裁剪区域的高度。
outputFormat	string	否	设置为 "base64" 以获取 JSON 响应。默认返回原始图像二进制数据。

*说明：必须提供 url 或 html 中的一个，但不能同时提供。

响应格式

• 当 outputFormat 为 "base64" 时，返回 JSON 对象，包含 base64（Base64编码的图像数据）、mimeType（图像 MIME 类型）和 sizeBytes（图像文件大小，字节）字段。
• 当省略 outputFormat 时，返回带有适当 Content-Type 头的原始图像二进制数据。

约束条件

约束项	值
视口范围	320–3840 x 200–2160
缩放因子	1–3x（支持视网膜）
图像格式	PNG, JPEG, WebP
最大延迟	10,000ms
渲染引擎	无头 Chromium (PuppeteerSharp)
架构	无状态 — 不持久化数据

错误响应

状态码	条件	消息
400	缺少 url 和 html	Either url or html must be provided.
400	无效的 URL	URL must be an absolute HTTP(S) URL.
400	超时	Page load timed out.
401	未授权	缺少或无效的 API 密钥

使用案例

• 视觉回归测试：捕获网页截图以检测 UI 变化。
• 社交预览生成：为链接预览和图库生成页面缩略图。
• SPA 渲染：捕获具有网络空闲检测功能的、JavaScript 密集型的单页应用程序。
• 设备模拟：使用自定义视口模拟移动设备、平板电脑和视网膜显示器。
• 内容存档：将网页快照为图像，用于合规性或记录。