Skip to main content
Either page.url, page.html or page.htmlTemplate needs to be set, they cannot be used at the same time!
​
url
string | null

URL to go to. Should include the scheme, e.g. https://

​
html
string | null

HTML to render. Needs to be base64 encoded!

​
htmlTemplate
string | null

HTML template to render, uses Handlebars to render your HTML together with the provided templateData. Needs to be base64 encoded!

​
templateData
object | null

Template data, only used in combination with page.htmlTemplate.

​
waitUntil
enum<string>
default:auto

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 least 500 ms.
  • networkidle2 waits till there are no more than 2 network connections for at least 500 ms.
Available options:
auto,
load,
domcontentloaded,
networkidle0,
networkidle2
Example:

"auto"

​
waitForMilliseconds
number | null

Wait for a certain amount of milliseconds before the request continues.

Required range: 0 <= x <= 5000
​
waitForSelector
object

Wait for the selector to appear in page. If the selector doesn't appear after the timeout milliseconds of waiting, the request will continue.

​
waitForFunction
object

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.

​
headers
object | null

An object containing additional HTTP headers to be sent with every request. All header values must be strings.

Example:
{ "x-foo": "bar" }
​
adblock
boolean
default:true

Use our build-in adblocker.

Example:

true

​
javascript
boolean
default:true

Whether or not to enable JavaScript on the page.

Example:

true

​
cookies
object[] | null

Cookies added to the page, Also accepted as string inside headers.cookie.

​
authentication
object

Provide credentials for HTTP authentication.

​
colorScheme
string | null

Color-scheme to set on the page.

Maximum length: 20
​
mediaType
enum<string> | null

Changes the CSS media type of the page.

Available options:
screen,
print
​
timezone
string | null

Changes the timezone of the page. See ICU’s metaZones.txt for a list of supported timezone IDs.