Getting Started
Getting Your API Key
Go to the Scraping Browser control panel and get 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. In seconds (s), the default value is 180 seconds (3 minutes), customizable between 60 seconds (1 minute) and 900 seconds (15 minutes recommended maximum, but longer times are possible). Once the specified TTL is reached, the session will expire, and Scraping Browser will close the browser instance to release resources. |
| 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. |
| 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, timezone, 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 to completely avoid 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.