LaunchPuppeteerOptions

Apify extends the launch options of Puppeteer. You can use any of the puppeteer.launch() options in the Apify.launchPuppeteer() function and in addition, all the options available below.

Properties

Param	Type	Default
`...`
You can use any of the `puppeteer.launch()` options.
`[proxyUrl]`	`String`
URL to a HTTP proxy server. It must define the port number, and it may also contain proxy username and password. Example: `http://bob:pass123@proxy.example.com:1234`.
`[userAgent]`	`String`
The `User-Agent` HTTP header used by the browser. If not provided, the function sets `User-Agent` to a reasonable default to reduce the chance of detection of the crawler.
`[useChrome]`	`Boolean`	`false`
If `true` and `executablePath` is not set, Puppeteer will launch full Google Chrome browser available on the machine rather than the bundled Chromium. The path to Chrome executable is taken from the `APIFY_CHROME_EXECUTABLE_PATH` environment variable if provided, or defaults to the typical Google Chrome executable location specific for the operating system. By default, this option is `false`.
`[useApifyProxy]`	`Boolean`	`false`
If set to `true`, Puppeteer will be configured to use Apify Proxy for all connections. For more information, see the documentation
`[apifyProxyGroups]`	`Array<String>`
An array of proxy groups to be used by the Apify Proxy. Only applied if the `useApifyProxy` option is `true`.
`[apifyProxySession]`	`String`
Apify Proxy session identifier to be used by all the Chrome browsers. All HTTP requests going through the proxy with the same session identifier will use the same target proxy server (i.e. the same IP address). The identifier can only contain the following characters: `0-9`, `a-z`, `A-Z`, `"."`, `"_"` and `"~"`. Only applied if the `useApifyProxy` option is `true`.
`[liveView]`	`Boolean`	`false`
If set to `true`, a `PuppeteerLiveViewServer` will be started to enable screenshot and html capturing of visited pages using `PuppeteerLiveViewBrowser`.
`[liveViewOptions]`	`Object`
Settings for `PuppeteerLiveViewBrowser` started using `launchPuppeteer()`.
`[liveViewOptions.liveViewId]`	`String`
Custom ID of a browser instance in live view.
`[liveViewOptions.screenshotTimeoutMillis]`	`Number`	`3000`
Time in milliseconds before a screenshot capturing will time out and the actor continues with execution. Screenshot capturing pauses execution within the given page.