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>",
"challenge": {
"kind": "challenge_page",
"captcha": "<string>",
"solved": true,
"cost": "<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>"
}Profiles
Scrape page
Navigate a browser you started and return the page in the requested formats. Send one body or a sequential batch; the pages share the browser’s cookies. Check each batch item and the target website’s status. Avoid concurrent CDP work in this browser: the scraper reuses a page and closes extra pages. The gateway waits up to 120 seconds for the whole batch. See Scraping API.
POST
/
profiles
/
{internal_uuid}
/
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>",
"challenge": {
"kind": "challenge_page",
"captcha": "<string>",
"solved": true,
"cost": "<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>"
}Authorizations
API token from your dashboard.
Path Parameters
Body
application/json
- object
- object[]
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 Drop page chrome from html and markdown: header, nav, footer and aside elements, plus blocks whose class or id names a sidebar, menu, breadcrumb, cookie banner, modal, ad or share widget. A block that holds #main stays.
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.
Pass every challenge page and solve every captcha the page shows, paid types included; each solve adds 10 to 60 seconds and is a captcha charge whatever its outcome. False solves nothing and reports what stood in the way in challenge.
actions
(ClickAction · object | TypeAction · object | PressAction · object | ScrollAction · object | WaitAction · object | SolveAction · 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
- SolveAction
Show child attributes
Show child attributes