---
name: orthogonal-scrapfly
description: "Call Scrapfly through Orthogonal's pay-per-use Run API: Web scraping API: scrape any URL with anti-bot bypass (Unblocker), datacenter or residential proxies, JavaScript rendering, screenshots and AI or template data extraction, plus block detection, page screenshots and whole-site crawls with search and question answering over crawled pages."
---

# Scrapfly — Orthogonal API

> Pay-per-use API on Orthogonal. Each call is billed to your Orthogonal balance.
> Base API: `https://api.orthogonal.com/v1/run` · [llms.txt](https://www.orthogonal.com/llms.txt) · [browse all APIs](https://www.orthogonal.com/catalog)

Web scraping API: scrape any URL with anti-bot bypass (Unblocker), datacenter or residential proxies, JavaScript rendering, screenshots and AI or template data extraction, plus block detection, page screenshots and whole-site crawls with search and question answering over crawled pages.

**Verified:** no

## Access

**Run API:** `POST https://api.orthogonal.com/v1/run`
**Auth:** `Authorization: Bearer $ORTHOGONAL_API_KEY`
Get an API key at https://www.orthogonal.com/account/keys

No account or key yet? Set up Orthogonal first with https://www.orthogonal.com/skill.md: it covers the CLI, the MCP server, the TypeScript SDK and sign-up, including an agent sign-up without a password (https://www.orthogonal.com/agent-signup.md).

Every call goes through the unified Run API: send the API `slug`, the endpoint `path`, and the `query`/`body` parameters. The response is `{ "success": true, "priceCents": <US cents>, "requestId": "...", "data": { ... } }`.

Quote first, free: the same request with `"dryRun": true` returns the price without calling the API or charging anything. On a retry after a timeout, send the same `Idempotency-Key` header so the call runs and bills once.

## Endpoints

### Web page scrape

Scrapfly Scrape API (GET): fetches the target URL with the GET method through Scrapfly's proxies, with optional anti-bot bypass (Unblocker), JavaScript rendering, screenshots and data extraction; returns the page content in result.content with config and context metadata as JSON.

`GET /scrape`

**Estimated cost:** from $0.000164 per call (required params only), up to $0.1635; use `"dryRun": true` in the Run API request to check the exact cost before calling.

**Page:** https://www.orthogonal.com/api/scrapfly/d39a336f-0b30-4e0c-ac8e-1d7f52c1047d

**Docs:** https://scrapfly.io/docs/scrape-api/getting-started

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Target URL to scrape. Must be URL encoded. |
| `proxy_pool` | string | No | Proxy pool. public_datacenter_pool (1 credit) or public_residential_pool (25 credits). |
| `country` | string | No | Proxy country (ISO 3166-1 alpha-2). Supports exclusions (-gb), lists (us,ca,mx) and weights (us:10,gb:5). |
| `lang` | string | No | Page language (sets Accept-Language). Defaults to the proxy location language. |
| `os` | string | No | Operating system persona. Cannot be set with a custom User-Agent header. |
| `browser_brand` | string | No | Chromium browser brand for the fingerprint (with render_js=true). |
| `headers` | string | No | Custom HTTP headers, sent as headers[name]=url-encoded-value. |
| `timeout` | integer | No | Timeout in milliseconds. |
| `retry` | boolean | No | Retry on failure (network errors, HTTP 5xx). |
| `format` | string | No | Output format: raw, clean_html, json, markdown, text. Markdown/text accept :no_links,no_images,only_content options. |
| `proxified_response` | boolean | No | Return the scraped content directly as the response body instead of the JSON wrapper. |
| `debug` | boolean | No | Store the API result and take a screenshot (if render_js enabled). |
| `correlation_id` | string | No | Helper ID for grouping scrapes. |
| `tags` | string | No | Tags for grouping scrapes, sent as tags[]=value. |
| `dns` | boolean | No | Query and return target DNS information. |
| `ssl` | boolean | No | Pull the remote SSL certificate and TLS info (https targets only). |
| `extraction_template` | string | No | Extraction template for structured data: ephemeral:base64(json_template). Adds 1 credit. |
| `extraction_prompt` | string | No | LLM instruction to extract data or ask questions about the page. URL encoded. Adds 5 credits. |
| `extraction_model` | string | No | AI auto-extraction model for structured data. Adds 5 credits. |
| `unblocker` | boolean | No | Enable Unblocker (formerly ASP) to bypass anti-bot protection. It may upgrade the proxy pool and browser, which raises the cost. |
| `asp` | boolean | No | Legacy name of unblocker. When both are sent, asp wins. |
| `cost_budget` | integer | No | Maximum credits Unblocker may spend on this request. |
| `render_js` | boolean | No | Render the page in a headless browser to execute JavaScript (+5 credits). |
| `rendering_wait` | integer | No | Delay in milliseconds after page load (render_js only). |
| `wait_for_selector` | string | No | Wait until a CSS/XPath selector or xhr: pattern is visible (render_js only). |
| `js` | string | No | JavaScript to execute, base64 encoded, max 16KB (render_js only). |
| `screenshots` | string | No | Screenshots to capture, sent as screenshots[name]=fullpage or a selector (render_js only). |
| `screenshot_flags` | string | No | Screenshot options: load_images, dark_mode, block_banners, high_quality, print_media_format. |
| `js_scenario` | string | No | Base64-encoded JSON scenario of page actions (click, fill, wait, scroll...). |
| `geolocation` | string | No | Spoof browser geolocation as latitude,longitude. |
| `auto_scroll` | boolean | No | Auto-scroll to the bottom to trigger lazy-loaded content. |
| `rendering_stage` | string | No | Page load stage to wait for. |
| `cache` | boolean | No | Enable caching: returns cached content on a hit, otherwise scrapes and caches. |
| `cache_ttl` | integer | No | Cache time-to-live in seconds. |
| `cache_clear` | boolean | No | Force cache refresh on this request. |

```bash
curl -X POST 'https://api.orthogonal.com/v1/run' \
  -H 'Authorization: Bearer $ORTHOGONAL_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"api":"scrapfly","path":"/scrape","method":"GET","query":{"url":"<string>","proxy_pool":"<string>","country":"<string>","lang":"<string>","os":"<string>","browser_brand":"<string>","headers":"<string>","timeout":"<integer>","retry":"<boolean>","format":"<string>","proxified_response":"<boolean>","debug":"<boolean>","correlation_id":"<string>","tags":"<string>","dns":"<boolean>","ssl":"<boolean>","extraction_template":"<string>","extraction_prompt":"<string>","extraction_model":"<string>","unblocker":"<boolean>","asp":"<boolean>","cost_budget":"<integer>","render_js":"<boolean>","rendering_wait":"<integer>","wait_for_selector":"<string>","js":"<string>","screenshots":"<string>","screenshot_flags":"<string>","js_scenario":"<string>","geolocation":"<string>","auto_scroll":"<boolean>","rendering_stage":"<string>","cache":"<boolean>","cache_ttl":"<integer>","cache_clear":"<boolean>"}}'
```

### Web scrape with POST body

Scrapfly Scrape API (POST): fetches the target URL with the POST method through Scrapfly's proxies, with optional anti-bot bypass (Unblocker), JavaScript rendering, screenshots and data extraction; returns the page content in result.content with config and context metadata as JSON. Any request body is forwarded to the target.

`POST /scrape`

**Estimated cost:** from $0.000164 per call (required params only), up to $0.1635; use `"dryRun": true` in the Run API request to check the exact cost before calling.

**Page:** https://www.orthogonal.com/api/scrapfly/94d108d1-c0f7-41b2-ae92-d1d42de851de

**Docs:** https://scrapfly.io/docs/scrape-api/getting-started

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Target URL to scrape. Must be URL encoded. |
| `proxy_pool` | string | No | Proxy pool. public_datacenter_pool (1 credit) or public_residential_pool (25 credits). |
| `country` | string | No | Proxy country (ISO 3166-1 alpha-2). Supports exclusions (-gb), lists (us,ca,mx) and weights (us:10,gb:5). |
| `lang` | string | No | Page language (sets Accept-Language). Defaults to the proxy location language. |
| `os` | string | No | Operating system persona. Cannot be set with a custom User-Agent header. |
| `browser_brand` | string | No | Chromium browser brand for the fingerprint (with render_js=true). |
| `headers` | string | No | Custom HTTP headers, sent as headers[name]=url-encoded-value. |
| `timeout` | integer | No | Timeout in milliseconds. |
| `retry` | boolean | No | Retry on failure (network errors, HTTP 5xx). |
| `format` | string | No | Output format: raw, clean_html, json, markdown, text. Markdown/text accept :no_links,no_images,only_content options. |
| `proxified_response` | boolean | No | Return the scraped content directly as the response body instead of the JSON wrapper. |
| `debug` | boolean | No | Store the API result and take a screenshot (if render_js enabled). |
| `correlation_id` | string | No | Helper ID for grouping scrapes. |
| `tags` | string | No | Tags for grouping scrapes, sent as tags[]=value. |
| `dns` | boolean | No | Query and return target DNS information. |
| `ssl` | boolean | No | Pull the remote SSL certificate and TLS info (https targets only). |
| `extraction_template` | string | No | Extraction template for structured data: ephemeral:base64(json_template). Adds 1 credit. |
| `extraction_prompt` | string | No | LLM instruction to extract data or ask questions about the page. URL encoded. Adds 5 credits. |
| `extraction_model` | string | No | AI auto-extraction model for structured data. Adds 5 credits. |
| `unblocker` | boolean | No | Enable Unblocker (formerly ASP) to bypass anti-bot protection. It may upgrade the proxy pool and browser, which raises the cost. |
| `asp` | boolean | No | Legacy name of unblocker. When both are sent, asp wins. |
| `cost_budget` | integer | No | Maximum credits Unblocker may spend on this request. |
| `render_js` | boolean | No | Render the page in a headless browser to execute JavaScript (+5 credits). |
| `rendering_wait` | integer | No | Delay in milliseconds after page load (render_js only). |
| `wait_for_selector` | string | No | Wait until a CSS/XPath selector or xhr: pattern is visible (render_js only). |
| `js` | string | No | JavaScript to execute, base64 encoded, max 16KB (render_js only). |
| `screenshots` | string | No | Screenshots to capture, sent as screenshots[name]=fullpage or a selector (render_js only). |
| `screenshot_flags` | string | No | Screenshot options: load_images, dark_mode, block_banners, high_quality, print_media_format. |
| `js_scenario` | string | No | Base64-encoded JSON scenario of page actions (click, fill, wait, scroll...). |
| `geolocation` | string | No | Spoof browser geolocation as latitude,longitude. |
| `auto_scroll` | boolean | No | Auto-scroll to the bottom to trigger lazy-loaded content. |
| `rendering_stage` | string | No | Page load stage to wait for. |
| `cache` | boolean | No | Enable caching: returns cached content on a hit, otherwise scrapes and caches. |
| `cache_ttl` | integer | No | Cache time-to-live in seconds. |
| `cache_clear` | boolean | No | Force cache refresh on this request. |

```bash
curl -X POST 'https://api.orthogonal.com/v1/run' \
  -H 'Authorization: Bearer $ORTHOGONAL_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"api":"scrapfly","path":"/scrape","query":{"url":"<string>","proxy_pool":"<string>","country":"<string>","lang":"<string>","os":"<string>","browser_brand":"<string>","headers":"<string>","timeout":"<integer>","retry":"<boolean>","format":"<string>","proxified_response":"<boolean>","debug":"<boolean>","correlation_id":"<string>","tags":"<string>","dns":"<boolean>","ssl":"<boolean>","extraction_template":"<string>","extraction_prompt":"<string>","extraction_model":"<string>","unblocker":"<boolean>","asp":"<boolean>","cost_budget":"<integer>","render_js":"<boolean>","rendering_wait":"<integer>","wait_for_selector":"<string>","js":"<string>","screenshots":"<string>","screenshot_flags":"<string>","js_scenario":"<string>","geolocation":"<string>","auto_scroll":"<boolean>","rendering_stage":"<string>","cache":"<boolean>","cache_ttl":"<integer>","cache_clear":"<boolean>"}}'
```

### Web scrape with PUT body

Scrapfly Scrape API (PUT): fetches the target URL with the PUT method through Scrapfly's proxies, with optional anti-bot bypass (Unblocker), JavaScript rendering, screenshots and data extraction; returns the page content in result.content with config and context metadata as JSON. Any request body is forwarded to the target.

`PUT /scrape`

**Estimated cost:** from $0.000164 per call (required params only), up to $0.1635; use `"dryRun": true` in the Run API request to check the exact cost before calling.

**Page:** https://www.orthogonal.com/api/scrapfly/d7afb219-b06d-4563-a761-cefc8e72ae2d

**Docs:** https://scrapfly.io/docs/scrape-api/getting-started

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Target URL to scrape. Must be URL encoded. |
| `proxy_pool` | string | No | Proxy pool. public_datacenter_pool (1 credit) or public_residential_pool (25 credits). |
| `country` | string | No | Proxy country (ISO 3166-1 alpha-2). Supports exclusions (-gb), lists (us,ca,mx) and weights (us:10,gb:5). |
| `lang` | string | No | Page language (sets Accept-Language). Defaults to the proxy location language. |
| `os` | string | No | Operating system persona. Cannot be set with a custom User-Agent header. |
| `browser_brand` | string | No | Chromium browser brand for the fingerprint (with render_js=true). |
| `headers` | string | No | Custom HTTP headers, sent as headers[name]=url-encoded-value. |
| `timeout` | integer | No | Timeout in milliseconds. |
| `retry` | boolean | No | Retry on failure (network errors, HTTP 5xx). |
| `format` | string | No | Output format: raw, clean_html, json, markdown, text. Markdown/text accept :no_links,no_images,only_content options. |
| `proxified_response` | boolean | No | Return the scraped content directly as the response body instead of the JSON wrapper. |
| `debug` | boolean | No | Store the API result and take a screenshot (if render_js enabled). |
| `correlation_id` | string | No | Helper ID for grouping scrapes. |
| `tags` | string | No | Tags for grouping scrapes, sent as tags[]=value. |
| `dns` | boolean | No | Query and return target DNS information. |
| `ssl` | boolean | No | Pull the remote SSL certificate and TLS info (https targets only). |
| `extraction_template` | string | No | Extraction template for structured data: ephemeral:base64(json_template). Adds 1 credit. |
| `extraction_prompt` | string | No | LLM instruction to extract data or ask questions about the page. URL encoded. Adds 5 credits. |
| `extraction_model` | string | No | AI auto-extraction model for structured data. Adds 5 credits. |
| `unblocker` | boolean | No | Enable Unblocker (formerly ASP) to bypass anti-bot protection. It may upgrade the proxy pool and browser, which raises the cost. |
| `asp` | boolean | No | Legacy name of unblocker. When both are sent, asp wins. |
| `cost_budget` | integer | No | Maximum credits Unblocker may spend on this request. |
| `render_js` | boolean | No | Render the page in a headless browser to execute JavaScript (+5 credits). |
| `rendering_wait` | integer | No | Delay in milliseconds after page load (render_js only). |
| `wait_for_selector` | string | No | Wait until a CSS/XPath selector or xhr: pattern is visible (render_js only). |
| `js` | string | No | JavaScript to execute, base64 encoded, max 16KB (render_js only). |
| `screenshots` | string | No | Screenshots to capture, sent as screenshots[name]=fullpage or a selector (render_js only). |
| `screenshot_flags` | string | No | Screenshot options: load_images, dark_mode, block_banners, high_quality, print_media_format. |
| `js_scenario` | string | No | Base64-encoded JSON scenario of page actions (click, fill, wait, scroll...). |
| `geolocation` | string | No | Spoof browser geolocation as latitude,longitude. |
| `auto_scroll` | boolean | No | Auto-scroll to the bottom to trigger lazy-loaded content. |
| `rendering_stage` | string | No | Page load stage to wait for. |
| `cache` | boolean | No | Enable caching: returns cached content on a hit, otherwise scrapes and caches. |
| `cache_ttl` | integer | No | Cache time-to-live in seconds. |
| `cache_clear` | boolean | No | Force cache refresh on this request. |

```bash
curl -X POST 'https://api.orthogonal.com/v1/run' \
  -H 'Authorization: Bearer $ORTHOGONAL_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"api":"scrapfly","path":"/scrape","method":"PUT","query":{"url":"<string>","proxy_pool":"<string>","country":"<string>","lang":"<string>","os":"<string>","browser_brand":"<string>","headers":"<string>","timeout":"<integer>","retry":"<boolean>","format":"<string>","proxified_response":"<boolean>","debug":"<boolean>","correlation_id":"<string>","tags":"<string>","dns":"<boolean>","ssl":"<boolean>","extraction_template":"<string>","extraction_prompt":"<string>","extraction_model":"<string>","unblocker":"<boolean>","asp":"<boolean>","cost_budget":"<integer>","render_js":"<boolean>","rendering_wait":"<integer>","wait_for_selector":"<string>","js":"<string>","screenshots":"<string>","screenshot_flags":"<string>","js_scenario":"<string>","geolocation":"<string>","auto_scroll":"<boolean>","rendering_stage":"<string>","cache":"<boolean>","cache_ttl":"<integer>","cache_clear":"<boolean>"}}'
```

### Web scrape with PATCH body

Scrapfly Scrape API (PATCH): fetches the target URL with the PATCH method through Scrapfly's proxies, with optional anti-bot bypass (Unblocker), JavaScript rendering, screenshots and data extraction; returns the page content in result.content with config and context metadata as JSON. Any request body is forwarded to the target.

`PATCH /scrape`

**Estimated cost:** from $0.000164 per call (required params only), up to $0.1635; use `"dryRun": true` in the Run API request to check the exact cost before calling.

**Page:** https://www.orthogonal.com/api/scrapfly/bd96c418-94d2-457c-98f8-73a7e83f14fa

**Docs:** https://scrapfly.io/docs/scrape-api/getting-started

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Target URL to scrape. Must be URL encoded. |
| `proxy_pool` | string | No | Proxy pool. public_datacenter_pool (1 credit) or public_residential_pool (25 credits). |
| `country` | string | No | Proxy country (ISO 3166-1 alpha-2). Supports exclusions (-gb), lists (us,ca,mx) and weights (us:10,gb:5). |
| `lang` | string | No | Page language (sets Accept-Language). Defaults to the proxy location language. |
| `os` | string | No | Operating system persona. Cannot be set with a custom User-Agent header. |
| `browser_brand` | string | No | Chromium browser brand for the fingerprint (with render_js=true). |
| `headers` | string | No | Custom HTTP headers, sent as headers[name]=url-encoded-value. |
| `timeout` | integer | No | Timeout in milliseconds. |
| `retry` | boolean | No | Retry on failure (network errors, HTTP 5xx). |
| `format` | string | No | Output format: raw, clean_html, json, markdown, text. Markdown/text accept :no_links,no_images,only_content options. |
| `proxified_response` | boolean | No | Return the scraped content directly as the response body instead of the JSON wrapper. |
| `debug` | boolean | No | Store the API result and take a screenshot (if render_js enabled). |
| `correlation_id` | string | No | Helper ID for grouping scrapes. |
| `tags` | string | No | Tags for grouping scrapes, sent as tags[]=value. |
| `dns` | boolean | No | Query and return target DNS information. |
| `ssl` | boolean | No | Pull the remote SSL certificate and TLS info (https targets only). |
| `extraction_template` | string | No | Extraction template for structured data: ephemeral:base64(json_template). Adds 1 credit. |
| `extraction_prompt` | string | No | LLM instruction to extract data or ask questions about the page. URL encoded. Adds 5 credits. |
| `extraction_model` | string | No | AI auto-extraction model for structured data. Adds 5 credits. |
| `unblocker` | boolean | No | Enable Unblocker (formerly ASP) to bypass anti-bot protection. It may upgrade the proxy pool and browser, which raises the cost. |
| `asp` | boolean | No | Legacy name of unblocker. When both are sent, asp wins. |
| `cost_budget` | integer | No | Maximum credits Unblocker may spend on this request. |
| `render_js` | boolean | No | Render the page in a headless browser to execute JavaScript (+5 credits). |
| `rendering_wait` | integer | No | Delay in milliseconds after page load (render_js only). |
| `wait_for_selector` | string | No | Wait until a CSS/XPath selector or xhr: pattern is visible (render_js only). |
| `js` | string | No | JavaScript to execute, base64 encoded, max 16KB (render_js only). |
| `screenshots` | string | No | Screenshots to capture, sent as screenshots[name]=fullpage or a selector (render_js only). |
| `screenshot_flags` | string | No | Screenshot options: load_images, dark_mode, block_banners, high_quality, print_media_format. |
| `js_scenario` | string | No | Base64-encoded JSON scenario of page actions (click, fill, wait, scroll...). |
| `geolocation` | string | No | Spoof browser geolocation as latitude,longitude. |
| `auto_scroll` | boolean | No | Auto-scroll to the bottom to trigger lazy-loaded content. |
| `rendering_stage` | string | No | Page load stage to wait for. |
| `cache` | boolean | No | Enable caching: returns cached content on a hit, otherwise scrapes and caches. |
| `cache_ttl` | integer | No | Cache time-to-live in seconds. |
| `cache_clear` | boolean | No | Force cache refresh on this request. |

```bash
curl -X POST 'https://api.orthogonal.com/v1/run' \
  -H 'Authorization: Bearer $ORTHOGONAL_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"api":"scrapfly","path":"/scrape","method":"PATCH","query":{"url":"<string>","proxy_pool":"<string>","country":"<string>","lang":"<string>","os":"<string>","browser_brand":"<string>","headers":"<string>","timeout":"<integer>","retry":"<boolean>","format":"<string>","proxified_response":"<boolean>","debug":"<boolean>","correlation_id":"<string>","tags":"<string>","dns":"<boolean>","ssl":"<boolean>","extraction_template":"<string>","extraction_prompt":"<string>","extraction_model":"<string>","unblocker":"<boolean>","asp":"<boolean>","cost_budget":"<integer>","render_js":"<boolean>","rendering_wait":"<integer>","wait_for_selector":"<string>","js":"<string>","screenshots":"<string>","screenshot_flags":"<string>","js_scenario":"<string>","geolocation":"<string>","auto_scroll":"<boolean>","rendering_stage":"<string>","cache":"<boolean>","cache_ttl":"<integer>","cache_clear":"<boolean>"}}'
```

### Web scrape OPTIONS request

Scrapfly Scrape API (OPTIONS): fetches the target URL with the OPTIONS method through Scrapfly's proxies, with optional anti-bot bypass (Unblocker), JavaScript rendering, screenshots and data extraction; returns the page content in result.content with config and context metadata as JSON.

`OPTIONS /scrape`

**Estimated cost:** from $0.000164 per call (required params only), up to $0.1635; use `"dryRun": true` in the Run API request to check the exact cost before calling.

**Page:** https://www.orthogonal.com/api/scrapfly/13de1c23-2edf-42d9-a326-52fd817cdbb0

**Docs:** https://scrapfly.io/docs/scrape-api/getting-started

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Target URL to scrape. Must be URL encoded. |
| `proxy_pool` | string | No | Proxy pool. public_datacenter_pool (1 credit) or public_residential_pool (25 credits). |
| `country` | string | No | Proxy country (ISO 3166-1 alpha-2). Supports exclusions (-gb), lists (us,ca,mx) and weights (us:10,gb:5). |
| `lang` | string | No | Page language (sets Accept-Language). Defaults to the proxy location language. |
| `os` | string | No | Operating system persona. Cannot be set with a custom User-Agent header. |
| `browser_brand` | string | No | Chromium browser brand for the fingerprint (with render_js=true). |
| `headers` | string | No | Custom HTTP headers, sent as headers[name]=url-encoded-value. |
| `timeout` | integer | No | Timeout in milliseconds. |
| `retry` | boolean | No | Retry on failure (network errors, HTTP 5xx). |
| `format` | string | No | Output format: raw, clean_html, json, markdown, text. Markdown/text accept :no_links,no_images,only_content options. |
| `proxified_response` | boolean | No | Return the scraped content directly as the response body instead of the JSON wrapper. |
| `debug` | boolean | No | Store the API result and take a screenshot (if render_js enabled). |
| `correlation_id` | string | No | Helper ID for grouping scrapes. |
| `tags` | string | No | Tags for grouping scrapes, sent as tags[]=value. |
| `dns` | boolean | No | Query and return target DNS information. |
| `ssl` | boolean | No | Pull the remote SSL certificate and TLS info (https targets only). |
| `extraction_template` | string | No | Extraction template for structured data: ephemeral:base64(json_template). Adds 1 credit. |
| `extraction_prompt` | string | No | LLM instruction to extract data or ask questions about the page. URL encoded. Adds 5 credits. |
| `extraction_model` | string | No | AI auto-extraction model for structured data. Adds 5 credits. |
| `unblocker` | boolean | No | Enable Unblocker (formerly ASP) to bypass anti-bot protection. It may upgrade the proxy pool and browser, which raises the cost. |
| `asp` | boolean | No | Legacy name of unblocker. When both are sent, asp wins. |
| `cost_budget` | integer | No | Maximum credits Unblocker may spend on this request. |
| `render_js` | boolean | No | Render the page in a headless browser to execute JavaScript (+5 credits). |
| `rendering_wait` | integer | No | Delay in milliseconds after page load (render_js only). |
| `wait_for_selector` | string | No | Wait until a CSS/XPath selector or xhr: pattern is visible (render_js only). |
| `js` | string | No | JavaScript to execute, base64 encoded, max 16KB (render_js only). |
| `screenshots` | string | No | Screenshots to capture, sent as screenshots[name]=fullpage or a selector (render_js only). |
| `screenshot_flags` | string | No | Screenshot options: load_images, dark_mode, block_banners, high_quality, print_media_format. |
| `js_scenario` | string | No | Base64-encoded JSON scenario of page actions (click, fill, wait, scroll...). |
| `geolocation` | string | No | Spoof browser geolocation as latitude,longitude. |
| `auto_scroll` | boolean | No | Auto-scroll to the bottom to trigger lazy-loaded content. |
| `rendering_stage` | string | No | Page load stage to wait for. |
| `cache` | boolean | No | Enable caching: returns cached content on a hit, otherwise scrapes and caches. |
| `cache_ttl` | integer | No | Cache time-to-live in seconds. |
| `cache_clear` | boolean | No | Force cache refresh on this request. |

```bash
curl -X POST 'https://api.orthogonal.com/v1/run' \
  -H 'Authorization: Bearer $ORTHOGONAL_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"api":"scrapfly","path":"/scrape","method":"OPTIONS","query":{"url":"<string>","proxy_pool":"<string>","country":"<string>","lang":"<string>","os":"<string>","browser_brand":"<string>","headers":"<string>","timeout":"<integer>","retry":"<boolean>","format":"<string>","proxified_response":"<boolean>","debug":"<boolean>","correlation_id":"<string>","tags":"<string>","dns":"<boolean>","ssl":"<boolean>","extraction_template":"<string>","extraction_prompt":"<string>","extraction_model":"<string>","unblocker":"<boolean>","asp":"<boolean>","cost_budget":"<integer>","render_js":"<boolean>","rendering_wait":"<integer>","wait_for_selector":"<string>","js":"<string>","screenshots":"<string>","screenshot_flags":"<string>","js_scenario":"<string>","geolocation":"<string>","auto_scroll":"<boolean>","rendering_stage":"<string>","cache":"<boolean>","cache_ttl":"<integer>","cache_clear":"<boolean>"}}'
```

### Web scrape headers only

Scrapfly Scrape API (HEAD): sends a HEAD request to the target URL through Scrapfly's proxies, with the same proxy, anti-bot and rendering options as the other scrape methods; returns only response headers, no body.

`HEAD /scrape`

**Estimated cost:** from $0.000164 per call (required params only), up to $0.1635; use `"dryRun": true` in the Run API request to check the exact cost before calling.

**Page:** https://www.orthogonal.com/api/scrapfly/07e3c01e-0d76-4c4d-a770-cef0b79073ed

**Docs:** https://scrapfly.io/docs/scrape-api/getting-started

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Target URL to scrape. Must be URL encoded. |
| `proxy_pool` | string | No | Proxy pool. public_datacenter_pool (1 credit) or public_residential_pool (25 credits). |
| `country` | string | No | Proxy country (ISO 3166-1 alpha-2). Supports exclusions (-gb), lists (us,ca,mx) and weights (us:10,gb:5). |
| `lang` | string | No | Page language (sets Accept-Language). Defaults to the proxy location language. |
| `os` | string | No | Operating system persona. Cannot be set with a custom User-Agent header. |
| `browser_brand` | string | No | Chromium browser brand for the fingerprint (with render_js=true). |
| `headers` | string | No | Custom HTTP headers, sent as headers[name]=url-encoded-value. |
| `timeout` | integer | No | Timeout in milliseconds. |
| `retry` | boolean | No | Retry on failure (network errors, HTTP 5xx). |
| `format` | string | No | Output format: raw, clean_html, json, markdown, text. Markdown/text accept :no_links,no_images,only_content options. |
| `proxified_response` | boolean | No | Return the scraped content directly as the response body instead of the JSON wrapper. |
| `debug` | boolean | No | Store the API result and take a screenshot (if render_js enabled). |
| `correlation_id` | string | No | Helper ID for grouping scrapes. |
| `tags` | string | No | Tags for grouping scrapes, sent as tags[]=value. |
| `dns` | boolean | No | Query and return target DNS information. |
| `ssl` | boolean | No | Pull the remote SSL certificate and TLS info (https targets only). |
| `extraction_template` | string | No | Extraction template for structured data: ephemeral:base64(json_template). Adds 1 credit. |
| `extraction_prompt` | string | No | LLM instruction to extract data or ask questions about the page. URL encoded. Adds 5 credits. |
| `extraction_model` | string | No | AI auto-extraction model for structured data. Adds 5 credits. |
| `unblocker` | boolean | No | Enable Unblocker (formerly ASP) to bypass anti-bot protection. It may upgrade the proxy pool and browser, which raises the cost. |
| `asp` | boolean | No | Legacy name of unblocker. When both are sent, asp wins. |
| `cost_budget` | integer | No | Maximum credits Unblocker may spend on this request. |
| `render_js` | boolean | No | Render the page in a headless browser to execute JavaScript (+5 credits). |
| `rendering_wait` | integer | No | Delay in milliseconds after page load (render_js only). |
| `wait_for_selector` | string | No | Wait until a CSS/XPath selector or xhr: pattern is visible (render_js only). |
| `js` | string | No | JavaScript to execute, base64 encoded, max 16KB (render_js only). |
| `screenshots` | string | No | Screenshots to capture, sent as screenshots[name]=fullpage or a selector (render_js only). |
| `screenshot_flags` | string | No | Screenshot options: load_images, dark_mode, block_banners, high_quality, print_media_format. |
| `js_scenario` | string | No | Base64-encoded JSON scenario of page actions (click, fill, wait, scroll...). |
| `geolocation` | string | No | Spoof browser geolocation as latitude,longitude. |
| `auto_scroll` | boolean | No | Auto-scroll to the bottom to trigger lazy-loaded content. |
| `rendering_stage` | string | No | Page load stage to wait for. |
| `cache` | boolean | No | Enable caching: returns cached content on a hit, otherwise scrapes and caches. |
| `cache_ttl` | integer | No | Cache time-to-live in seconds. |
| `cache_clear` | boolean | No | Force cache refresh on this request. |

```bash
curl -X POST 'https://api.orthogonal.com/v1/run' \
  -H 'Authorization: Bearer $ORTHOGONAL_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"api":"scrapfly","path":"/scrape","method":"HEAD","query":{"url":"<string>","proxy_pool":"<string>","country":"<string>","lang":"<string>","os":"<string>","browser_brand":"<string>","headers":"<string>","timeout":"<integer>","retry":"<boolean>","format":"<string>","proxified_response":"<boolean>","debug":"<boolean>","correlation_id":"<string>","tags":"<string>","dns":"<boolean>","ssl":"<boolean>","extraction_template":"<string>","extraction_prompt":"<string>","extraction_model":"<string>","unblocker":"<boolean>","asp":"<boolean>","cost_budget":"<integer>","render_js":"<boolean>","rendering_wait":"<integer>","wait_for_selector":"<string>","js":"<string>","screenshots":"<string>","screenshot_flags":"<string>","js_scenario":"<string>","geolocation":"<string>","auto_scroll":"<boolean>","rendering_stage":"<string>","cache":"<boolean>","cache_ttl":"<integer>","cache_clear":"<boolean>"}}'
```

### Block detection

Runs the anti-bot detection pipeline against an HTTP response you already have; returns whether the target blocked the request and the anti-bot product that matched.

`POST /classify`

**Estimated cost:** $0.000164

**Page:** https://www.orthogonal.com/api/scrapfly/dd9c312f-19ba-4cdc-9843-13b709f3a9db

**Docs:** https://scrapfly.io/docs/scrape-api/classify

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | the final URL the response came from. |
| `status_code` | integer | Yes | the HTTP status code (100-599) of the response you're classifying. |
| `headers` | object | No | response headers, case-insensitive. Pass everything you have for best accuracy. |
| `body` | string | No | the response body as text. Binary payloads can be passed as an empty string. |
| `method` | string | No | the HTTP method the caller used. |

```bash
curl -X POST 'https://api.orthogonal.com/v1/run' \
  -H 'Authorization: Bearer $ORTHOGONAL_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"api":"scrapfly","path":"/classify","body":{"url":"<string>","status_code":"<integer>","headers":"<object>","body":"<string>","method":"<string>"}}'
```

### Web page screenshot

Scrapfly Screenshot API: renders the page in a browser and returns the screenshot image (jpg, png, webp or gif) of the viewport, the full page or one element.

`GET /screenshot`

**Estimated cost:** $0.00981

**Page:** https://www.orthogonal.com/api/scrapfly/aaf38010-8756-4106-9ad8-562258dd0218

**Docs:** https://scrapfly.io/docs/screenshot-api/getting-started

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Target URL to screenshot. Must be URL encoded. |
| `format` | string | No | Image format. |
| `capture` | string | No | Area to capture: viewport, fullpage, or a CSS selector/XPath. |
| `resolution` | string | No | Screen resolution (width x height). |
| `country` | string | No | Proxy country (ISO 3166 alpha-2). Supports multiple, weighted, or exclusions. |
| `timeout` | integer | No | Maximum time in milliseconds (min 60000, max 120000). |
| `rendering_wait` | integer | No | Delay in milliseconds to wait after page load. |
| `wait_for_selector` | string | No | Wait until a CSS selector or XPath is visible before capturing. |
| `options` | string | No | Screenshot flags, comma separated: dark_mode, block_banners, print_media_format, load_images. |
| `auto_scroll` | boolean | No | Auto-scroll to bottom to trigger lazy-loaded content. |
| `js` | string | No | JavaScript to execute (base64 encoded, max 16KB). |
| `cache` | boolean | No | Enable caching for repeated screenshots of the same URL. |
| `cache_ttl` | integer | No | Cache time-to-live in seconds. |
| `cache_clear` | boolean | No | Force cache refresh on this request. |
| `vision_deficiency` | string | No | Simulate a vision deficiency for accessibility testing (no extra cost). |

```bash
curl -X POST 'https://api.orthogonal.com/v1/run' \
  -H 'Authorization: Bearer $ORTHOGONAL_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"api":"scrapfly","path":"/screenshot","method":"GET","query":{"url":"<string>","format":"<string>","capture":"<string>","resolution":"<string>","country":"<string>","timeout":"<integer>","rendering_wait":"<integer>","wait_for_selector":"<string>","options":"<string>","auto_scroll":"<boolean>","js":"<string>","cache":"<boolean>","cache_ttl":"<integer>","cache_clear":"<boolean>","vision_deficiency":"<string>"}}'
```

### Screenshot URL only

Scrapfly Screenshot API with HEAD: takes the screenshot but returns no body, only headers with the URL of the stored screenshot.

`HEAD /screenshot`

**Estimated cost:** $0.00981

**Page:** https://www.orthogonal.com/api/scrapfly/a2c72c30-ca85-461d-a6e0-dae2087d24a7

**Docs:** https://scrapfly.io/docs/screenshot-api/getting-started

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Target URL to screenshot. Must be URL encoded. |
| `format` | string | No | Image format. |
| `capture` | string | No | Area to capture: viewport, fullpage, or a CSS selector/XPath. |
| `resolution` | string | No | Screen resolution (width x height). |
| `country` | string | No | Proxy country (ISO 3166 alpha-2). Supports multiple, weighted, or exclusions. |
| `timeout` | integer | No | Maximum time in milliseconds (min 60000, max 120000). |
| `rendering_wait` | integer | No | Delay in milliseconds to wait after page load. |
| `wait_for_selector` | string | No | Wait until a CSS selector or XPath is visible before capturing. |
| `options` | string | No | Screenshot flags, comma separated: dark_mode, block_banners, print_media_format, load_images. |
| `auto_scroll` | boolean | No | Auto-scroll to bottom to trigger lazy-loaded content. |
| `js` | string | No | JavaScript to execute (base64 encoded, max 16KB). |
| `cache` | boolean | No | Enable caching for repeated screenshots of the same URL. |
| `cache_ttl` | integer | No | Cache time-to-live in seconds. |
| `cache_clear` | boolean | No | Force cache refresh on this request. |
| `vision_deficiency` | string | No | Simulate a vision deficiency for accessibility testing (no extra cost). |

```bash
curl -X POST 'https://api.orthogonal.com/v1/run' \
  -H 'Authorization: Bearer $ORTHOGONAL_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"api":"scrapfly","path":"/screenshot","method":"HEAD","query":{"url":"<string>","format":"<string>","capture":"<string>","resolution":"<string>","country":"<string>","timeout":"<integer>","rendering_wait":"<integer>","wait_for_selector":"<string>","options":"<string>","auto_scroll":"<boolean>","js":"<string>","cache":"<boolean>","cache_ttl":"<integer>","cache_clear":"<boolean>","vision_deficiency":"<string>"}}'
```

### Website crawl

Scrapfly Crawler API: starts a crawl of a website from a starting URL (up to page_limit pages, 1 to 1,000 on this listing) and returns immediately with a crawler UUID to poll for status, content, search and archives. Charged up front for the most pages it may crawl.

`POST /crawl`

**Estimated cost:** from $0.000164 per call (required params only), up to $5.7225; use `"dryRun": true` in the Run API request to check the exact cost before calling.

**Page:** https://www.orthogonal.com/api/scrapfly/2abff781-7afb-42b9-aa6b-74b30f98614f

**Docs:** https://scrapfly.io/docs/crawler-api/getting-started

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Starting URL for the crawl (HTTP/HTTPS). |
| `page_limit` | integer | Yes | Maximum pages to crawl. Required here and at least 1 (unlimited crawls are not priced on this listing); max 1000. |
| `max_depth` | integer | No | Maximum link depth from the starting URL. Depth 0 is the starting URL. |
| `exclude_paths` | array | No | Exclude URLs matching these path patterns (wildcards *). Max 100. |
| `include_only_paths` | array | No | Only crawl URLs matching these patterns (wildcards *). Max 100. Mutually exclusive with exclude_paths. |
| `ignore_base_path_restriction` | boolean | No | Crawl any path on the same domain, not only below the starting URL's base path. |
| `follow_external_links` | boolean | No | Follow links to external domains (their links are not followed). |
| `allowed_external_domains` | array | No | Whitelist of external domains when follow_external_links=true. Max 250. Wildcards allowed. |
| `follow_internal_subdomains` | boolean | No | Follow links to subdomains of the starting domain. |
| `allowed_internal_subdomains` | array | No | Restrict crawling to these subdomains. Max 250. |
| `rendering_delay` | integer | No | Wait time in ms after page load; above 0 enables browser rendering (+5 credits per page). Range 0-25000. |
| `max_concurrency` | integer | No | Maximum concurrent scrape requests; 0 for the account default. |
| `headers` | object | No | Custom HTTP headers as a JSON object. |
| `delay` | string | No | Delay between requests in milliseconds (0-15000). |
| `user_agent` | string | No | Custom User-Agent string. Ignored when unblocker=true. |
| `use_sitemaps` | boolean | No | Use sitemap.xml for URL discovery if available. |
| `respect_robots_txt` | boolean | No | Respect robots.txt rules. |
| `cache` | boolean | No | Use the cache layer for crawled pages. |
| `cache_ttl` | integer | No | Cache time-to-live in seconds (0-604800). |
| `cache_clear` | boolean | No | Force refresh of cached pages. |
| `ignore_no_follow` | boolean | No | Ignore rel="nofollow" on links. |
| `content_formats` | array | No | Content formats to extract from each page. |
| `search` | boolean | No | Build a search index over the crawled pages so the crawl can be queried with the search, prompt and extract endpoints. |
| `max_duration` | integer | No | Maximum crawl duration in seconds (15-10800). |
| `max_api_credit` | integer | No | Maximum API credits the crawl may spend; the crawler stops when reached. Lowers the price charged up front. |
| `extraction_rules` | object | No | Extraction rules per URL pattern; types prompt, model (+5 credits per page) or template (+1). Max 100 rules. |
| `proxy_pool` | string | No | Proxy pool: public_datacenter_pool (1 credit per page) or public_residential_pool (25). |
| `country` | string | No | Proxy country (ISO 3166-1 alpha-2). |
| `unblocker` | boolean | No | Enable Unblocker anti-bot bypass with browser rendering. |
| `asp` | boolean | No | Legacy name of unblocker; when both are sent, asp wins. |

```bash
curl -X POST 'https://api.orthogonal.com/v1/run' \
  -H 'Authorization: Bearer $ORTHOGONAL_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"api":"scrapfly","path":"/crawl","body":{"url":"<string>","page_limit":"<integer>","max_depth":"<integer>","exclude_paths":"<array>","include_only_paths":"<array>","ignore_base_path_restriction":"<boolean>","follow_external_links":"<boolean>","allowed_external_domains":"<array>","follow_internal_subdomains":"<boolean>","allowed_internal_subdomains":"<array>","rendering_delay":"<integer>","max_concurrency":"<integer>","headers":"<object>","delay":"<string>","user_agent":"<string>","use_sitemaps":"<boolean>","respect_robots_txt":"<boolean>","cache":"<boolean>","cache_ttl":"<integer>","cache_clear":"<boolean>","ignore_no_follow":"<boolean>","content_formats":"<array>","search":"<boolean>","max_duration":"<integer>","max_api_credit":"<integer>","extraction_rules":"<object>","proxy_pool":"<string>","country":"<string>","unblocker":"<boolean>","asp":"<boolean>"}}'
```

### Crawl status

Retrieve the current status and progress of a crawler job. Use this endpoint to poll for updates while the crawler is running.

`GET /crawl/{crawler_uuid}/status`

**Cost:** Free

**Page:** https://www.orthogonal.com/api/scrapfly/2bb1a583-f8e0-4818-ba7d-0f170e011996

**Docs:** https://scrapfly.io/docs/crawler-api/getting-started

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `crawler_uuid` | string | Yes | Path parameter — substitute directly into the endpoint `path`. |

```bash
# Replace {crawler_uuid} in "path" with real values before sending
curl -X POST 'https://api.orthogonal.com/v1/run' \
  -H 'Authorization: Bearer $ORTHOGONAL_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"api":"scrapfly","path":"/crawl/{crawler_uuid}/status","method":"GET"}'
```

### Crawl cancel

Stop a crawl at any time before it reaches a terminal state. Calling cancel on a crawl that has already finished is a no-op and returns success.

`POST /crawl/{crawler_uuid}/cancel`

**Cost:** Free

**Page:** https://www.orthogonal.com/api/scrapfly/04e706f4-dfd3-4970-9b1e-8c29bd984687

**Docs:** https://scrapfly.io/docs/crawler-api/getting-started

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `crawler_uuid` | string | Yes | Path parameter — substitute directly into the endpoint `path`. |

```bash
# Replace {crawler_uuid} in "path" with real values before sending
curl -X POST 'https://api.orthogonal.com/v1/run' \
  -H 'Authorization: Bearer $ORTHOGONAL_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"api":"scrapfly","path":"/crawl/{crawler_uuid}/cancel"}'
```

### Crawled URL list

Retrieve the URLs discovered and crawled during the job. The response is text/plain, one record per line. Returns at most the first 50 records for the requested status.

`GET /crawl/{crawler_uuid}/urls`

**Cost:** Free

**Page:** https://www.orthogonal.com/api/scrapfly/51d23d23-6169-4a16-be11-4ed14618049d

**Docs:** https://scrapfly.io/docs/crawler-api/getting-started

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `crawler_uuid` | string | Yes | Path parameter — substitute directly into the endpoint `path`. |
| `status` | string | No | Filter by URL status. |

```bash
# Replace {crawler_uuid} in "path" with real values before sending
curl -X POST 'https://api.orthogonal.com/v1/run' \
  -H 'Authorization: Bearer $ORTHOGONAL_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"api":"scrapfly","path":"/crawl/{crawler_uuid}/urls","method":"GET","query":{"status":"<string>"}}'
```

### Crawled page content

Retrieve extracted content from crawled pages in the format(s) specified in your crawl configuration. Single URL or all pages (paginated).

`GET /crawl/{crawler_uuid}/contents`

**Cost:** Free

**Page:** https://www.orthogonal.com/api/scrapfly/188a79c4-53d2-4733-8c95-35130251db3f

**Docs:** https://scrapfly.io/docs/crawler-api/getting-started

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `crawler_uuid` | string | Yes | Path parameter — substitute directly into the endpoint `path`. |
| `formats` | string | No | Comma-separated content formats to retrieve; defaults to every configured format. Exactly one when plain=true. |
| `url` | string | No | Retrieve content for this URL only. |
| `plain` | boolean | No | Return raw content without the JSON wrapper. Needs url and exactly one format. |
| `limit` | integer | No | URLs per page (max 50). |
| `offset` | integer | No | URLs to skip. |

```bash
# Replace {crawler_uuid} in "path" with real values before sending
curl -X POST 'https://api.orthogonal.com/v1/run' \
  -H 'Authorization: Bearer $ORTHOGONAL_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"api":"scrapfly","path":"/crawl/{crawler_uuid}/contents","method":"GET","query":{"formats":"<string>","url":"<string>","plain":"<boolean>","limit":"<integer>","offset":"<integer>"}}'
```

### Crawl archive download

Download industry-standard archive files containing all crawled data, including HTTP requests, responses, headers, and extracted content.

`GET /crawl/{crawler_uuid}/artifact`

**Cost:** Free

**Page:** https://www.orthogonal.com/api/scrapfly/11660a39-7f42-4761-95cd-88200f36cdb3

**Docs:** https://scrapfly.io/docs/crawler-api/getting-started

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `crawler_uuid` | string | Yes | Path parameter — substitute directly into the endpoint `path`. |
| `type` | string | No | Artifact type: warc (gzip Web ARChive) or har (HTTP Archive JSON). |

```bash
# Replace {crawler_uuid} in "path" with real values before sending
curl -X POST 'https://api.orthogonal.com/v1/run' \
  -H 'Authorization: Bearer $ORTHOGONAL_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"api":"scrapfly","path":"/crawl/{crawler_uuid}/artifact","method":"GET","query":{"type":"<string>"}}'
```

### Crawl search

One crawl. Query string form, convenient from a browser or a shell. Returns ranked passages from the crawl's search index.

`GET /crawl/{crawler_uuid}/search`

**Estimated cost:** $0.000164

**Page:** https://www.orthogonal.com/api/scrapfly/078027fd-2b00-4768-8b7f-275828af0039

**Docs:** https://scrapfly.io/docs/crawler-api/search

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `crawler_uuid` | string | Yes | Path parameter — substitute directly into the endpoint `path`. |
| `q` | string | Yes | The search text. |
| `limit` | integer | No | Results per page. Hard cap of 50. |
| `mode` | string | No | Search mode. |
| `cursor` | string | No | Opaque token from a previous response; returns the next page. |
| `url_prefix` | string | No | Exact prefix match on the page URL. |
| `host` | string | No | Host component of the page URL. |
| `source_format` | string | No | Source format filter. |
| `content_type` | string | No | The content type stored on the row, for example application/markdown. |
| `http_status` | integer | No | Response status of the page the chunk came from. |

```bash
# Replace {crawler_uuid} in "path" with real values before sending
curl -X POST 'https://api.orthogonal.com/v1/run' \
  -H 'Authorization: Bearer $ORTHOGONAL_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"api":"scrapfly","path":"/crawl/{crawler_uuid}/search","method":"GET","query":{"q":"<string>","limit":"<integer>","mode":"<string>","cursor":"<string>","url_prefix":"<string>","host":"<string>","source_format":"<string>","content_type":"<string>","http_status":"<integer>"}}'
```

### Multi-crawl search

One or many crawls. The collection is crawl_ids in the request body. Returns ranked passages with the URL they came from and a link back to the full page.

`POST /crawl/search`

**Estimated cost:** $0.000164

**Page:** https://www.orthogonal.com/api/scrapfly/50983436-e7cd-4827-a597-57ba9f28dcfb

**Docs:** https://scrapfly.io/docs/crawler-api/search

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | The search text. |
| `crawl_ids` | array | Yes | Crawler UUIDs to search. Up to 256 per request, no duplicates. |
| `limit` | integer | No | Results per page. Hard cap of 50, same as /contents. |
| `mode` | string | No | vector, fts or hybrid. |
| `filters` | object | No | Narrow the corpus before ranking. |
| `cursor` | string | No | Opaque token from a previous response. Returns the next page. |

```bash
curl -X POST 'https://api.orthogonal.com/v1/run' \
  -H 'Authorization: Bearer $ORTHOGONAL_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"api":"scrapfly","path":"/crawl/search","body":{"query":"<string>","crawl_ids":"<array>","limit":"<integer>","mode":"<string>","filters":"<object>","cursor":"<string>"}}'
```

### Multi-crawl question answering

Answer questions using the pages one or many crawls collected, returning a cited answer (streamed as Server-Sent Events or one JSON object).

`POST /crawl/prompt`

**Estimated cost:** $0.000491

**Page:** https://www.orthogonal.com/api/scrapfly/6d20cb75-a057-42db-81e0-0a06b24a218f

**Docs:** https://scrapfly.io/docs/crawler-api/prompt

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `prompt` | string | Yes | Your question or instruction. This is the only text that is treated as an instruction. |
| `crawl_ids` | array | Yes | Crawls to retrieve from. Same authorization, same per-request cap and same skipped semantics as /crawl/search. |
| `search` | object | No | The retrieval request: limit, mode and filters, with the same meanings and the same cap of 50. limit defaults to 30 here. |
| `generation` | object | No | Generation options. |

```bash
curl -X POST 'https://api.orthogonal.com/v1/run' \
  -H 'Authorization: Bearer $ORTHOGONAL_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"api":"scrapfly","path":"/crawl/prompt","body":{"prompt":"<string>","crawl_ids":"<array>","search":"<object>","generation":"<object>"}}'
```

### Crawl question answering

A single crawl. Same implementation as POST /crawl/prompt, the UUID comes from the path.

`POST /crawl/{crawler_uuid}/prompt`

**Estimated cost:** $0.000491

**Page:** https://www.orthogonal.com/api/scrapfly/9d8efa49-5d70-4d19-ba4f-64dc6dc010d2

**Docs:** https://scrapfly.io/docs/crawler-api/prompt

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `crawler_uuid` | string | Yes | Path parameter — substitute directly into the endpoint `path`. |
| `prompt` | string | Yes | Your question or instruction. |
| `search` | object | No | The retrieval request: limit, mode and filters. |
| `generation` | object | No | Generation options: model and stream. |

```bash
# Replace {crawler_uuid} in "path" with real values before sending
curl -X POST 'https://api.orthogonal.com/v1/run' \
  -H 'Authorization: Bearer $ORTHOGONAL_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"api":"scrapfly","path":"/crawl/{crawler_uuid}/prompt","body":{"prompt":"<string>","search":"<object>","generation":"<object>"}}'
```

### Crawl structured extraction

The same retrieval as /crawl/prompt with a structured answer: supply a JSON Schema and get back an object that conforms to it.

`POST /crawl/extract`

**Estimated cost:** $0.000491

**Page:** https://www.orthogonal.com/api/scrapfly/2438de22-e8b6-4d9f-9f2e-db67f8bd31b1

**Docs:** https://scrapfly.io/docs/crawler-api/prompt

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `prompt` | string | Yes | What to extract. Also drives retrieval. |
| `schema` | object | Yes | JSON Schema for the result. |
| `crawl_ids` | array | Yes | Identical to /crawl/prompt. |
| `search` | object | No | Identical to /crawl/prompt. |

```bash
curl -X POST 'https://api.orthogonal.com/v1/run' \
  -H 'Authorization: Bearer $ORTHOGONAL_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"api":"scrapfly","path":"/crawl/extract","body":{"prompt":"<string>","schema":"<object>","crawl_ids":"<array>","search":"<object>"}}'
```

---

Full details and an interactive quickstart: https://www.orthogonal.com/publisher/scrapfly
