POST
/
v1
/
scrape
{
  "url": "https://example.com",
  "options": {
    "timeout": 30000,
    "wait_for_selector": "#main-content",
    "actions": [
      {
        "type": "scroll",
        "duration": 1000
      },
      {
        "type": "click",
        "selector": ".load-more"
      }
    ]
  }
}

{
  "success": true,
  "data": {
    "url": "https://example.com",
    "content": "Extracted content...",
    "metadata": {
      "timestamp": "2024-03-19T12:00:00Z"
    }
  }
}
The Scrape endpoint allows you to extract structured data from a single URL with advanced options.

​
Authentication

​
Authorization
string
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

​
Body Parameters

​
url
string
required
The URL to scrape. Must be a valid URI with maximum length of 2083 characters.
​
options
object

​
Response

​
success
boolean
Indicates if the scrape was successful
​
data
object
The scraped data from the webpage

​
Error Responses

​
error
object
{
  "url": "https://example.com",
  "options": {
    "timeout": 30000,
    "wait_for_selector": "#main-content",
    "actions": [
      {
        "type": "scroll",
        "duration": 1000
      },
      {
        "type": "click",
        "selector": ".load-more"
      }
    ]
  }
}

{
  "success": true,
  "data": {
    "url": "https://example.com",
    "content": "Extracted content...",
    "metadata": {
      "timestamp": "2024-03-19T12:00:00Z"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Response

200
application/json

Successful Response

The response is of type object.