Scrape a single URL

Request

Authorization

Add parameter in header

x-api-token

Example:

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

Body Params application/json

url

string <uri>

required

The URL to scrape

formats

array[string]

optional

Formats to include in the output.

Allowed values:

markdownhtmlrawHtmllinksscreenshotscreenshot@fullPagejson

Default:

markdown

onlyMainContent

boolean

optional

Only return the main content of the page excluding headers, navs, footers, etc.

Default:

true

includeTags

array[string]

optional

Tags to include in the output.

excludeTags

array[string]

optional

Tags to exclude from the output.

headers

object

optional

Headers to send with the request. Can be used to send cookies, user-agent, etc.

waitFor

integer

optional

Specify a delay in milliseconds before fetching the content, allowing the page sufficient time to load.

Default:

timeout

integer

optional

Timeout in milliseconds for the request

Default:

30000

browserOptions

object

BrowserOptions

optional

session_name

string

optional

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

session_ttl

string

optional

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_recording

string

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. Defaults to false.

proxy_country

string

optional

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.

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.

fingerprint

string

optional

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

{
    "url": "http://example.com",
    "formats": [
        "markdown"
    ],
    "onlyMainContent": true,
    "includeTags": [
        "string"
    ],
    "excludeTags": [
        "string"
    ],
    "headers": {},
    "waitFor": 0,
    "timeout": 30000,
    "browserOptions": {
        "session_name": "string",
        "session_ttl": "string",
        "session_recording": "string",
        "proxy_country": "string",
        "proxy_url": "string",
        "fingerprint": "string"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Request

Request samples

Responses