Browse docs
Documentation
The field guide.
One API to scrape, crawl, map, search, extract and brand the web, with honest quality reports and free failures. Here's everything you need to set the rats loose.
curl -X POST "https://api.vermin.dev/v1/scrape" \
-H "Authorization: Bearer $VERMIN_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "url": "https://example.com" }'What it gets into
- static & marketing
- SPAs & JS-heavy
- docs
- e-commerce
- news & blogs
- forums
- PDFs & files
- non-English & RTL
- huge pages
- slow origins
Getting started
- QuickstartFrom zero to your first scraped page in under two minutes.
- AuthenticationAPI keys, permissions, budgets, expiry, idempotency and request ids.
- Credits & billingWhat each call costs, why failures are free, rollover, top-ups and spend caps.
- Rate limitsRequests per minute, concurrency and how to back off gracefully.
- ErrorsEvery error code the API can return, what it means and what to do. Generated from the spec.
Endpoints
- ScrapePOST /v1/scrapeOne URL in, clean markdown, HTML, screenshots, chunks, metadata or brand out.
- CrawlPOST /v1/crawlWhole sites, asynchronously. Stream pages live, poll with cursors or get webhooks.
- MapPOST /v1/mapEvery URL on a site in one call, optionally ranked against a query.
- SearchPOST /v1/searchWeb search results, optionally scraped to full markdown in the same request.
- ExtractPOST /v1/extractTyped JSON from up to 25 URLs, validated against your JSON Schema. Valid or free.
- BrandGET /v1/brandLogo, icon, colours, fonts, name and socials for any domain. Cached globally.