National Puppy Menace

    @kameleo/local-api-client
    TypeScript icon, indicating that this package has built-in type declarations

    2.6.0 • Public • Published

    Kameleo Local API Client

    With Kameleo, you can easily create multiple virtual browser profiles to work with multiple accounts. It helps you hide your actual timezone, geolocation, language, IP address and creates natural browser fingerprints to prevent detection by anti-bot systems. Kameleo is compatible with Selenium, Playwright, and Puppeteer frameworks for automating web scraping tasks. This JavaScript/TypeScript package provides convenient access to the Local API REST interface of the Kameleo Client. See the article in our knowledge base for Getting Started with Kameleo Automation.

    Features

    • Stay completely undetected, so websites won't be able to detect that you are using automation tools
    • Start unlimited number of profiles with different natural browser fingerprints
    • Use authenticated HTTP/SOCKS/SSH proxies in browsers
    • Create isolated browsing environments simultaneously
    • Use real browser profiles of Chrome, Firefox, Safari and Edge
    • Edit, Import or Export browser cookies
    • Modify WebRTC parameters
    • Modify Geolocation settings
    • Modify Timezone and Language settings
    • Modify WebGL fingerprint
    • Modify 2D Canvas fingerprint
    • Modify Navigator properties
    • Modify Screen resolution

    Note: You need Automation package of Kameleo to access the features described below.

    Quickstart Guide

    1. Install package

    npm install @kameleo/local-api-client
    

    2. Start the Kameleo.CLI on your computer

    ./Kameleo.CLI.exe email="your@email.com" password="Pa$$w0rd"
    

    3. Start a browser with out-of-the-box fingerprinting protection

    const { KameleoLocalApiClient, BuilderForCreateProfile } = require('@kameleo/local-api-client');
    
    (async () => {
        const client = new KameleoLocalApiClient();
        const baseProfiles = await client.searchBaseProfiles({
            deviceType: 'desktop',
            browserProduct: 'chrome'
        });
    
        // Create a new profile with recommended settings
        // for browser fingerprinting protection
        const requestBody = BuilderForCreateProfile
            .forBaseProfile(baseProfiles[0].id)
            .setRecommendedDefaults()
            .build();
        const profile = await client.createProfile({ body: requestBody });
    
        // Start the browser
        await client.startProfile(profile.id);
    
        // At this point you can automate the browser with your favorite framework
    })();

    Automate Kameleo profiles with Selenium

    Kameleo gives you the ability to control any supported browser using Selenium. It uses the WebDriver protocol, a W3C specification, and industry-standard to interact with a browser.

    You need to import the official Selenium library.

    const { Builder, By } = require('selenium-webdriver');
    // Connect to the running browser instance using WebDriver
    const builder = new Builder()
        .usingServer(`http://localhost:${kameleoPort}/webdriver`)
        .withCapabilities({
            "kameleo:profileId": profile.id,
            "browserName": "Kameleo",
        });
    const webdriver = await builder.build();
    
    // Use any WebDriver command to drive the browser
    // and enjoy full protection from bot detection products
    await webdriver.get('https://google.com');

    The full example can be found here.

    Automate Kameleo profiles with Puppeteer (Chromium-based)

    Kameleo lets you control Chromium-based browsers (sorry Firefox fans) using the official Puppeteer library. In this simple example you can see how to connect to the browser that Kameleo starts.

    You need to import the official Puppeteer library.

    const puppeteer = require("puppeteer");   
    // Connect to the browser through CDP
    const browserWSEndpoint = `ws://localhost:${kameleoPort}/puppeteer/${profile.id}`;
    const browser = await puppeteer.connect({browserWSEndpoint, defaultViewport: null});
    const page = await browser.newPage();
    
    
    // Use any Puppeteer command to drive the browser
    // and enjoy full protection from bot detection products
    await page.goto('https://google.com');

    The full example can be found here.

    Automate Kameleo profiles with Playwright

    Kameleo allows you to control the browser with the official Playwright library. It works little bit different with Chromium-based browsers and Firefox, so we provide an example for both. Here we showcase how you can connect to the browser that is already started by Kameleo.

    You need to import the official Playwright library.

    const playwright = require('playwright');

    Chromium-based profiles with Playwright

    // Connect to the browser with Playwright through CDP
    const browserWSEndpoint = `ws://localhost:${kameleoPort}/playwright/${profile.id}`;
    const browser = await playwright.chromium.connectOverCDP(browserWSEndpoint);
    const context = browser.contexts()[0]; // It is recommended to work on the default context. New context will work in incognito mode without spoofing.
    const page = await context.newPage();
    
    // Use any Playwright command to drive the browser
    // and enjoy full protection from bot detection products
    await page.goto('https://google.com');

    The full example can be found here.

    Firefox-based profiles with Playwright

    // Connect to the browser with Playwright
    const browserWSEndpoint = `ws://localhost:${kameleoPort}/playwright/${profile.id}`;
    const browser = await playwright.firefox.launch({
        // The Playwright framework is not designed to connect to already running
        // browsers. To overcome this limitation, a tool bundled with Kameleo, named
        // pw-bridge.exe will bridge the communication gap between the running Firefox
        // instance and this playwright script.
        executablePath: '<PATH_TO_KAMELEO_FOLDER>\\pw-bridge.exe',
        args: [`-target ${browserWSEndpoint}`],
    });
    
    // Kameleo will open the a new page in the default browser context.
    // NOTE: We DO NOT recommend using multiple browser contexts, as this might interfere
    //       with Kameleo's browser fingerprint modification features.
    const page = await browser.newPage();
    
    // Use any Playwright command to drive the browser
    // and enjoy full protection from bot detection products
    await page.goto('https://google.com');

    The full example can be found here.

    Example codes

    Several examples have been prepared in a different repository to showcase the most interesting features. Feel free to create a pull request to add new example codes.

    • Finding base profiles
    • Creating profiles with custom options
    • Updating profiles with new settings
    • How to start a profile
    • Using Selenium with Local API
    • Using Playwright with Kameleo
    • Using Puppeteer with Kameleo
    • Adding an HTTP, SOCKS or SSH proxy to profile
    • Saving/Loading a browsing session to/from a .kameleo file
    • Modify and Delete browser cookies
    • Start profile with extra WebDriver capabilities

    Note: If you are interested in more information about Kameleo, or have encountered an issue with using it, please check out our Help Center.

    Endpoints

    Available API endpoints with exhaustive descriptions and example values are documented on this SwaggerHub page. This package has built-in IntelliSense support in Visual Studio Code, no extra package installation needed.

    License

    This project is released under MIT License. Please refer the LICENSE.txt for more details.

    Install

    npm i @kameleo/local-api-client

    Homepage

    kameleo.io

    DownloadsWeekly Downloads

    8

    Version

    2.6.0

    License

    MIT

    Unpacked Size

    699 kB

    Total Files

    56

    Last publish

    Collaborators

    • kameleo-team