Getting Started
Obtain an API Key
Go to the Scraping Browser dashboard and obtain your API Key from the settings tab. We will use this API Key in the subsequent steps.
Parameters
| Parameter | Type | Description |
|---|---|---|
| token | string | The API Key generated in the dashboard. |
| session_ttl | number | Controls the duration of the session and automatically closes the browser instance after timeout. Measured in seconds(S), default value is 180 seconds(3 minutes), can be customized between 60 seconds(1 minute) to 900 seconds(15 minutes). When 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 proxy URL for the browser, eg:http://user:pass@ip:port. If this parameter is set, all other proxy_* parameters will be ignored |
| proxy_country | string | Sets the target country for the proxy, making requests through IP addresses from that region. You can specify country codes (e.g., US for United States, GB for Great Britain, ANY for any country). See Country Codes for all supported options. |
Complete Scraping browser WebSocket connection URL examples:
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.