Endpoint

Expand a sitemap.

Every URL on a domain without hand-enumerating them. Give it any URL on the site; it finds the sitemaps (or the feeds) and flattens them into a list.

POST/v1/sitemapAPI key

Find and expand a site's sitemaps, or its feeds, into a flat URL list.

Body

Field	Type	Detail
url required	string	Any URL on the site.
target	"sitemap" \| "feeds"	Which walker to run. Default sitemap.

request

curl https://api.snakereach.com/v1/sitemap \
  -H "X-API-Key: $SNAKEREACH_API_KEY" \
  -H "content-type: application/json" \
  -d '{"url": "https://example.com", "target": "sitemap"}'

200 response

{
  "url": "https://example.com",
  "target": "sitemap",
  "urls": [
    "https://example.com/article",
    "https://example.com/docs"
  ],
  "count": 2
}

Errors

422 target was neither sitemap nor feeds

Where it looks

robots.txt first, then the conventional locations, following sitemap index files into their children. An empty list means no sitemap was found, not an error, and common on small or hand-built sites.

Bare-IP hosts are not walked, so this returns an empty list against something like http://127.0.0.1:8000 even when that host serves a sitemap.

Feeding it onward

The usual pattern is sitemap → filter the list → scrape each URL. If you would rather follow links than enumerate them, use crawl, which seeds itself from sitemaps automatically.