---
title: "Scrape URL"
method: POST
path: "/v1/web/scrape"
---

# Scrape URL

`POST /v1/web/scrape`

Scrape a webpage and return its content as HTML, Markdown, or plain text.

## Request body

- object
  - `url` string, required — The URL to scrape. Must be a valid HTTP or HTTPS URL.
  - `engine` 'auto' | 'browser' — Scraping engine tier to use.
  - `format` 'html' | 'markdown' | 'text' — Output format for the scraped content.
  - `render_js` boolean — Force JavaScript rendering.
  - `wait_for` string — CSS selector or XPath to wait for before extracting.
  - `wait_timeout` integer — Max wait time in ms for wait_for selector.
  - `wait_after_load` integer — Additional ms to wait after page load.
  - `js_scenario` object[] — Browser actions to perform before extracting.
  - `session_id` string — Persist cookies and state across requests.
  - `retry_count` integer — Max retry attempts on blocking detection.
  - `retry_on_block` boolean — Auto-retry on blocking page detection.
  - `country` string — ISO 3166-1 alpha-2 country code for proxy geo-targeting.
  - `custom_headers` object — Additional HTTP headers for the target request.
  - `screenshot` boolean — Capture a full-page PNG screenshot.
  - `video` boolean — Record browser session as animated GIF (+3 credits).
  - `anti_bot` boolean — Attempt anti-bot bypass when blocking detected.
  - `escalate` boolean — Allow auto-escalation to stronger engines.
  - `max_cost` integer — Maximum credits budget for this request.
  - `ai_extract` boolean — Run AI extraction on scraped content.
  - `ai_prompt` string — Natural language instruction for AI extraction.

## Response `200`

Successful scrape

- object
  - `success` boolean
  - `url` string
  - `status_code` integer
  - `content` string
  - `format` string
  - `engine_used` string
  - `credits_used` integer
  - `duration_ms` integer
  - `retries_used` integer
  - `content_length` integer
  - `screenshot_url` string, nullable
  - `video_url` string, nullable
  - `headers` object
  - `blocking_detected` boolean
  - `blocking_details` object, nullable
  - `antibot_systems` unknown[]
    - unknown
  - `captcha_systems` unknown[]
    - unknown
  - `anti_bot_solved` boolean
  - `solver_used` string, nullable
  - `ai_extraction` unknown
  - `ai_model` string, nullable
  - `ai_error` string, nullable

---

[API](https://skmtc.net/scrapebadger/apis/scrapebadger-account-api.md) · [All operations](https://skmtc.net/scrapebadger/apis/scrapebadger-account-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/scrapebadger/scrapebadger-account-api/versions/4a1ef8777baf/schema)