Scrapivore
Docs menuScrape a URL
Scraping

Scrape a URL

POST/api/scrape/

Fetches one URL through the proxy pool. The engine races race_width proxies and returns the first good response. If they all fail, another round runs with new proxies.

Body parameters

Parameter
Description
url required
Full URL including http:// or https://.
source string · default auto
auto, proxydocker, webshare, byop or direct. See Proxy pools.
method string · default GET
HTTP method sent to the target. Send a body with body_json, body_form or body_raw.
headers object
Sent to the target as-is.
cookies string
Cookie header format: k1=v1; k2=v2.
country string
Two-letter code such as fr. Webshare and your own proxies only.
asn string
Proxy network (ASN), as listed by GET /api/webshare/. Webshare only.
race_width int · default 3
Proxies tried in parallel per round, 1–10.
max_rounds int · default 2
Rounds before giving up, 1–5.
timeout int · default 20
Read timeout per attempt in seconds, 2–60.
connect_timeout int
Connect timeout per attempt. Defaults to timeout. A short value (e.g. 6) drops dead proxies faster.
session_key string
Keep the same proxy for 10 minutes. See Sticky sessions.
selection string · default sample
sample spreads load across good proxies. best takes the top-ranked proxies in score order and ignores cooldowns, which is useful for testing.
success_statuses int[]
Extra status codes to treat as success, e.g. [404] for an API that returns 404 for "not found".
backend string · default requests
HTTP client: requests, cloudscraper or curl_cffi (browser-like TLS fingerprint).
ua_rotate string · default random
User-agent strategy: fixed, random, sticky_per_proxy or sticky_per_session.
tags string[]
Labels for your own stats, up to 10.

Response

A valid call returns HTTP 200 whether or not the request succeeded. The status field in the body is the target site's status code (on a failure, from the last attempt).

Check success. On failure you get error and the number of attempts, and the request is not counted against your usage. The API's own error codes are in Errors and limits.