Web Scraping

Authorizations

x-api-key

string

header

required

API Key required for all endpoints

Body

application/json

url

string

required

Target URL

Example:

"https://example.com"

device

enum<string>

default:desktop

Device type to emulate. Defaults to desktop.

Available options:

desktop,

mobile

Example:

"desktop"

blockAds

boolean

default:true

Whether to block ads

Example:

true

renderJS

boolean

Whether to render JavaScript. If omitted, rendering is automatic: the page is fetched without a browser first, and JavaScript is only rendered if the page needs it. Set explicitly to true or false to force rendering on or off.

proxyMode

default:false

Controls when a proxy is used. false doesn't use a proxy (default), auto tries without a proxy first and retries through one if the site blocks the request, true always uses a proxy. proxyMode is optional — to route through a proxy in a specific country, you can set proxyCountry on its own.

Example:

true

proxyCountry

string

Country code (ISO alpha-2) to route the request through a proxy in. Can be used on its own — proxyMode is not required. Combine it with proxyMode if you want control over when the proxy is used.

Example:

"us"

format

enum<string>[]

Format(s) of the scraped result. Comma-separated or array. Defaults to html-llm. markdown is recommended for most use cases.

Available options:

html,

markdown,

json,

markdown-llm,

html-llm,

text,

text-llm

Example:

"markdown,json"

fileOutput

boolean

default:false

Whether to get response in file format

Example:

false

stealth

boolean

default:false

Enable stealth mode to bypass basic bot detection (removes webdriver signals, patches navigator properties)

Example:

false

waitTime

number

default:0

Seconds to wait after page load before capturing content. Helps bypass lazy-loaded content and bot checks.

Example:

2.5

extractionMode

enum<string>

default:default

Extraction mode. JSON output is used automatically when an extraction mode is requested — you don't need to set format to json. Set to template to use a ready-made extraction template instead of a custom schema — see the template field.

Available options:

default,

cssSchema,

xpathSchema,

template

Example:

"default"

template

string

Extraction template to use when extractionMode is template (ignored otherwise, and has no effect unless extractionMode is set to template). Accepts product (extracts product info: title, brand, pricing, availability, images, ratings) or contact (extracts contact info: company, locations, emails, phones, social profiles).

extractionSchema

object

Extraction schema (optional in default mode, required in css/xpath)

Show child attributes

aiPrompt

object

Ask AI to extract or analyze the scraped page. Always runs against the Markdown of the page regardless of the format field. Adds +7 credits on top of the base scraping cost.

Show child attributes

Response

Successfully scraped webpage

timestamp

number

required

Timestamp of the request in milliseconds

Example:

1788851167291

apiStatus

enum<string>

required

API status message

Available options:

success,

failure

Example:

"success"

apiCode

number

required

API status code

Example:

200

Getting started

Endpoint

Authorizations

Body

Response