Sitemap
Scrape Sitemap
Discover crawlable URLs from robots and XML sitemaps.
/v1/web/scrape/sitemap
What you get
Developer-ready output for Scrape Sitemap
How it works
Four steps from request to usable JSON
Read robots.txt
Fetch sitemap indexes
Normalize discovered URLs
Apply maxLinks and urlRegex
API response
Fields developers usually wire first
Discover all page URLs from robots.txt, sitemap indexes and XML sitemap files.
curl.exe -H "X-API-Key: mh-localhost-dev-key" "http://127.0.0.1:8013/v1/web/scrape/sitemap"
Developer FAQ
Common questions about Scrape Sitemap
Should I call sitemap before crawl?
Usually yes. Sitemap gives you a clean seed list and helps avoid wasting crawl budget on navigation-only pages.
Can I filter only blog or product URLs?
Yes. Use urlRegex to keep only matching URLs, for example paths that contain /blog/, /docs/ or /products/.
What if the site has no sitemap?
The endpoint reports what it found. You can then fall back to /v1/web/crawl starting from the homepage or a known section URL.
What endpoint should I call for Scrape Sitemap?
Use GET /v1/web/scrape/sitemap. Local development accepts the X-API-Key header with mh-localhost-dev-key, and production clients can use the same shape with their own key.
Can I call it from CLI, SDK, MCP and no-code tools?
Yes. The same endpoint can be called with curl, the TypeScript SDK, Python SDK, MCP server, Zapier, Make, n8n, Google Sheets or Excel workflows where appropriate.
How does caching with maxAgeMs work?
When maxAgeMs is supported, a cached response can be reused if it is younger than the requested freshness window. Set maxAgeMs to 0 when you need a fresh scrape or extraction.
What happens when a page is blocked or requires login?
The API returns clear states such as blocked, verification_required, login_required, robots_disallowed or permission_required. It does not promise to bypass access controls.
Which response fields should I store?
Most integrations store urls[], meta.sitemapsFetched, meta.sitemapsSkipped, meta.errors, plus source URL, status, confidence and timestamp fields when present. Keep source metadata so users can audit values later.
Can I batch this endpoint?
For local or small workflows, loop over a list of URLs or domains. For larger jobs, use crawl, batch workflow endpoints or a queue so failures and retries are tracked cleanly.
How should I handle errors in production?
Check success, HTTP status, error.type and retryable flags. Retry timeouts and temporary network failures, but do not retry robots, login or permission errors without changing input or authorization.
Does the API work with JavaScript-heavy sites?
The engine router starts with fast fetching and escalates when content quality is low. Browser-style rendering is used where available, while access-control barriers are reported explicitly.
Is this safe to use with customer data?
Send only domains, URLs or fields your workflow needs. Use retention controls for generated artifacts and avoid storing unnecessary raw HTML, screenshots or extracted personal data.
Related data APIs
Build the next step in the workflow
POST /v1/web/crawl
Scrape HTML
Extract HTML from any accessible URL, including page frames when requested.
GET /v1/web/scrape/html
Scrape Markdown
Convert webpages to clean, LLM-ready Markdown with links, images and freshness controls.
GET /v1/web/scrape/markdown
Meta Title and Description
Extract title tags, meta descriptions, Open Graph, Twitter card, canonical URL and language metadata from a URL.
GET /v1/web/meta
Scrape Images
Extract images, responsive sources, CSS backgrounds, inline SVGs and video posters from any URL.
GET /v1/web/scrape/images
Royalty-Free Image Finder
Find attribution-free stock image links from curated providers for website heroes, sections and design mockups.
POST /v1/royalty-free-images/search
Image OCR
Extract text from image uploads, image URLs or base64 payloads with a Paddle-first OCR fallback chain.
POST /v1/ocr/json
YouTube Transcript
Fetch timestamped YouTube transcripts with a three-step fallback chain and minute-second labels.
POST /v1/youtube/transcript