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`
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`.
`[puppeteerModule]`	`string` \| `Object`
Either a require path (`string`) to a package to be used instead of default `puppeteer`, or an already required module (`Object`). This enables usage of various Puppeteer wrappers such as `puppeteer-extra`. Take caution, because it can cause all kinds of unexpected errors and weird behavior. Apify SDK is not tested with any other library besides `puppeteer` itself.
`[stealth]`	`boolean`
This setting hides most of the known properties that identify headless Chrome and makes it nearly undetectable. It is recommended to use it together with the `useChrome` set to `true`.
`[stealthOptions]`	`StealthOptions`
Using this configuration, you can disable some of the hiding tricks. For these settings to take effect `stealth` must be set to true