Create a new scraping job

Create a new asynchronous scraping job with the specified targets and options

Authorization

ApiKeyAuth

X-Token<token>

In: header

Request Body

application/json

Job creation parameters

TypeScript Definitions

Use the request body type in TypeScript.

Targets*array<>

URLs to scrape

Method?string

HTTP method to use, possible values: GET, POST, PUT, PATCH, HEAD, DELETE

Default"GET"

Body?string

HTTP request body for POST requests

GeoCode?string

Country code for geo-targeting

Default""

RegionalGeoCode?string

Regional code for geo-targeting

Default""

Super?boolean

Use residential proxies

Defaultfalse

Headers?

Custom HTTP headers

ForwardHeaders?boolean

Use only provided headers. If false, all provided headers will be merged with the Scrape.do headers.

Defaultfalse

SessionID?string

Sticky session ID. If true, Scrape.do will try to reuse the same ip address for the same session ID.

Device?string

Device type to emulate, possible values: desktop, mobile, tablet

SetCookies?string

Cookies to include with the request. You can not use this together if any header is provided.

Timeout?integer

Total request timeout in milliseconds

RetryTimeout?integer

Retry timeout for per curl request in milliseconds. Not working with render=true

DisableRetry?boolean

Disable retry

Defaultfalse

TransparentResponse?boolean

Return transparent response

Defaultfalse

DisableRedirection?boolean

Disable following redirects

Defaultfalse

Output?string

Output format. You can get markdown output for LLM use. Possible values: raw, markdown

Default"raw"

Render?

Browser rendering options

Defaultfalse

WebhookURL?string

Webhook URL to send the response to

WebhookHeaders?

Additional headers to send with the webhook request

Response Body

`application/json`

curl -X POST "https://q.scrape.do/api/v1/jobs" \  -H "Content-Type: application/json" \  -d '{    "Targets": [      "https://httpbin.co/anything"    ]  }'

{
  "JobID": "string",
  "Message": "string",
  "TaskIDs": [
    "string"
  ]
}

{
  "Error": "string",
  "Code": 0
}

{
  "Error": "string",
  "Code": 0
}

{
  "Error": "string",
  "Code": 0
}

{
  "Error": "string",
  "Code": 0
}

Meet with Scraping Pros

No sales fluff. Real engineers helping you solve data needs at scale.

Create a new scraping job

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

429application/json

500application/json

Meet with Scraping Pros

+10B Requests Every Month

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

+10B Requests
Every Month