BrowserFeaturesBrowser Extensions

Browser Extensions

Enhance your browsing experience and sessions with Scrapeless via your customized browser extensions.

APIs

  • Upload extensions: POST /extensions/upload
  • Update extensions: PUT /extensions/{extensionId}
  • Delete extensions: DELETE /extensions/{extensionId}
  • Get extensions list: GET /extensions/list
  • Get extensions information: GET /extensions/{extensionId}

Refer to the API doc to see details.

Setup a browser extension

Use the extension_ids parameter to specify the extension ID to set the browser extension. Use commas to separate multiple extension IDs.

For example: extension_ids=extension_id1,extension_id2

Example Extensions

The example code demonstrates how to upload the MetaMask extension via the API and specify it to load when launching the browser.

// npm install @scrapeless-ai/sdk puppeteer-core
import { Scrapeless } from '@scrapeless-ai/sdk';
import puppeteer from 'puppeteer-core';
 
const API_TOKEN = 'API Key'; // replace with your API Key
const EXTENSION_FILE_PATH = '/extensions/metamask-chrome-12.20.0.zip'; // replace with your extension zip file path
 
const client = new Scrapeless({ apiKey: API_TOKEN });
const { browser: scrapingBrowser } = client;
 
(async () => {
    try {
        const uploadResponse = await scrapingBrowser.extension.upload(EXTENSION_FILE_PATH, 'metamask'); // extension name
        const extensionId = uploadResponse?.extensionId;
    
        const { browserWSEndpoint } = scrapingBrowser.create({
            session_name: 'use-extension',
            session_ttl: 180,
            extension_ids: extensionId, // setup browser extension, separate by comma for multiple extensions
        });
        const browser = await puppeteer.connect({
            browserWSEndpoint,
            defaultViewport: null
        });
    
        const page = await browser.newPage();
        await page.goto('chrome://extensions/');
    
        await page.screenshot({
            path: 'extensions-screenshot.png',
            fullPage: true
        });
    
        await browser.close();
    } catch (error) {
        console.error('Error:', error.response?.data || error.message);
    }
})()

You can check if the extensions have loaded successfully by visiting the chrome://extensions page.

The result can be seen as below:

example