$npx -y skills add oxylabs/agent-skills --skill headless-browserConnects to Oxylabs remote headless browsers via Chrome DevTools Protocol (CDP) using Playwright or Puppeteer. Provides anti-detection, CAPTCHA handling, residential proxies, and geo-targeting built in. Use when browser automation needs remote execution, stealth capabilities, ren
| 1 | # Oxylabs Headless Browser |
| 2 | |
| 3 | Remote headless browser service with built-in anti-detection and proxy integration. Chrome supports Playwright, Puppeteer, and any CDP-compatible library. Firefox is legacy and uses Playwright's Firefox connection API. |
| 4 | |
| 5 | ## Environment Variables |
| 6 | |
| 7 | Prefer `OXY_UNBLOCKER_USERNAME` and `OXY_UNBLOCKER_PASSWORD` for Headless Browser credentials. `OXY_HB_USERNAME` and `OXY_HB_PASSWORD` are supported aliases in older setups. |
| 8 | |
| 9 | ## Connection URLs |
| 10 | |
| 11 | | Browser | Global endpoint | US endpoint | |
| 12 | |---------|-----------------|-------------| |
| 13 | | Chrome | `wss://USERNAME:PASSWORD@ubc.oxylabs.io` | `wss://USERNAME:PASSWORD@ubc-us.oxylabs.io` | |
| 14 | | Firefox (legacy) | `wss://USERNAME:PASSWORD@ubs.oxylabs.io` | `wss://USERNAME:PASSWORD@ubs-us.oxylabs.io` | |
| 15 | |
| 16 | ## Browser Types |
| 17 | |
| 18 | | Type | Best For | Notes | |
| 19 | |------|----------|-------| |
| 20 | | **Chrome** | High performance, dedicated servers, residential proxies | Use `chromium.connect_over_cdp` / `connectOverCDP` | |
| 21 | | **Firefox (legacy)** | Alternative engine for targets that perform better outside Chrome | Use `firefox.connect`; supported Playwright versions are 1.51 and 1.56 via `?o_pw=1.56` | |
| 22 | |
| 23 | ## Quick Start |
| 24 | |
| 25 | **Playwright (Python):** |
| 26 | ```python |
| 27 | from playwright.sync_api import sync_playwright |
| 28 | import os |
| 29 | |
| 30 | username = os.environ.get("OXY_UNBLOCKER_USERNAME") or os.environ["OXY_HB_USERNAME"] |
| 31 | password = os.environ.get("OXY_UNBLOCKER_PASSWORD") or os.environ["OXY_HB_PASSWORD"] |
| 32 | endpoint = "ubc.oxylabs.io" |
| 33 | |
| 34 | with sync_playwright() as p: |
| 35 | browser = p.chromium.connect_over_cdp( |
| 36 | f"wss://{username}:{password}@{endpoint}" |
| 37 | ) |
| 38 | page = browser.new_page() |
| 39 | page.goto("https://example.com") |
| 40 | print(page.content()) |
| 41 | browser.close() |
| 42 | ``` |
| 43 | |
| 44 | **Playwright (JavaScript):** |
| 45 | ```javascript |
| 46 | const { chromium } = require("playwright"); |
| 47 | |
| 48 | const username = process.env.OXY_UNBLOCKER_USERNAME || process.env.OXY_HB_USERNAME; |
| 49 | const password = process.env.OXY_UNBLOCKER_PASSWORD || process.env.OXY_HB_PASSWORD; |
| 50 | const endpoint = "ubc.oxylabs.io"; |
| 51 | |
| 52 | (async () => { |
| 53 | const browser = await chromium.connectOverCDP( |
| 54 | `wss://${username}:${password}@${endpoint}` |
| 55 | ); |
| 56 | const page = await browser.newPage(); |
| 57 | await page.goto("https://example.com"); |
| 58 | console.log(await page.content()); |
| 59 | await browser.close(); |
| 60 | })(); |
| 61 | ``` |
| 62 | |
| 63 | **Puppeteer:** |
| 64 | ```javascript |
| 65 | const puppeteer = require("puppeteer"); |
| 66 | |
| 67 | const username = process.env.OXY_UNBLOCKER_USERNAME || process.env.OXY_HB_USERNAME; |
| 68 | const password = process.env.OXY_UNBLOCKER_PASSWORD || process.env.OXY_HB_PASSWORD; |
| 69 | const endpoint = "ubc.oxylabs.io"; |
| 70 | |
| 71 | (async () => { |
| 72 | const browser = await puppeteer.connect({ |
| 73 | browserWSEndpoint: `wss://${username}:${password}@${endpoint}` |
| 74 | }); |
| 75 | const page = await browser.newPage(); |
| 76 | await page.goto("https://example.com"); |
| 77 | console.log(await page.content()); |
| 78 | await browser.close(); |
| 79 | })(); |
| 80 | ``` |
| 81 | |
| 82 | ## Rate Limits |
| 83 | |
| 84 | - **Concurrent sessions:** 100 per browser type |
| 85 | - **Launch rate:** up to 10 sessions per second per browser type |
| 86 | - **Higher limits:** Available upon request to support |
| 87 | |
| 88 | ## Features |
| 89 | |
| 90 | - **Anti-detection:** Built-in fingerprint management |
| 91 | - **Residential proxies:** Automatic proxy rotation |
| 92 | - **Geo-targeting:** Country, city, and US state targeting via connection parameters |
| 93 | - **US endpoints:** Lower latency for US-based users; not the same as proxy geolocation |
| 94 | - **CAPTCHA handling:** Automatic load-time solving; manual trigger available with `window.postMessage({action: 'solve_captcha', type: '<captcha type>'}, '*')` |
| 95 | - **Session inspection:** Enable VNC debugging with `o_vnc=true` |
| 96 | - **No local browsers:** All execution happens remotely |
| 97 | |
| 98 | ## Connection Parameters |
| 99 | |
| 100 | Append query parameters to the WebSocket URL: |
| 101 | |
| 102 | | Parameter | Browser | Description | |
| 103 | |-----------|---------|-------------| |
| 104 | | `p_cc=US` | Chrome, Firefox | Route traffic through a 2-letter country code | |
| 105 | | `p_city=los_angeles` | Chrome, Firefox | Target a city; combine with `p_cc` or `p_state` | |
| 106 | | `p_state=texas` | Chrome, Firefox | Target a US state; takes priority over `p_cc` | |
| 107 | | `p_device=mobile` | Chrome | Emulate `desktop`, `mobile`, or `tablet` device fingerprints | |
| 108 | | `o_vnc=true` | Chrome, Firefox | Enable Session Inspection for visual debugging | |
| 109 | | `o_pw=1.56` | Firefox | Select supported Firefox Playwright version `1.51` or `1.56` | |
| 110 | | `bargs=disable-notifications` | Chrome | Pass supported Chrome browser arguments | |
| 111 | |
| 112 | Supported Chrome `bargs` values: `force-color-profile:<profile>`, `window-position:X,Y`, `hide-scrollbars`, `enable-features:<feature1>,<feature2>`, `disable-notifications`. |
| 113 | |
| 114 | Repeat `bargs` for multiple browser arguments, e.g., `?bargs=force-color |