API reference

Base URL: https://scraperfeeds.com/api/public/v1

Authentication

Create an API key in your dashboard. Keys start with sf_live_ (older ff_live_ keys still work) and are shown only once — store them securely. Send it as a bearer token or the x-api-key header.

curl https://scraperfeeds.com/api/public/v1/feeds/cannabis-deals-api \
  -H "Authorization: Bearer $SCRAPERFEEDS_API_KEY"

Endpoints

GET/v1/feeds/{slug}

Returns the latest records for a subscribed feed. Query params are passed as filters (e.g. city, state, zip). Add format=csv for CSV.

POST/v1/tools/scrape

Scrape a single URL (beta).

POST/v1/tools/batch-scrape

Submit a batch scrape job (beta).

POST/v1/tools/contacts

Find business contacts for a domain (beta).

POST/v1/tools/events

Extract events from an ICS or calendar URL (beta).

Rate limits

Each key is limited to 60 requests per minute. Exceeding the limit returns 429. Paid tiers are coming soon.

Response format

Feed JSON responses contain data and meta. When the scraper is not configured, sample responses have meta.sample: true; CSV responses use the x-scraperfeeds-sample header. Tool output follows the connected scraper’s response format.

{
  "data": [ { "...": "..." } ],
  "meta": { "count": 50, "page": 1, "next_page": 2 }
}

Errors

{ "error": { "status": 403, "message": "Not subscribed to this feed" } }

401 missing, invalid or revoked key
403 not subscribed to the feed
404 feed not found or not yet available
503 scraper not configured
502 scraper request failed
429 rate limit exceeded