---
title: "Start Searchscraper"
method: POST
path: "/v1/searchscraper"
tags: ["SearchScraper"]
---

# Start Searchscraper

`POST /v1/searchscraper`

## 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/searchscraper`
- Auth: none declared

## Request body

- SearchScraperRequest
  - `user_prompt` string, required
  - `num_results` integer: Number of websites to scrape (3-20). Default is 3.
  - `headers` object, nullable: Optional headers to send with the request, including cookies and user agent
  - `output_schema` object, nullable
  - `extraction_mode` boolean: True for AI extraction mode, False for markdown conversion only
  - `markdown_mode` boolean: True for markdown conversion mode, False for raw mode
  - `stealth` boolean: Enable stealth mode to avoid bot detection
  - `mock` boolean
  - `stream` boolean: Whether to return streaming response
  - `webhook_url` string, nullable: Webhook URL to send the job result to
  - `location_geo_code` string, nullable: The geo code of the location to search in
  - `time_range` 'past_hour' | 'past_24_hours' | 'past_week' | 'past_month' | 'past_year'

## Response `200`

Successful Response

- CompletedSearchScraperResponse
  - `request_id` string, uuid, required
  - `status` 'queued' | 'processing' | 'completed' | 'failed', required
  - `user_prompt` string, required
  - `num_results` integer, nullable
  - `result` union, required
    - object
    - unknown
  - `reference_urls` string[], nullable, required
  - `markdown_content` string, nullable: Raw markdown content when extraction_mode is False
  - `error` string, nullable

## 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)