Get started

Quickstart

Make your first scrape in under two minutes.

1. Get an API key

Create a free account, verify your email, and copy your key from Dashboard → API Keys. The Free tier includes 1,000 credits — no card required.

2. Install the SDK

npm install scrapeflow
# or: pnpm add scrapeflow / yarn add scrapeflow

3. Set your key

bash

export SCRAPEFLOW_API_KEY="sf_live_xxx"
export SCRAPEFLOW_API_URL="https://api.scrapeflow.dev"

4. Make your first request

import ScrapeFlow from "scrapeflow";

const client = new ScrapeFlow({ apiKey: process.env.SCRAPEFLOW_API_KEY });

const page = await client.web.scrape({
  url: "https://news.ycombinator.com",
  formats: { markdown: true, links: true },
});

console.log(page.data.markdown);   // clean Markdown
console.log(page.data.links);      // extracted links

ℹ

Requests are only billed on a successful 2xx response. Failed and rate-limited requests never consume credits.

5. Scale up: batches & crawls

For large jobs, submit a batch of URLs or crawl a whole site. These run in the background on the SNS → SQS fan-out and return one dataset.

const batch = await client.batches.create({
  urls: ["https://a.com", "https://b.com" /* up to 25,000 */],
  formats: { markdown: true },
});

const done = await batch.wait();   // polls until complete
console.log(done.results.length);

Agent quickstart

Using a coding agent? Paste this one line and it will read the setup doc, install the SDK, and wire up your key:

text

Use curl to read https://docs.scrapeflow.dev/agent-quickstart.md, then follow it to set up ScrapeFlow for me.