Scrape a single URL
operationId: scrape
Fetch one URL and return clean, LLM-ready content (markdown by default; also html, text, links, screenshot, token-counted chunks, metadata or brand). Starts with plain HTTP and escalates to a headless browser only when the page needs it. 1 credit per page, browser included; failed pages cost 0.
Idempotency-Keystringheadermax 255 chars
urlstring (uri)required- Basic metadata (title, description, language, canonical, status) is always returned;
metadataadds parsed JSON-LD. onlyMainContentbooleandefault truesiteMarkdownbooleandefault falseUse the site's own markdown when it serves one (Accept: text/markdown, e.g. many docs sites) and it passes the quality check; otherwise the HTML is extracted as usual. About 2x faster where available, but usually with less metadata (no language or canonical URL). Ignored with thehtml,rawHtmlorlinksformats.includeTagsstring[]excludeTagsstring[]tier"auto" | "fetch" | "render" | "premium"default "auto"auto escalates fetch → render when the page needs it.premiumis not available yet.allowPremiumbooleandefault falseNot available yet; requests with it set are refused.waitForinteger≤ 30000timeoutintegerdefault 300001000–60000maxAgeintegerdefault 172800000Serve a cached copy younger than this (ms). Default 2 days; 0 forces a fresh scrape. Cache hits are served from the nearest data center.headersRecord<string, string>screenshotOptionsScreenshotOptionsHow the screenshot formats capture the page. Needs thescreenshotorscreenshotFullformat. Page actions run in the same window first. If the capture fails the scrape still succeeds without a screenshot, andquality.escalationssays why:screenshot:element_not_found,screenshot:invalid_selector,screenshot:element_not_visible,screenshot:timeoutorscreenshot:render_failed.locationobjectShowHide 2 fields
countrystringlanguagesstring[]
chunkSizeintegerdefault 1500200–8000ignoreRobotsbooleandefault falseSkip the robots.txt check. Only set this when you have permission to fetch the page.
OKapplication/json
successtruerequiredcredits_usedintegerrequiredrequest_idstringrequiredlatency_msinteger
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", "formats": ["markdown", "metadata"] }'{
"success": true,
"data": {
"url": "https://example.com",
"finalUrl": "https://example.com/",
"markdown": "# Example Domain\n\nThis domain is for use in illustrative examples.",
"metadata": {
"title": "Example Domain",
"description": "This domain is for use in illustrative examples.",
"language": "en",
"canonicalUrl": "https://example.com/",
"statusCode": 200,
"contentType": "text/html; charset=UTF-8",
"publishedAt": "2026-09-01",
"author": "Jane Doe",
"ogImage": "https://example.com/og.png"
},
"tier": "fetch",
"cached": false,
"quality": {
"score": 0.97,
"issues": [
"thin_content"
],
"escalations": [
"string"
],
"reason": "Plain fetch returned complete content; no escalation needed."
}
},
"credits_used": 1,
"latency_ms": 184,
"request_id": "req_01J9V3KX7Q"
}