Skip to main content
POST

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

Whether to route the request through a proxy. false never uses a proxy (default), auto tries without a proxy first and retries through one if the site blocks the request, true always uses a proxy.

Example:

true

​
proxyCountry
string

Proxy country code to route the request. Used when a proxy is active (proxyMode is auto or true).

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 (only used if format=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)

​
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 +6 credits on top of the base scraping cost.

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

​
meta
object
required

Metadata about the request

​
data
required

Scraped data (URL or inline content depending on output)

Example:

"https://example.com/9bulgk075ed9m3vhua5vcrp0.html"

​
aiResult
object

AI extraction/analysis result. Shape depends on aiPrompt.type. Omitted when aiPrompt was not provided.