---
title: "Start Smartscraper"
method: POST
path: "/v1/smartscraper"
tags: ["SmartScraper"]
---

# Start Smartscraper

`POST /v1/smartscraper`

## Request

- Base URL: `https://api.scrapegraphai.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.scrapegraphai.com/v1/smartscraper`
- Auth: none declared

## Request body

- SmartscraperRequest
  - `website_url` string, nullable: The URL of the website to scrape (optional for Smartscraper)
  - `render_heavy_js` boolean: Whether to render heavy JS
  - `mock` boolean
  - `stealth` boolean
  - `branding` boolean
  - `stream` boolean: Whether to return streaming response
  - `country_code` string, nullable: The country code to use for the scrape
  - `wait_ms` integer: The number of milliseconds to wait before scraping the website
  - `user_prompt` string, required
  - `website_html` string, nullable: HTML content, maximum size 2MB
  - `website_markdown` string, nullable: Markdown content, maximum size 2MB
  - `output_schema` object, nullable
  - `headers` object, nullable: Optional headers to send with the request, including cookies and user agent
  - `number_of_scrolls` integer: Number of scroll operations to perform for infinite scrolling (0 = disabled, range: 1-100). Values between 1-9 will be automatically set to 10.
  - `total_pages` integer: Total number of pages to scrape if pagination enabled
  - `steps` string[], nullable: List of steps to actions to perform on the website
  - `cookies` object, nullable: Cookies to send with the request
  - `plain_text` boolean
  - `webhook_url` string, nullable: Webhook URL to send the job result to
  - `offset` integer: Offset to start scraping from
  - `is_multipage_child` boolean: Whether this is a multi-page child request

## Response `200`

Successful Response

- CompletedSmartscraperResponse
  - `request_id` string, required
  - `status` 'queued' | 'processing' | 'completed' | 'failed', required
  - `website_url` string, nullable
  - `user_prompt` string, required
  - `result` union
    - object
    - string
  - `error` string

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/scrapegraphai/apis/scrapegraphai-api.md) - [All operations](https://skmtc.dev/scrapegraphai/apis/scrapegraphai-api/llms.txt) - [OpenAPI document](https://skmtc.dev/scrapegraphai/apis/scrapegraphai-api/revisions/a0e42195429f?raw)