Sitemap URLs of a website

Every URL a site lists in its XML sitemaps: the sitemaps are found from robots.txt (or /sitemap.xml and /sitemap_index.xml), sitemap indexes are followed, gzip sitemaps and plain-text sitemaps are read. The first page also lists sitemaps (with lastmod for sitemaps named in an index). Each URL has lastmod, changefreq, priority, image and video counts, hreflang alternates (alternates=true; their count otherwise), the news title for news sitemaps and the sitemap it came from. Pass sitemap to read one sitemap only. Pass next_cursor back as cursor; null on the last page.

Every response includes credits_used: the credits this call cost.

Parameters

Every endpoint also takes fresh, raw, fields (see lean responses and caching).

Example

curl "https://api.api.sh/web/v1/sitemap?url=https%3A%2F%2Fwww.bbc.com" \
  -H "x-api-key: $APISH_KEY"

import os, requests

res = requests.get(
    "https://api.api.sh/web/v1/sitemap",
    params={"url": "https://www.bbc.com"},
    headers={"x-api-key": os.environ["APISH_KEY"]},
    timeout=120,
)
res.raise_for_status()
data = res.json()

const url = new URL("https://api.api.sh/web/v1/sitemap");
url.searchParams.set("url", "https://www.bbc.com");

const res = await fetch(url, { headers: { "x-api-key": process.env.APISH_KEY } });
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const data = await res.json();

Response

A JSON object with the fields described above, plus raw (the source's own data), cached, fetched_at and credits_used. Errors return {"success": false, "error": "…"} with the HTTP status (see errors). A lookup that ran but found nothing (404) costs the price above; refused calls and errors on our side are free (what's charged).