{
"url": "<string>",
"html": "<string>",
"htmlTemplate": "<string>",
"templateData": {},
"waitUntil": "auto",
"waitForMilliseconds": 2500,
"waitForSelector": {
"selector": "<string>",
"options": {
"visible": false,
"hidden": false,
"timeout": 10000
}
},
"waitForFunction": {
"pageFunction": "window.innerWidth < 100",
"options": {
"polling": "raf",
"timeout": 10000
}
},
"headers": {
"x-foo": "bar"
},
"adblock": true,
"javascript": true,
"cookies": [
{
"name": "<string>",
"value": "<string>",
"domain": "<string>",
"url": "<string>",
"path": "<string>",
"secure": true,
"httpOnly": true,
"expires": 123
}
],
"authentication": {
"username": "<string>",
"password": "<string>"
},
"colorScheme": "<string>",
"timezone": "<string>"
}Page options
All the available page options for the PDF/screenshot API endpoints.
page.url, page.html or page.htmlTemplate needs to be set, they cannot be used at the same time!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.
autoour smart waiting option that can handle 90% of the cases.loadwaits for the 'load' event.domcontentloadedwaits for the 'DOMContentLoaded' event.networkidle0waits till there are no more than 0 network connections for at least500ms.networkidle2waits till there are no more than 2 network connections for at least500ms.
auto, load, domcontentloaded, networkidle0, networkidle2 "auto"
Wait for a certain amount of milliseconds before the request continues.
0 <= x <= 5000Wait 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
Show child attributes
An object containing additional HTTP headers to be sent with every request. All header values must be strings.
{ "x-foo": "bar" }
Use our build-in adblocker.
true
Whether or not to enable JavaScript on the page.
true
Cookies added to the page, Also accepted as string inside headers.cookie.
Show child attributes
Show child attributes
Provide credentials for HTTP authentication.
Show child attributes
Show child attributes
Color-scheme to set on the page.
20Changes the CSS media type of the page.
screen, print Changes the timezone of the page. See ICU’s metaZones.txt for a list of supported timezone IDs.
Was this page helpful?