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 structured data from any URL using AI (replaces smart-scraper). Full docs →
just-scrape extract <url> -p <prompt>
just-scrape extract <url> -p <prompt> --schema <json>
just-scrape extract <url> -p <prompt> --scrolls <n>     # infinite scroll (0-100)
just-scrape extract <url> -p <prompt> --stealth          # anti-bot bypass
just-scrape extract <url> -p <prompt> --mode reader      # HTML mode: normal (default), reader, prune
just-scrape extract <url> -p <prompt> --cookies <json> --headers <json>
just-scrape extract <url> -p <prompt> --country <iso>    # geo-targeting
Search the web and extract structured data from results (replaces search-scraper). Full docs →
just-scrape search <query>
just-scrape search <query> -p <prompt>                   # extraction prompt for results
just-scrape search <query> --num-results <n>             # sources to scrape (1-20, default 3)
just-scrape search <query> --schema <json>
just-scrape search <query> --country <code>              # geo-target (e.g. 'us', 'de', 'jp-tk')
just-scrape search <query> --time-range <range>          # past_hour | past_24_hours | past_week | past_month | past_year
just-scrape search <query> --format <markdown|html>      # result format (default markdown)
just-scrape search <query> --headers <json>

scrape

Scrape content from a URL in one or more formats. Supports 8 formats: markdown, html, screenshot, branding, links, images, summary, json. Full docs →
just-scrape scrape <url>                                 # markdown (default)
just-scrape scrape <url> -f html                         # raw HTML
just-scrape scrape <url> -f screenshot                   # page screenshot
just-scrape scrape <url> -f branding                     # branding info (logos, colors, fonts)
just-scrape scrape <url> -f links                        # all links on the page
just-scrape scrape <url> -f images                       # all images on the page
just-scrape scrape <url> -f summary                      # AI-generated page summary
just-scrape scrape <url> -f json -p <prompt>             # structured JSON via prompt
just-scrape scrape <url> -f json -p <prompt> --schema <json>  # JSON with enforced schema
just-scrape scrape <url> -f markdown,links,images        # multi-format (comma-separated)
just-scrape scrape <url> --html-mode reader              # normal (default), reader, or prune
just-scrape scrape <url> --scrolls <n>                   # infinite scroll (0-100)
just-scrape scrape <url> -m js --stealth                 # anti-bot bypass (fetch mode: auto, fast, js)
just-scrape scrape <url> --country <iso>                 # geo-targeting

crawl

Crawl multiple pages. The CLI starts the crawl and polls until completion. Full docs →
just-scrape crawl <url>
just-scrape crawl <url> --max-pages <n>                  # max pages (default 50)
just-scrape crawl <url> --max-depth <n>                  # crawl depth (default 2)
just-scrape crawl <url> --max-links-per-page <n>         # max links per page (default 10)
just-scrape crawl <url> --allow-external                 # allow external domains
just-scrape crawl <url> --include-patterns '["/blog/.*"]'   # regex allow-list (JSON array)
just-scrape crawl <url> --exclude-patterns '["/tag/.*"]'    # regex deny-list (JSON array)
just-scrape crawl <url> -f html                          # page format (default markdown)
just-scrape crawl <url> -f markdown,links,images         # multi-format (comma-separated)
just-scrape crawl <url> -m js --stealth                  # anti-bot bypass

monitor

Create and manage page-change monitors. A monitor periodically re-scrapes a URL and tracks diffs between ticks. Full docs →
just-scrape monitor create --url <url> --interval <interval>    # e.g. '1h', '30m', '1d'
just-scrape monitor create --url <url> --interval 1h --name "My Monitor"
just-scrape monitor create --url <url> --interval 30m --webhook-url <url>
just-scrape monitor create --url <url> --interval 1d -f markdown,screenshot
just-scrape monitor list                                        # list all monitors
just-scrape monitor get --id <id>                               # get monitor details
just-scrape monitor update --id <id> --interval 2h              # update interval
just-scrape monitor pause --id <id>                             # pause
just-scrape monitor resume --id <id>                            # resume
just-scrape monitor delete --id <id>                            # delete
just-scrape monitor activity --id <id>                          # paginated tick history
just-scrape monitor activity --id <id> --limit 50               # ticks per page (max 100)
just-scrape monitor activity --id <id> --cursor <cursor>        # paginate with a cursor

history

Browse request history. Interactive by default — arrow keys to navigate, select to view details, “Load more” for pagination.
just-scrape history                                      # all services, interactive
just-scrape history <service>                            # filter by service
just-scrape history <service> <request-id>               # fetch a specific request
just-scrape history <service> --page <n>                 # start from page (default 1)
just-scrape history <service> --page-size <n>            # results per page (max 100)
just-scrape history <service> --json
Services: scrape, extract, search, monitor, crawl

credits

Check your credit balance and per-job quotas.
just-scrape credits
just-scrape credits --json | jq '.remaining'
just-scrape credits --json | jq '.jobs.monitor'

validate

Validate your API key by calling the SDK’s health endpoint. Returns { "status": "ok", "uptime": ... } on success.
just-scrape validate
just-scrape validate --json

Global flags

All commands support these flags:
FlagDescription
--jsonMachine-readable JSON output, no spinners or banners
--helpShow help for a command