Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-132176113.0 KB
screenshot

Capture a full-page screenshot of a website

post/screenshot

Request body

urlstring required

Target URL

device'desktop' | 'mobile'

Device type to emulate. Defaults to desktop.

proxyCountrystring

Proxy country code to route the request

type'png' | 'jpeg' | 'webp'

File type of screenshot. Defaults to png.

fullPageboolean

Take full-page screenshot

blockAdsboolean

Block ads on the page

hideCookieboolean

Hide cookie popups

skipCaptchaboolean

Try to bypass captcha

addTimestampboolean

Add timestamp watermark

pageHeightnumber

Height of the page (for partial screenshot)

viewportWidthnumber

Width of the viewport

viewportHeightnumber

Height of the viewport

theme'light' | 'dark' | 'auto'

Theme to use for rendering

removeBackgroundboolean

Remove background from screenshot

highlightLinksboolean

Highlight links on the page

delaynumber

Delay before taking screenshot (in seconds)

disableAnimationsboolean

Disable animations on the page

qualitynumber

Image quality (for JPEG/WEBP)

scaleFactornumber

Device scale factor

captureBeyondViewportboolean

Capture beyond viewport if possible

Example request

{
  "url": "https://example.com",
  "device": "desktop",
  "proxyCountry": "us",
  "type": "png",
  "fullPage": true,
  "blockAds": true,
  "hideCookie": true,
  "skipCaptcha": true,
  "addTimestamp": true,
  "pageHeight": 2000,
  "viewportWidth": 1280,
  "viewportHeight": 800,
  "theme": "auto",
  "delay": 2,
  "quality": 90,
  "scaleFactor": 1,
  "captureBeyondViewport": true
}

Response

Successfully captured screenshot

timestampnumber required

Timestamp of the request in milliseconds

apiStatus'success' | 'failure' required

API status message

apiCodenumber required

API status code

datastring required

Screenshot URL or base64 string

Example response

{
  "timestamp": 1763372588297,
  "apiStatus": "success",
  "apiCode": 200,
  "meta": {
    "url": "https://example.com",
    "type": "png",
    "device": "desktop",
    "pageHeight": 2000,
    "viewportWidth": 1280,
    "viewportHeight": 800,
    "theme": "auto",
    "delay": 2,
    "quality": 90,
    "scaleFactor": 1,
    "captureBeyondViewport": true,
    "test": {
      "id": "mxqx9v9y0742lap6altwdteqd28t23nq"
    }
  },
  "data": "https://geekflare.com/tests/screenshot/kbi6d206g87ituahb7icwtpr.png"
}