Launch Options
Here is a complete list of GET parameters for launching, click on the parameter to go to the detailed section of the documentation
-
timeout
- Session timeout (milliseconds). The limit on how long a browser instance can run. -
proxy
,proxyCountry
,proxySticky
- Proxy network, country and behaviour -
solveCaptcha
- Enables a captcha-solving plugin if a captcha is presented. Supported captchas include: reCAPTCHA, FunCaptcha, GeeTest, and Cloudflare Turnstile. -
stealthMode
- Stealth mode helps to reduce bot detection on sites -
context
- Contexts enable the persistence of user data across multiple browser sessions, facilitating smoother automation, easier authentication, and improved performance optimization. -
cache
- Cache enable the persistence of site cache across multiple browser sessions. -
blockRes
- List of blocked resources for proxy traffic optimization -
os
- Selecting OS fingerprints -
blockAds
- Enables uBlock extension for blocking ads -
blockCookieBanners
- Accepts necessary cookie policies for smooth website navigation without deleting cookies that might be useful when making screencasts or page screenshots.
Session Timeout
Puppeteer / Playwright
By default session timeout is 30 seconds. You can set your value (in milliseconds) if it is needed for your script
- Puppeteer
- Playwright
- REST APIs
import puppeteer from "puppeteer-core";
const browser = await puppeteer.connect({
browserWSEndpoint: `wss://chrome-v2.browsercloud.io?token=API_TOKEN&timeout=60000`,
});
// ...
import playwright from "playwright";
const browser = await playwright.chromium.connectOverCDP(
`wss://chrome-v2.browsercloud.io?token=API_TOKEN&timeout=60000`
);
// ...
curl 'https://chrome-v2.browsercloud.io/content?token=API_TOKEN&timeout=60000'
Captcha Solving
Enables a captcha-solving plugin if a captcha is presented. Supported captchas include: reCAPTCHA, FunCaptcha, GeeTest, and Cloudflare Turnstile.
The plugin makes passing any captcha hassle-free. Captchas are recognized automatically, in the background.
- Puppeteer
- Playwright
- REST APIs
import puppeteer from "puppeteer-core";
const browser = await puppeteer.connect({
browserWSEndpoint: `wss://chrome-v2.browsercloud.io?token=API_TOKEN&solveCaptcha`,
});
// ...
import playwright from "playwright";
const browser = await playwright.chromium.connectOverCDP(
`wss://chrome-v2.browsercloud.io?token=API_TOKEN&solveCaptcha`
);
// ...
curl 'https://chrome-v2.browsercloud.io/content?token=API_TOKEN&solveCaptcha&url=https%3A%2F%2Fsite.com'
Blocking ads
Enables uBlock extension for blocking ads
- Puppeteer
- Playwright
- REST APIs
import puppeteer from "puppeteer-core";
const browser = await puppeteer.connect({
browserWSEndpoint: `wss://chrome-v2.browsercloud.io?token=API_TOKEN&blockAds`,
});
// ...
import playwright from "playwright";
const browser = await playwright.chromium.connectOverCDP(
`wss://chrome-v2.browsercloud.io?token=API_TOKEN&blockAds`
);
// ...
curl 'https://chrome-v2.browsercloud.io/content?token=API_TOKEN&blockAds&url=https%3A%2F%2Fsite.com'
Context and Cache
Contexts let you maintain user data across multiple browser sessions, which facilitates smoother automation, easier authentication, and enhanced performance optimization.
Typically, each Browsercloud session begins with a new user data directory, meaning cookies, cache, and session storage are cleared between sessions. However, with Contexts, you can reuse stored data across sessions, making automation workflows faster, more reliable, and more efficient. Browser cookies are stored within the user data directory.
In contrast, the "cache" parameter only retains cache between sessions and does not save cookies or session storage data.
Context parameter
- Puppeteer
- Playwright
- REST APIs
import puppeteer from "puppeteer-core";
const browser = await puppeteer.connect({
browserWSEndpoint: `wss://chrome-v2.browsercloud.io?token=API_TOKEN&context={anyUniqueIdForSite}`,
});
// ...
import playwright from "playwright";
const browser = await playwright.chromium.connectOverCDP(
`wss://chrome-v2.browsercloud.io?token=API_TOKEN&context={anyUniqueIdForSite}`
);
// ...
curl 'https://chrome-v2.browsercloud.io/content?token=API_TOKEN&context={anyUniqueIdForSite}'
Cache parameter
- Puppeteer
- Playwright
- REST APIs
import puppeteer from "puppeteer-core";
const browser = await puppeteer.connect({
browserWSEndpoint: `wss://chrome-v2.browsercloud.io?token=API_TOKEN&cache={anyUniqueIdForSite}`,
});
// ...
import playwright from "playwright";
const browser = await playwright.chromium.connectOverCDP(
`wss://chrome-v2.browsercloud.io?token=API_TOKEN&cache={anyUniqueIdForSite}`
);
// ...
curl 'https://chrome-v2.browsercloud.io/content?token=API_TOKEN&cache={anyUniqueIdForSite}'
Block cookie banners
Accepts necessary cookie policies for smooth website navigation without deleting cookies that might be useful when making screencasts or page screenshots.
- Puppeteer
- Playwright
- REST APIs
import puppeteer from "puppeteer-core";
const browser = await puppeteer.connect({
browserWSEndpoint: `wss://chrome-v2.browsercloud.io?token=API_TOKEN&blockCookieBanners`,
});
// ...
import playwright from "playwright";
const browser = await playwright.chromium.connectOverCDP(
`wss://chrome-v2.browsercloud.io?token=API_TOKEN&blockCookieBanners`
);
// ...
curl 'https://chrome-v2.browsercloud.io/content?token=API_TOKEN&blockCookieBanners&url=https%3A%2F%2Fsite.com'