Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.scrapegraphai.com/llms.txt

Use this file to discover all available pages before exploring further.

extract

# Extract product listings
just-scrape extract https://store.example.com/shoes \
  -p "Extract all product names, prices, and ratings"

# Enforce output schema + scroll to load more content
just-scrape extract https://news.example.com \
  -p "Get all article headlines and dates" \
  --schema '{"type":"object","properties":{"articles":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"date":{"type":"string"}}}}}}' \
  --scrolls 5

# Anti-bot bypass for JS-heavy SPAs
just-scrape extract https://app.example.com/dashboard \
  -p "Extract user stats" \
  --stealth
# Research across multiple sources
just-scrape search "What are the best Python web frameworks in 2025?" \
  --num-results 10

# Recent news only, scoped to Germany
just-scrape search "EU AI act latest news" \
  --time-range past_week --country de

# Structured output with schema
just-scrape search "Top 5 cloud providers pricing" \
  --schema '{"type":"object","properties":{"providers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"free_tier":{"type":"string"}}}}}}'

# With extraction prompt
just-scrape search "React vs Vue comparison" \
  -p "Summarize the key differences"

scrape

# Convert a page to markdown (the default format — replaces legacy markdownify)
just-scrape scrape https://blog.example.com/my-article

# Save markdown to a file
just-scrape scrape https://docs.example.com/api \
  --json | jq -r '.results.markdown.data[0]' > api-docs.md

# Get raw HTML with reader-mode extraction
just-scrape scrape https://blog.example.com -f html --html-mode reader

# Take a screenshot
just-scrape scrape https://example.com -f screenshot

# Extract branding info (logos, colors, fonts)
just-scrape scrape https://example.com -f branding

# Multi-format: markdown + links + images in a single call
just-scrape scrape https://example.com -f markdown,links,images

# Structured JSON output with a prompt
just-scrape scrape https://store.example.com \
  -f json -p "Extract product name and price"

# Geo-targeted + anti-bot bypass
just-scrape scrape https://store.example.com \
  -m js --stealth --country DE

crawl

# Crawl a docs site
just-scrape crawl https://docs.example.com \
  --max-pages 20 --max-depth 3

# Crawl and get HTML instead of markdown
just-scrape crawl https://example.com \
  --max-pages 50 -f html

# Allow external links
just-scrape crawl https://example.com \
  --max-pages 50 --allow-external

# Only crawl blog posts, skip tag archives
just-scrape crawl https://example.com \
  --include-patterns '["/blog/.*"]' \
  --exclude-patterns '["/tag/.*"]' \
  --max-pages 50

# Anti-bot bypass for protected sites
just-scrape crawl https://example.com -m js --stealth

monitor

# Monitor a pricing page every hour
just-scrape monitor create --url https://store.example.com/pricing --interval 1h

# Daily monitor tracking markdown + screenshots, with webhook
just-scrape monitor create --url https://example.com \
  --interval 1d -f markdown,screenshot \
  --webhook-url https://hooks.example.com/notify \
  --name "Daily check"

# List, pause, resume, delete
just-scrape monitor list
just-scrape monitor pause --id abc123
just-scrape monitor resume --id abc123
just-scrape monitor delete --id abc123

# Browse the tick history (runs the monitor has already performed)
just-scrape monitor activity --id abc123 --limit 20

# Only show ticks where a change was detected
just-scrape monitor activity --id abc123 --json \
  | jq '.ticks[] | select(.hasChanges == true)'

history

# Interactive history browser
just-scrape history extract

# Export last 100 extract jobs as JSON
just-scrape history extract --json --page-size 100 \
  | jq '.[] | {id, status}'

# Browse crawl history
just-scrape history crawl --json

# Fetch one specific request by id
just-scrape history scrape 550e8400-e29b-41d4-a716-446655440000 --json

credits

# Human-readable balance + job quotas
just-scrape credits

# Just the remaining credit count
just-scrape credits --json | jq '.remaining'

# Monitor quota usage
just-scrape credits --json | jq '.jobs.monitor'

validate

# Health-check your API key
just-scrape validate

# In a script — non-zero exit on failure
just-scrape validate --json | jq -e '.status == "ok"'