Sitemap
GET /api/v1/sitemap
Locate (from robots.txt or /sitemap.xml), parse and analyse a site's XML sitemap — URL count, sitemap-index children, and lastmod coverage. Works on both a plain urlset and a sitemap index.
Query parameters
| Name | Type | Description |
|---|---|---|
url required | string | Any URL on the site; we discover the sitemap from its origin. |
key | string | Your API key, if not sent via the X-API-Key header. |
Request
Response
200 · application/json
- {
- "url": "https://example.com/sitemap.xml",
- "found": true,
- "statusCode": 200,
- "type": "urlset",
- "childSitemapCount": 0,
- "childSitemaps": [],
- "urlCount": 132,
- "urlsHaveLastmod": 132,
- "lastmodCoverage": 100,
- "tooLarge": false,
- "sample": [ { "loc": "https://example.com/", "lastmod": "2026-06-01" } ]
- }
Response fields
| Field | Type | Description |
|---|---|---|
found | boolean | Whether a valid XML sitemap was located and parsed. |
statusCode | integer | HTTP status returned for the sitemap request. |
type | string | urlset for a plain sitemap, or index for a sitemap index. |
childSitemapCount | integer | Number of child sitemaps listed (for a sitemap index). |
childSitemaps | array | Child sitemap URLs — we aggregate URL counts from up to 5 children. |
urlCount | integer | Total URLs found. |
urlsHaveLastmod | integer | How many of those URLs carry a <lastmod>. |
lastmodCoverage | number | Percentage of URLs with a lastmod. |
tooLarge | boolean | True if the sitemap exceeds 50k URLs or 50MB. |
sample | array | A sample of URLs, each with its loc and lastmod. |
To check the rules and declared sitemaps, use robots.txt. See Errors for status codes.