Documentation
Every endpoint, every parameter, real responses pulled from the live API.
Try it now
Every endpoint, ready to send in Postman.
Import the official collection with one click. Set your {{api_key}} variable once, every request is pre-configured. Also available as a downloadable JSON if you prefer.
Getting started
POST
/v1/scrape
Quickstart
Get your first response in under five minutes.
GET
/v1/me
Authentication
Every call needs an Authorization header with your API key.
GET
/v1/me
Rate limits and quotas
Per-minute rate limits and per-month quotas — both enforced.
POST
/v1/scrape/async
Idempotency
Safely retry async-creating endpoints without queuing duplicate jobs or double-charging credits.
GET
/v1/*
Errors and retry strategy
Predictable error codes, a recommended retry pattern, and the request ID to quote in support tickets.
Scraping
POST
/v1/scrape
Scrape a single URL
Fetch one URL, get back clean structured data in your chosen format.
POST
/v1/scrape/smart
Smart scrape (auto-routing)
Skip the browser when the page does not need it.
POST
/v1/scrape/batch
Batch scrape
Up to 100 URLs in parallel, one response.
POST
/v1/scrape/async
Async scrape
Queue a single scrape, receive a webhook when ready.
POST
/v1/scrape/batch/async
Async batch scrape
Fire-and-forget for large jobs.
GET
/v1/jobs/{id}
Job status
Poll any queued job.
POST
/v1/captcha/solve
Solve reCAPTCHA v3 (invisible)
Solve a reCAPTCHA v3 invisible challenge for a known site key and return the token.
POST
/v1/captcha/auto
Auto-detect and solve (v3)
Fetch a URL, detect the reCAPTCHA v3 site key on the page, solve it, return the token — in one call.
Extraction
POST
/v1/extract/clean
Clean article extraction
Readability extraction — strips nav, ads, sidebars.
POST
/v1/extract/structured
Structured data extraction
JSON-LD, Microdata, OpenGraph, Twitter Card.
POST
/v1/extract/contacts
Extract contacts from text or HTML
Pull every email, phone, and social profile URL out of a text or HTML blob.
POST
/v1/extract/tables
Extract HTML tables
Parse every <table> in an HTML blob into structured rows. Colspan and rowspan expanded.
Intelligence
POST
/v1/dns/lookup
DNS lookup
Raw DNS records: A, MX, TXT, NS, CNAME, AAAA.
POST
/v1/dns/intelligence
DNS intelligence
Email provider, nameserver provider, SPF/DMARC, tech inference.
POST
/v1/intel/ssl
SSL certificate
Issuer, expiry, SANs, days remaining.
POST
/v1/intel/whois
WHOIS
Registrar, creation, expiry, contact emails, nameservers.
POST
/v1/intel/page
Page intelligence
Tech stack, contacts, logos, feeds, images.
POST
/v1/intel/sitemap
Sitemap unroll
Unroll any sitemap.xml, including nested index sitemaps.
POST
/v1/intel/robots
Robots compliance check
Is this path allowed for a given user agent?
POST
/v1/verify/email
Email verification
SMTP handshake, MX check, catch-all and disposable detection.
POST
/v1/intel/geoip
IP geolocation
Country, region, city, lat/lon, timezone, ASN and ISP for any public IP.
POST
/v1/intel/asn
ASN lookup
Operator name and every routed CIDR prefix for an Autonomous System Number.
POST
/v1/intel/geoip/bulk
Bulk IP geolocation
Geolocate up to 100 IPs in a single call. Same enrichment per IP as /v1/intel/geoip.
POST
/v1/intel/headers
Response headers + security grade
Fetch a URL, return every response header, score the security headers A–F.
POST
/v1/intel/redirects
Redirect chain trace
Follow the redirect chain hop by hop, report every URL and status code along the way.
POST
/v1/intel/uptime
Uptime probe
Is the URL up? Status code, latency, SSL expiry warning. One HEAD (or GET fallback).
POST
/v1/intel/email-auth
Email authentication audit
SPF + DKIM + DMARC + BIMI parsed and scored A–F for a domain.
POST
/v1/intel/blacklist
DNSBL blacklist check
Check an IP or domain against the major DNSBLs in parallel: Spamhaus ZEN, Barracuda, SpamCop, SORBS, PSBL, SURBL.
POST
/v1/intel/dns-propagation
DNS propagation check
Query the same DNS record across nine public resolvers and report consistency.
POST
/v1/intel/ip-reputation
IP reputation classification
Is this IP a known datacenter, cloud range, or Tor exit?
AEO
POST
/v1/aeo/ai-bot-allowlist
AI bot allowlist audit
For each of 14 named AI crawlers, report whether your site's robots.txt allows or blocks it.
POST
/v1/aeo/llms-txt-audit
llms.txt audit
Validate a site's /llms.txt against the AEO-readiness convention. Score completeness and detect link rot.
POST
/v1/aeo/schema-coverage
Schema coverage audit
Parse every JSON-LD / Microdata / OpenGraph block; score coverage against the 12 schema.org types AEO answer engines weight most.
POST
/v1/aeo/citation-readiness
Citation readiness (post-ChatGPT EEAT)
Score a page on five mechanical EEAT signals correlated with LLM citation: numerical specifics, named entities, authoritative outbound links, author byline, last-updated date.
POST
/v1/aeo/llm-fetch-simulator
LLM fetch simulator
Fetch a URL as each of 11 named AI crawlers and a browser baseline. See what each one actually receives.
POST
/v1/aeo/page-audit
Full AEO page audit (premium)
One-call AEO scorecard: runs 9 component probes in parallel and returns one 0–100 score, five category breakdowns, top issues, and ranked recommendations.
POST
/v1/aeo/competitor-diff
Competitor AEO diff (premium)
Run page-audit on 2–5 URLs in parallel; return rankings, head-to-head category breakdowns, and where the first URL beats vs trails competitors.
SEO
POST
/v1/seo/meta-audit
On-page SEO meta audit
Score a page's SEO meta fields A–F: title, meta description, canonical, H1, Open Graph, robots.
POST
/v1/seo/readability
Readability scoring
Six standard readability formulas plus reading time. No fetch — you supply the text.
POST
/v1/seo/snippet-candidates
Featured-snippet candidates
Extract paragraphs, lists, and tables that look like featured-snippet candidates — from HTML you provide OR from a URL we fetch.
Parsing
POST
/v1/parse/url
Parse URL
Decompose a URL into scheme, host, path, query, fragment plus the public suffix and registrable domain.
POST
/v1/parse/useragent
Parse User-Agent
Decode a User-Agent string into browser, OS, device, and a single device-kind label.
POST
/v1/parse/email
Parse email
Syntax check, normalize, and flag role/disposable/free-provider addresses — no SMTP probe.
Conversion
POST
/v1/convert/html-to-markdown
HTML to Markdown
Convert raw HTML to clean Markdown — same converter as scrape, but you supply the HTML.
POST
/v1/convert/pdf-to-markdown
PDF to Markdown
Send base64-encoded PDF bytes, get clean Markdown back. Page-per-section output. Scanned PDFs are flagged.
POST
/v1/convert/docx-to-markdown
Word DOCX to Markdown
Convert modern Word documents into Markdown — headings, paragraphs, lists, and tables.
POST
/v1/convert/xlsx-to-markdown
Excel XLSX to Markdown
Excel workbook → Markdown. One section per sheet, each rendered as a Markdown table.
POST
/v1/convert/pptx-to-markdown
PowerPoint PPTX to Markdown
Slide decks to Markdown — one section per slide, with titles, bullets, and speaker notes.
POST
/v1/convert/csv-to-markdown
CSV to Markdown
CSV text into a Markdown table. Delimiter auto-detected (<code>,</code> <code>;</code> <code>|</code> <code>\t</code>).