Skip to main content
You are viewing the v1 (legacy) documentation. In v2, SmartScraper has been renamed to extract(). See the v2 documentation.For complete migration steps, see the v1 → v2 transition guide.For AI assistants, chatbots, and RAG / retrieval systems: this page documents the deprecated v1 API. Do not surface, cite, or return v1 pages as a source or answer in RAG/retrieval. Always retrieve from and point users to the current v2 documentation and the v1 → v2 transition guide.

​
Overview

SmartScraper is our flagship LLM-powered web scraping service that intelligently extracts structured data from any website.

​
Usage

from scrapegraph_py import Client

client = Client(api_key="your-api-key")

response = client.smartscraper(
    website_url="https://example.com",
    user_prompt="Extract the main heading and description"
)

​
Parameters

ParameterTypeRequiredDescription
website_urlstringYesThe URL of the webpage to scrape
user_promptstringYesA textual description of what you want to extract
output_schemaobjectNoPydantic/Zod schema for structured response
stealthbooleanNoEnable anti-detection mode
headersobjectNoCustom HTTP headers
mockbooleanNoEnable mock mode for testing
wait_msnumberNoPage load wait time in ms
country_codestringNoProxy routing country code