Take a Screenshot

post

https://api.screenshotapi.com/take

This page will help you get started with taking a screenshot.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

url

string

required

The URL of the page to capture. Prefix with https:// is optional.

html

string

Raw HTML to render instead of loading a URL.

responseType

string

enum

Defaults to json

Response format: 'json' returns metadata + base64, 'redirect' returns the image directly.

Allowed:

blockPopups

boolean

Defaults to true

Block popup dialogs on the page.

blockCookieBanners

boolean

Defaults to true

Automatically dismiss cookie consent banners.

waitUntil

string

enum

Defaults to load

Navigation event to wait for: 'load', 'domcontentloaded', 'networkidle0', or 'networkidle2'.

Allowed:

waitForSelector

string

CSS selector to wait for before capturing.

viewportDevice

string

Emulate a specific device viewport. For example 'ipad_gen_6' (see Device List page).

viewportWidth

int32

Defaults to 1280

Viewport width in pixels.

viewportHeight

int32

Defaults to 720

Viewport height in pixels.

deviceScaleFactor

number

1 to 5

Device pixel ratio (1-5).

markdown

string

Markdown content to render instead of loading a URL.

delay

int32

0 to 20000

Wait this many milliseconds after page load before capturing.

caret

string

enum

Defaults to hide

Control text cursor visibility: 'hide' or 'initial'.

Allowed:

clipX

number

Defaults to 0

X coordinate of the clip region (pixels from left).

clipY

number

Defaults to 0

Y coordinate of the clip region (pixels from top).

clipWidth

number

Width of the clip region in pixels.

clipHeight

number

Height of the clip region in pixels.

fullPage

boolean

Defaults to false

Capture the entire scrollable page instead of just the viewport.

doScroll

boolean

Defaults to false

Scroll the page before capturing to trigger lazy-loaded content.

omitBackground

boolean

Defaults to false

Make the background transparent (PNG only).

scale

string

enum

Defaults to device

Rendering scale: 'css' for 1x, 'device' for device pixel ratio.

Allowed:

style

string

Custom CSS to inject into the page before capture.

timeout

number

Maximum time in milliseconds to wait for the page to load.

type

string

enum

Defaults to jpeg

Image format for the screenshot.

Allowed:

quality

int32

0 to 100

Defaults to 100

JPEG quality (0-100). Only applies when type is 'jpeg'.

Responses

200

Successful response

400

Bad request - invalid parameters

401

Unauthorized - invalid or missing API key