Connect - Scrapeless API

Request

Authorization

Add parameter in header

x-api-token

Example:

x-api-token: ********************

Query Params

token

string

required

Example:

session_ttl

string

required

The session_ttl parameter controls the duration of the session and automatically closes the browser instance after the session times out. The unit of session_ttl is seconds (S), with a default value of 180 seconds (i.e., 3 minutes), and can be customized between 60 seconds (1 minute) and 900 seconds (15 minutes). When the specified TTL time is reached, the session will become invalid, and Scraping Browser will close the browser instance to release resources. Please set the session_ttl reasonably according to the task requirements to ensure that the operations are completed before the session times out.

Example:

180

session_name

string

optional

Set a name for your session to facilitate searching and viewing in the historical session list.

session_recording

boolean

optional

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.

Default:

false

proxy_url

string

optional

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

optional

The proxy_country parameter is used to set the target country of the proxy, making the request sent through the IP address of that region. You can customize the proxy source by specifying a country code for proxy_country (e.g., US for the United States, GB for the United Kingdom, ANY for any country). Scraping Browser will provide the corresponding IP address based on the specified country, which helps meet regional access restrictions or geographic positioning needs.

Example:

US

extension_ids

string

optional

setup browser extension by extension id, separate by comma for multiple extensions

fingerprint

string

optional

Custom browser fingerprint with URL encoded JSON string format, see below for full schema

Body Params application/json

fingerprint

object

optional

user_agent

string

optional

Defines the User-Agent string in the browser’s HTTP request header, containing key identifying information such as the browser engine, version number, and operating system. Websites use this value to identify the client environment, affecting content adaptation and functionality. Default value: Follows the browser

platform

string

optional

Specifies the return value of the JavaScript navigator.platform property, indicating the operating system type of the runtime environment. Optional values are “Windows”, “macOS”, or “Linux”. This parameter will be used for feature detection and the enabling judgment of system-related functions. Default value: Windows

screen

object

optional

Defines the physical characteristics parameters of the display device reported by the browser, directly mapped to the JavaScript window.screen object.

localization

object

optional

Example

{
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/135.1.2.3 Safari/537.36",
    "platform": "Windows",
    "screen": {
        "width": 1920,
        "height": 1080
    },
    "localization": {
        "based_on_ip": false,
        "timezone": "America/New_York",
        "languages": [
            "en"
        ]
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request WSS 'https://api.scrapeless.com/browser?token=&session_ttl=180&session_name&session_recording&proxy_url&proxy_country=US&extension_ids&fingerprint=' \
--header 'Content-Type: application/json' \
--header 'x-api-token;' \
--data-raw '{
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/135.1.2.3 Safari/537.36",
    "platform": "Windows",
    "screen": {
        "width": 1920,
        "height": 1080
    },
    "localization": {
        "based_on_ip": false,
        "timezone": "America/New_York",
        "languages": [
            "en"
        ]
    }
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}