Page options

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

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.

Show child attributes

waitForSelector.selector

string

required

The selector of an element to wait for.

Required string length: 1 - 1024

waitForSelector.options

object

Options for configuring waiting behavior.

Show child attributes

waitForSelector.options.visible

boolean

default:false

Wait for the selected element to be present in DOM and to be visibleAn element is considered to be visible if all of the following is true:

the element has computed styles
the element has a non-empty bounding client rect
the element's visibility is not hidden or collapse

Example:

false

waitForSelector.options.hidden

boolean

default:false

Wait for the selected element to not be found in the DOM or to be hidden.An element is considered to be hidden if at least one of the following is true:

the element has no computed styles
the element has an empty bounding client rect
the element's visibility is hidden or collapse

Example:

false

waitForSelector.options.timeout

number

default:10000

Maximum time to wait in milliseconds.

Required range: 1 <= x <= 30000

Example:

10000

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.

Show child attributes

waitForFunction.pageFunction

string

required

Function to be evaluated in browser context until it returns a truthy value.

Required string length: 1 - 1024

Example:

"window.innerWidth < 100"

waitForFunction.options

object

Options for configuring waiting behavior.

Show child attributes

waitForFunction.options.polling

default:raf

An interval at which the pageFunction is executed, defaults to raf. If polling is a number, then it is treated as an interval in milliseconds at which the function would be executed. If polling is a string, then it can be one of the following values:

raf to constantly execute pageFunction in requestAnimationFrame callback. This is the tightest polling mode which is suitable to observe styling changes.
mutation to execute pageFunction on every DOM mutation.

Available options:

raf,

mutation

Example:

"raf"

waitForFunction.options.timeout

number

default:10000

Maximum time to wait in milliseconds.

Required range: 1 <= x <= 30000

Example:

10000

headers

object

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

object[] | null

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

Show child attributes

cookies.name

string

required

Cookie name.

Required string length: 1 - 1024

cookies.value

string

required

Cookie value.

Required string length: 1 - 4096

cookies.domain

string

required

Cookie domain.

Required string length: 1 - 512

cookies.url

string | null

The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, source port, and source scheme values of the created cookie. Should include the scheme, e.g. https://

cookies.path

string | null

Cookie path.

Required string length: 1 - 512

cookies.secure

boolean | null

true if cookie is secure.

cookies.httpOnly

boolean | null

true if cookie is http-only.

cookies.sameSite

enum<string> | null

Cookie SameSite type.

Available options:

Strict,

Lax,

None

cookies.expires

number | null

Cookie expiration date (UTC time in seconds, counted from January 1, 1970.), session cookie if not set.

authentication

object

Provide credentials for HTTP authentication.

Show child attributes

authentication.username

string

required

Required string length: 1 - 1024

authentication.password

string

required

Required string length: 1 - 4096

colorScheme

string | null

Color-scheme to set on the page.

Maximum string 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.

Get Started

Templating

API Documentation

Sync/Async options

Screenshot

PDF

Template

Manage Templates