Skip to main content

​
Capture Screenshot

Capture a screenshot of any publicly accessible website.

​
Endpoint

GET /api/screenshot

​
Query Parameters

​
url
string
required
URL of the website to screenshot (must include https://)
​
width
integer
default:"1920"
Screenshot width in pixels
​
height
integer
default:"1080"
Screenshot height in pixels
​
format
string
default:"png"
Image format. Options: png, jpg, jpeg, webp
​
delay
integer
default:"0"
Delay in milliseconds before taking screenshot (useful for dynamic content)

​
Response Example

{
  "url": "https://google.com",
  "width": "1920",
  "height": "1080",
  "format": "png",
  "delay": "0",
  "screenshot": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABVYAAAMACAIAAABAXKuVAAAAAXNSR0IArs4c..."
}

​
Response Fields

​
url
string
The URL that was captured
​
width
string
Width of the screenshot in pixels
​
height
string
Height of the screenshot in pixels
​
format
string
Image format used (png, jpg, jpeg, or webp)
​
delay
string
Delay in milliseconds that was applied before capture
​
screenshot
string
Base64-encoded image data with data URI prefix (data:image/{format};base64,)

​
Common Resolutions

DeviceWidthHeight
Desktop HD19201080
Desktop 4K38402160
Tablet1024768
Mobile375667
Mobile (iPhone)390844
Use the delay parameter when capturing dynamic websites that load content via JavaScript. A delay of 1000-3000ms is usually sufficient for most sites.
Screenshots can only be captured from publicly accessible websites. Password-protected or authentication-required pages cannot be captured.
The screenshot is returned as a base64-encoded data URI, which can be directly used in HTML <img> tags or decoded and saved as a file.

​
Use Cases

Website Monitoring

Monitor website changes and layouts

Thumbnail Generation

Generate preview thumbnails for URLs

Archiving

Archive web pages visually

Testing

Visual regression testing

​
Image Format Options

​
PNG

  • Best for: Screenshots with text, sharp edges
  • Lossless compression
  • Larger file sizes
  • Transparency support

​
JPG/JPEG

  • Best for: Photographs, complex images
  • Lossy compression
  • Smaller file sizes
  • No transparency support

​
WebP

  • Best for: Modern browsers
  • Superior compression
  • Smaller file sizes than PNG/JPG
  • Transparency support