Page options
All the available page options for the PDF/screenshot API endpoints.
Either page.url
, page.html
or page.htmlTemplate
needs to be set, they cannot be used at the same time!
Use our build-in adblocker.
Provide credentials for HTTP authentication
.
Color-scheme to set on the page.
20
Cookies added to the page, Also accepted as string inside headers.cookie
.
An object containing additional HTTP headers to be sent with every request. All header values must be strings.
HTML to render. Needs to be base64 encoded!
HTML template to render, uses Handlebars to render your HTML together with the provided templateData
. Needs to be base64 encoded!
Whether or not to enable JavaScript on the page.
Changes the CSS media type of the page.
screen
, print
Template data, only used in combination with page.htmlTemplate
.
Changes the timezone of the page. See ICU’s metaZones.txt for a list of supported timezone IDs.
URL to go to. Should include the scheme, e.g. https://
Wait for the pageFunction
to execute in the page. If the pageFunction
doesn't execute successfully after the timeout
milliseconds of waiting, the request will continue.
Wait for a certain amount of milliseconds before the request continues.
0 < x < 5000
When to consider waiting succeeds.
auto
our smart waiting option that can handle 90% of the cases.load
waits for the 'load' event.domcontentloaded
waits for the 'DOMContentLoaded' event.networkidle0
waits till there are no more than 0 network connections for at least500
ms.networkidle2
waits till there are no more than 2 network connections for at least500
ms.
auto
, load
, domcontentloaded
, networkidle0
, networkidle2
Was this page helpful?