Quickstart
Official Python SDK for Supacrawler API
Installation
pip install supacrawler-py
Or using uv:
uv add supacrawler-py
Quick Start
from supacrawler import SupacrawlerClient
# Initialize client
client = SupacrawlerClient(api_key="YOUR_API_KEY")
# Scrape a website
result = client.scrape("https://example.com", format="markdown")
print(result.markdown)
Authentication
The SDK requires an API key for authentication. Get your API key from the dashboard.
import os
from dotenv import load_dotenv
from supacrawler import SupacrawlerClient
load_dotenv()
SUPACRAWLER_API_KEY = os.environ.get("SUPACRAWLER_API_KEY")
client = SupacrawlerClient(api_key=SUPACRAWLER_API_KEY)
Features
The Python SDK supports all Supacrawler endpoints:
- Scrape - Extract content from single pages
- Crawl - Recursively crawl websites
- Parse - AI-powered data extraction
- Screenshots - Capture website screenshots
- Watch - Monitor websites for changes
Next Steps
Explore the SDK documentation for each endpoint:
Resources
Was this page helpful?