gcrawl-sdk

Official Python SDK for GCrawl — Scrape, batch scrape, crawl, screenshot, fetch links, and search web pages with ease.

Installation

pip install gcrawl-sdk

Quick Start

from gcrawl_sdk import GcrawlClient, ScrapeOptions

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

# Scrape a website (synchronous polling)
result = client.scrape(
    url="https://gramosoft.tech",
    options=ScrapeOptions(markdown_enabled=True, html_enabled=True),
    wait=True
)
print("Scraped Markdown:", result.markdown)
print("Scraped HTML:", result.html)

# Batch scrape multiple websites
batch_res = client.batch(
    urls=["https://gramosoft.tech", "https://gdoczai.com"],
    wait=True
)
for page in batch_res.pages:
    print(page.url, page.markdown[:50])

# Search web synchronously
search_res = client.search("gramosoft", pagination=5, geo="IN")
for res in search_res.results:
    print(res.position, res.title, res.url)

API Key

Set your API key as an environment variable:

export GCRAWL_API_KEY="your-api-key"

Or pass it directly to the client:

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

Documentation

For detailed endpoint guides, options, and response references, see the documentation guides below: