Hyperscrape
Docs

Getting Started

Quickstart

Run your first scraper from the console and the API in minutes.

1. Create an account

Sign up for free. Every account starts with 200 free credits — no credit card required.

2. Run from the console

Open the Store, choose a scraper, fill in the input form, and click Run. You'll be taken to the run page where logs stream in live and results appear in the dataset as they're scraped.

3. Get an API key

Go to Console → Settings → API Keys and create a key. It looks like:

hs_live_a1b2c3d4e5f6...

Store it securely — it's shown only once.

4. Run from the API

Start a run and wait up to 120 seconds for it to finish:

curl -X POST \
  "https://hyperscrape.com/api/v1/scrapers/website-content-crawler/runs?waitForFinish=120" \
  -H "Authorization: Bearer $HYPERSCRAPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "startUrls": ["https://example.com"], "maxPages": 10 }'

The response includes a datasetItemsUrl. Fetch the results:

curl "https://hyperscrape.com/api/v1/datasets/DATASET_ID/items?format=json" \
  -H "Authorization: Bearer $HYPERSCRAPE_API_KEY"

Next steps

← IntroductionWeb Unlocker →