Screenshot Options

Complete reference of all available parameters for the screenshot API.

Authentication

Parameter	Description	Default
access_key	Your API access key (required)	—
signature	HMAC signature for signed requests	—

Target

Parameter	Description	Default
url	URL of the website to screenshot	—
html	HTML content to render directly	—
selector	CSS selector to capture specific element	—

Output Format

Parameter	Description	Default
format	Output format: png, jpeg, webp, gif, avif, heif, pdf	png
response_type	by_format (image), json (metadata), empty	by_format
image_quality	Quality 0-100 (for jpeg, webp)	80

Viewport

Parameter	Description	Default
viewport_width	Viewport width in pixels	1280
viewport_height	Viewport height in pixels	1024
viewport_device	Device preset (e.g., iphone_15_pro)	—
device_scale_factor	Device pixel ratio 1-5	1
viewport_mobile	Emulate mobile device	false
viewport_has_touch	Enable touch events	false

Full Page

Parameter	Description	Default
full_page	Capture entire scrollable page	false
full_page_scroll	Scroll page to load lazy content	false
full_page_scroll_delay	Delay between scrolls (ms)	400
full_page_max_height	Maximum screenshot height (px)	—

Image Sizing

Parameter	Description	Default
image_width	Resize output image width	—
image_height	Resize output image height	—
clip_x	X coordinate of clipping area	—
clip_y	Y coordinate of clipping area	—
clip_width	Width of clipping area	—
clip_height	Height of clipping area	—
omit_background	Transparent background (PNG only)	false

Blocking

Parameter	Description	Default
block_ads	Block advertisements	false
block_cookie_banners	Block cookie consent dialogs	false
block_trackers	Block analytics and trackers	false
block_chats	Block chat widgets	false
block_requests	Block requests matching URL pattern	—
block_resources	Block resource types (image, font, etc.)	—

Emulation

Parameter	Description	Default
dark_mode	Enable dark mode (true, false)	—
reduced_motion	Prefer reduced motion	false
media_type	CSS media type: screen, print	screen
time_zone	IANA timezone (e.g., America/New_York)	—

Customization

Parameter	Description	Default
hide_selectors	CSS selectors to hide (comma-separated)	—
click	CSS selector to click before capture	—
scripts	Custom JavaScript to inject	—
styles	Custom CSS to inject	—

Request Options

Parameter	Description	Default
user_agent	Custom User-Agent string	—
headers	Custom HTTP headers	—
cookies	Cookies to set	—
authorization	Authorization header value	—
bypass_csp	Bypass Content Security Policy	false

Geolocation

Parameter	Description	Default
ip_country_code	Render from country: us, gb, de, fr, jp, etc.	us
geolocation_latitude	GPS latitude	—
geolocation_longitude	GPS longitude	—
proxy	HTTP proxy URL	—

Timing

Parameter	Description	Default
delay	Wait seconds before capture	0
timeout	Request timeout in seconds	60
wait_until	Wait event: load, domcontentloaded, networkidle0, networkidle2	load
wait_for_selector	Wait for CSS selector to appear	—

PDF Options

Parameter	Description	Default
pdf_print_background	Include background graphics	false
pdf_landscape	Landscape orientation	false
pdf_paper_format	Paper size: a4, letter, legal, etc.	letter
pdf_margin	Page margins (e.g., 20px)	—

Caching

Parameter	Description	Default
cache	Enable response caching	false
cache_ttl	Cache duration in seconds	14400
cache_key	Custom cache key	—

Storage

Parameter	Description	Default
store	Upload to S3 storage	false
storage_path	S3 object key/path	—
storage_bucket	S3 bucket name	—
storage_access_key_id	AWS access key	—
storage_secret_access_key	AWS secret key	—
storage_return_location	Return S3 URL in response	false

Async & Webhooks

Parameter	Description	Default
async	Process request asynchronously	false
webhook_url	URL for webhook callback	—
webhook_sign	Sign webhook requests	true

Error Handling

Parameter	Description	Default
ignore_host_errors	Ignore HTTP errors from target site	false
fail_if_content_contains	Fail if page contains string	—
fail_if_content_missing	Fail if page missing string	—