Service usage
‘s browser service navigates intelligently on your behalf, rendering JavaScript, solving captchas, and retrying failed requests. The service has a RESTful interface that acceptsGET requests at
https:///browser and a
Chrome DevTools Protocol (CDP) interface for controlling browser navigation
yourself that accepts WebSocket connections at wss:///browser.
Webpages can be localized with geotargeting parameters. Those
requested via REST are retrieved in real time by default or optionally queued for subsequent retrieval. Up to 3 minutes is allotted per real-time API
call to accommodate captcha-solving, multiple retries, and other mitigations. Usage data is published regularly.
Authentication
You can access the service by including your secret API token in anAuthorization header:
REST parameters
Besides the geotargeting and scheduling params linked above, required and optional REST params can be added in a standard query string. See our rate card for the prices of premium params. The keys and values supports are as follows:CDP interaction
If your use case involves interacting with not just reading pages, you can connect Puppeteer, Playwright, or another CDP-compatible automation framework to the browser service:View Playwright sample
View Playwright sample
difficulty, device, and session:
browser.disconnect() (Puppeteer), browser.close() (Playwright), or the equivalent.
Protocol mixture
You can control costs by mixing REST requests and CDP use within a sticky browser session. E.g., you may want to prepare a page for interaction over REST then interact with the page over CDP:View REST-to-CDP sample
View REST-to-CDP sample
Device emulation
Thedevice param lets you browse device-specific content, rather than the default desktop content.
For a list of supported smartphone and tablet devices, make a request with your API token and no
params to https:///browser/devices:
Response format
Read-only pages are returned as rendered HTML, raw (unrendered) HTML, or Markdown optimized for LLM prompts.Additional examples
Cachebusting
End-to-end Playwright
View end-to-end sample
View end-to-end sample