Get Template

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

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!

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

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.

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

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

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.

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

Use our build-in adblocker.

Whether or not to enable JavaScript on the page.

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

Provide credentials for HTTP authentication.

Color-scheme to set on the page.

Changes the CSS media type of the page.

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

Device preset to use, will not be set when viewport option is provided!

Define an custom viewport, when defined the device option will be ignored!

When true, takes a screenshot of the full page.

Capture the screenshot from the surface, rather than the view.

Hides default white background and allows capturing screenshots with transparency.

Quality of the image, between 0-100. Not applicable to png images.

Capture the screenshot beyond the viewport. false if there is no clip. true otherwise.

Specifies the region of the page to clip.

It captures the DOM element matching the given CSS selector. This will overwrite the clip property and set fullPage to false. Will wait for the element to become visible for a maximum of 15 seconds.

Add an overlay to the image. Cannot be used together with the fullPage option!

Scales the rendering of the web page. Amount must be between 0.1 and 2.

Whether to show the header and footer.

HTML template for the print header. Should be valid HTML (base64 encoded) with the following classes used to inject values into them:

• date formatted print date
• title document title
• url document location
• pageNumber current page number
• totalPages total pages in the document

HTML template for the print footer. Has the same constraints and support for special classes as headerHtml.

Set to true to print background graphics.

Whether to print in landscape orientation.

Paper ranges to print, e.g. 1-5, 8, 11-13.

If set, this takes priority over the width and height options. The sizes of each format are as follows:

• letter 8.5in x 11in
• legal 8.5in x 14in
• tabloid 11in x 17in
• ledger 17in x 11in
• a0 33.1in x 46.8in
• a1 23.4in x 33.1in
• a2 16.54in x 23.4in
• a3 11.7in x 16.54in
• a4 8.27in x 11.7in
• a5 5.83in x 8.27in
• a6 4.13in x 5.83in

Sets the width of paper. You can pass in a number or a string with a unit.

Sets the height of paper. You can pass in a number or a string with a unit.

Give any CSS @page size declared in the page priority over what is declared in the width or height or format option.

Set the PDF margins.

Hides default white background and allows generating pdfs with transparency.

Generate document outline. If this is enabled the PDF will also be tagged (accessible).

Generate tagged (accessible) PDF. This is experimental and will increase the size of the PDF.