Skip to main content
POST
/
v1
/
scrape
Scrape URL
curl --request POST \
  --url https://qk.driver.dev/v1/scrape \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "url": "https://example.com",
  "output": "html",
  "smartdoor": {
    "nodes": [
      {
        "type": "hosted",
        "country": "US"
      }
    ],
    "timeout": 60000,
    "delay": 2500,
    "retryFresh": true,
    "retryCount": 2,
    "refreshWhile": {
      "expression": "document.body?.innerText?.includes('ERR_CONNECTION_RESET') || location.href.includes('/risk/challenge')",
      "maxRefreshes": 3,
      "minDelayMs": 700,
      "maxDelayMs": 1300
    }
  }
}
EOF
"<string>"

Authorizations

​
Authorization
string
header
required

Your Driver API key. Get one at https://app.driver.dev

Body

application/json
​
url
string<uri>
required

URL to scrape.

Example:

"https://example.com"

​
output
enum<string>

Response format. Defaults to html.

Available options:
html,
md
Example:

"html"

​
smartdoor
object

Browser rendering, waiting, retry, and node options for the scrape.

Response

Successfully scraped the URL. The response body is the scraped content.

The response is of type string.