readfetch_residential
Scrape pages through a residential IP to bypass targets that block datacenter addresses by reputation, such as DataDome, PerimeterX, Cloudflare, or AWS WAF.
Instructions
Identical request and response to /v1/scrape, but the render leaves through a residential address instead of the datacentre. For targets that block by IP reputation (DataDome, PerimeterX, Cloudflare, AWS WAF). One attempt, no retries: residential bandwidth is the cost, and four times the scrape price is what it takes to cover it honestly.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Public http(s) URL to load in Chromium. | |
| auth | No | Optional cookie, bearer, or basic auth for the page load. | |
| mode | No | Whole-call budget and render depth: fast (15 s), render (30 s, default), or full (60 s with page scroll). | render |
| fresh | No | When true, bypass cached scrape results (default false). | |
| format | No | Primary body field returned: markdown (default), plain text, or raw HTML. | markdown |
| options | No | Deprecated — use `advanced` instead (same ScrapeOptions shape). Scheduled for removal in a future API semver bump. | |
| advanced | No | Browser interactions: scroll, wait_for selector, js_code, headers, cookies, locale, include_links, etc. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | ||
| title | No | ||
| billed | No | ||
| status | No | ||
| markdown | No | ||
| status_code | No | ||
| cache_status | No |