Learn how to set up and configure Bright Data’s Browser API with your credentials, run sample scripts, and navigate live browser sessions. Ensure efficient web scraping with our detailed instructions.
To get started, grab your credentials - the Username and Password you will use with your web automation tool. You can find them in the Browser API zone you just created, in the “Overview” tab. We assume that you aleady have your preferred web automation tool installed. If not, please instal it.
The Browser API Debugger enables developers to inspect, analyze, and fine-tune their code alongside Chrome Dev Tools, resulting in better control, visibility, and efficiency. You can integrate the following code snippet to launch devtools automatically for every session:
Copy
// Node.js Puppeteer - launch devtools locally // Add these requirements in addition to the other required importsconst { exec } = require('child_process'); const chromeExecutable = 'google-chrome'; // Add these functions to the top of the script const delay = ms => new Promise(resolve => setTimeout(resolve, ms)); const openDevtools = async (page, client) => { // get current frameId const frameId = page.mainFrame()._id; // get URL for devtools from Browser API const { url: inspectUrl } = await client.send('Page.inspect', { frameId }); // open devtools URL in local chrome exec(`"${chromeExecutable}" "${inspectUrl}"`, error => { if (error) throw new Error('Unable to open devtools: ' + error); }); // wait for devtools ui to load await delay(5000); }; // Add these lines before navigating to the target URL const page = await browser.newPage(); const client = await page.target().createCDPSession(); await openDevtools(page, client); await page.goto('http://example.com');
Browser API sessions are structured to allow one initial navigation per session. This initial navigation refers to the first instance of loading the target site from which data is to be extracted. Following this, users are free to navigate the site using clicks, scrolls, and other interactive actions within the same session. However, to start a new scraping job, either on the same site or a different one, from the initial navigation stage, it is necessary to begin a new session.
Browser API has 2 kinds of timeouts aimed to safeguard our customers from uncontrolled usage.
Idle Session Timeout: in case a browser session is kept open for 5 minutes and above in an idle mode, meaning no usage going through it, Browser API will automatically timeout the session.
Maximum Session Length Timeout: Browser API session can last up to 30 minutes. Once the maximum session time is reached the session will automatically timeout.