A valid request URL is required to generate request examples{
"success": true,
"data": {
"url": "<string>",
"final_url": "<string>",
"status": 123,
"status_text": "<string>",
"title": "<string>",
"content_type": "<string>",
"metadata": {
"description": "<string>",
"language": "<string>",
"canonical_url": "<string>",
"og_title": "<string>",
"og_description": "<string>",
"og_image": "<string>"
},
"content": "<string>",
"raw_html": "<string>",
"markdown": "<string>",
"links": [
"<string>"
],
"screenshot": "<string>",
"cookies": [
{}
]
},
"msg": "<string>"
}{
"success": false,
"msg": "<string>",
"code": "<string>",
"data": "<unknown>",
"detail": "<unknown>",
"error": "<unknown>"
}{
"success": false,
"msg": "<string>",
"code": "<string>",
"data": "<unknown>",
"detail": "<unknown>",
"error": "<unknown>"
}{
"success": false,
"msg": "<string>",
"code": "<string>",
"data": "<unknown>",
"detail": "<unknown>",
"error": "<unknown>"
}{
"success": false,
"msg": "<string>",
"code": "<string>",
"data": "<unknown>",
"detail": "<unknown>",
"error": "<unknown>"
}{
"success": false,
"msg": "<string>",
"code": "<string>",
"data": "<unknown>",
"detail": "<unknown>",
"error": "<unknown>"
}{
"success": false,
"msg": "<string>",
"code": "<string>",
"data": "<unknown>",
"detail": "<unknown>",
"error": "<unknown>"
}Scrape
Scrape a page
Load one page in a browser that is already running and return it in the requested formats. The browser runs behind a residential proxy of your region with a desktop fingerprint, solves the challenge of a blocked page and keeps no cookies or storage between requests. One URL per request; on-demand plans only. A request is one session billed in 30-second steps. See Scraping API.
POST
/
scrape
A valid request URL is required to generate request examples{
"success": true,
"data": {
"url": "<string>",
"final_url": "<string>",
"status": 123,
"status_text": "<string>",
"title": "<string>",
"content_type": "<string>",
"metadata": {
"description": "<string>",
"language": "<string>",
"canonical_url": "<string>",
"og_title": "<string>",
"og_description": "<string>",
"og_image": "<string>"
},
"content": "<string>",
"raw_html": "<string>",
"markdown": "<string>",
"links": [
"<string>"
],
"screenshot": "<string>",
"cookies": [
{}
]
},
"msg": "<string>"
}{
"success": false,
"msg": "<string>",
"code": "<string>",
"data": "<unknown>",
"detail": "<unknown>",
"error": "<unknown>"
}{
"success": false,
"msg": "<string>",
"code": "<string>",
"data": "<unknown>",
"detail": "<unknown>",
"error": "<unknown>"
}{
"success": false,
"msg": "<string>",
"code": "<string>",
"data": "<unknown>",
"detail": "<unknown>",
"error": "<unknown>"
}{
"success": false,
"msg": "<string>",
"code": "<string>",
"data": "<unknown>",
"detail": "<unknown>",
"error": "<unknown>"
}{
"success": false,
"msg": "<string>",
"code": "<string>",
"data": "<unknown>",
"detail": "<unknown>",
"error": "<unknown>"
}{
"success": false,
"msg": "<string>",
"code": "<string>",
"data": "<unknown>",
"detail": "<unknown>",
"error": "<unknown>"
}Authorizations
API token from your dashboard.
Body
application/json
Page URL to visit.
What to return. html is cleaned, raw_html is the full rendered DOM, cookies is the jar after the scrape.
Available options:
html, raw_html, markdown, links, screenshot, cookies Strip navigation, footers and sidebars from html and markdown.
Shorthand for adding screenshot to formats.
Show child attributes
Show child attributes
Resource types not downloaded. Omitted: image, media and font, or nothing when a screenshot is requested. An empty list blocks nothing.
Available options:
image, media, font, stylesheet Cookies set before navigation: the JSON shape the cookies format returns, or Netscape text.
Extra wait in seconds after navigation.
Required range:
0 <= x <= 60Available options:
domcontentloaded, load, networkidle, commit CSS or XPath selector to wait for after navigation.
Navigation and selector timeout in milliseconds.
Solve the challenge of a page that answers 403, 405, 429 or 503. A solve adds 10 to 60 seconds and is charged at the plan's CAPTCHA price.
actions
(ClickAction · object | TypeAction · object | PressAction · object | ScrollAction · object | WaitAction · object)[]
Steps run on the loaded page with human emulation, in order. The first failure ends the request with action_failed.
Maximum array length:
10Move the mouse to the element and click it.
- ClickAction
- TypeAction
- PressAction
- ScrollAction
- WaitAction
Show child attributes
Show child attributes