Getting Started
Obtain Your API Key
Access the Scraping Browser control panel and obtain your API key in the settings tab. We will use this API key in the following steps.
Parameters
| Parameter Name | Type | Description |
|---|---|---|
| token | string | The API key generated in the control panel. |
| session_ttl | number | Controls the session duration and automatically closes the browser instance after timeout. Measured in seconds (s), defaults to 180 seconds (3 minutes), customizable between 60 seconds (1 minute) and 900 seconds (recommended maximum 15 minutes, but longer times can be set). Once the specified TTL is reached, the session will expire and Scraping Browser will close the browser instance to free resources. |
| session_name | string | Set a name for your session to facilitate searching and viewing in the historical session list. |
| session_recording | boolean | Whether to enable session recording. When enabled, the entire browser session execution process will be automatically recorded, and after the session is completed, it can be replayed and viewed in the historical session list details. Defaults to false. |
| proxy_url | string | Used to set the browser’s proxy URL, for example: http://user:pass@ip:port. If this parameter is set, all other proxy_* parameters will be ignored.- 💡Custom proxy functionality is currently only available to Enterprise and Enterprise Enhanced subscription users Upgrade Now - 💡Enterprise-level custom users can contact us to use custom proxies. |
| proxy_country | string | Sets the target country/region for the proxy, sending requests via an IP address from that region. You can specify a country code (e.g., US for the United States, GB for the United Kingdom, ANY for any country). See country codes for all supported options. |
| fingerprint | string | A browser fingerprint is a nearly unique “digital fingerprint” created using your browser and device configuration information, which can be used to track your online activity even without cookies. Fortunately, configuring fingerprints in Scraping Browser is optional. We offer deep customization of browser fingerprints, such as core parameters like browser user agent, time zone, language, and screen resolution, and support extending functionality through custom launch parameters. Suitable for multi-account management, data collection, and privacy protection scenarios, using scrapeless’s own Chromium browser completely avoids detection. By default, our Scraping Browser service generates a random fingerprint for each session. Reference |
Example of a complete Scraping Browser WebSocket connection URL:
wss://browser.scrapeless.com/browser?token=APIKey&session_ttl=180&proxy_country=ANYwss://browser.scrapeless.com/browser?token=APIKey&session_ttl=180&proxy_url=proxy_urlNote: When proxy_url is specified, it takes precedence, and other proxy-related parameters (proxy_country) will be ignored.