Scrape

POST /api/v1/scrape/

Creates a new scraping request and returns the result synchronously. HTTP 200 means the API request completed; check JSON status_code and errors for the target scrape result.

Required attributes

Parameter	Description
url	The URL to scrape

Optional attributes

Parameter	Description
method	HTTP method. Default: "GET"
headers	Custom request headers
proxy	Proxy type or config. Default: "datacenter"
scraper	Scraper identifier to force, or "auto". Default: "auto"
timeout_ms	Target request timeout in milliseconds
screenshot	Requests screenshot capture from supported browser-capable scrapers. When an artifact is produced, the response includes screenshot_url; otherwise the field is omitted.

Result status

ScrapeRouter separates API transport status from the target scrape result. Validation, authentication, credit, concurrency, and platform timeouts use HTTP 4xx/5xx. A completed scrape attempt returns HTTP 200, even when the target result is a block, timeout, or scraper error. Treat JSON status_code in the 200-399 range with no errors as a successful target scrape.

Advanced options

Prefer top-level normalized fields such as timeout_ms, wait_for_timeout_ms, and screenshot. Values inside scraper_options are scraper-native overrides; their names and units are defined by the selected scraper. For Playwright, native scraper_options.timeout is milliseconds.

#!/usr/bin/env bash
curl -X POST https://www.scraperouter.com/api/v1/scrape/ \
  -H "Authorization: Api-Key {your_api_key}" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com",
  "scraper": "auto",
  "proxy": "datacenter"
}'

import requests

response = requests.post(
    "https://www.scraperouter.com/api/v1/scrape/",
    headers={"Authorization": "Api-Key {your_api_key}"},
    json={
        "url": "https://example.com",
        "scraper": "auto",
        "proxy": "datacenter",
    },
)
data = response.json()

const response = await fetch("https://www.scraperouter.com/api/v1/scrape/", {
  method: "POST",
  headers: {
    "Authorization": "Api-Key {your_api_key}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    url: "https://example.com",
    scraper: "auto",
    proxy: "datacenter",
  }),
});

const data = await response.json();

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status_code": 200,
  "final_url": "https://example.com",
  "content": "<!doctype html>...",
  "content_encoding": "text",
  "headers": {
    "content-type": "text/html; charset=UTF-8"
  },
  "scraperouter": {
    "scraper": "apiritif/curl-cffi:0.16",
    "request_cost": null,
    "proxy_type": "datacenter"
  }
}