- url
- Default: required
- The page to capture. https:// is added when you leave it out.
- full_page
- Default: false
- Capture the whole page, not just the first screen.
- viewport_width
- Default: 1280
- Browser width in pixels. viewport_height is 800.
- viewport_device
- Default: none
- A phone, tablet or laptop's size and user agent, such as iphone_15 or ipad_landscape.
- format
- Default: png
- png, jpeg, webp or pdf. image_quality sets jpeg and webp quality.
- response_type
- Default: by_format
- json for the title, description, Open Graph tags and icon, with the image in base64.
- block_cookie_banners
- Default: true
- Reject or close consent banners before the shot.
- block_popups
- Default: true
- Close newsletter and sign-up modals.
- block_chats
- Default: true
- Hide chat launchers and similar corner widgets.
- block_ads
- Default: true
- Block ad networks and hide ad boxes, using EasyList.
- block_trackers
- Default: true
- Block tracking scripts and pixels, using EasyPrivacy.
- hide_selectors
- Default: none
- Your own CSS selectors to hide, comma-separated.
- selector
- Default: none
- Capture one element instead of the page.
- wait_for_selector
- Default: none
- Wait until this element shows up.
- click
- Default: none
- Click these elements first, such as a tab or a "Show more" button.
- scripts
- Default: none
- Your own JavaScript, run in the page before the shot. styles adds CSS.
- block_requests
- Default: none
- Hosts or URL patterns not to load. block_resources skips kinds, such as font.
- headers
- Default: none
- Extra headers for the page's own site. cookies sets cookies first.
- html
- Default: none
- Your own markup to render instead of a URL, in a POST body.
- dark_mode
- Default: false
- Ask the page for its dark theme.