Sitemap URLs Beta
GET /api/v1/sitemap-urls
Harvests every URL from a site's XML sitemaps, following the sitemap index — the seed list for any bulk job. Where /api/v1/sitemap returns a 100-URL sample plus validation statistics, this returns the full list.
Beta. This endpoint is new: it is live and safe to call on every plan, but its response shape may still change while we take feedback. Nothing here is scheduled for removal — if you depend on a particular field, tell us and we will keep it stable for you.
A sitemapindex is followed into up to 50 children. Only same-origin <loc> entries are collected, and every sitemap fetched along the way is independently SSRF-checked.
Authentication
Send your API key as an X-API-Key header, or as a key query parameter. Available on every plan, including Free — plans differ only in requests per day. This call costs one request against your daily quota, which is shared across every key on the account. See Authentication.
Query parameters
| Name | Type | Description |
|---|---|---|
url required | string | Any URL on the site — the sitemap is discovered from it. |
limit optional | integer | Maximum URLs returned. Default 1000, maximum 50000. |
key optional | string | Your API key, if not sent as the X-API-Key header. |
Request
Response
200 · application/json
- {
- "sitemapUrl": "https://example.com/sitemap.xml", "found": true,
- "count": 248, "limit": 500,
- "urls": ["https://example.com/", "https://example.com/about"],
- "usage": { "used": 1, "dailyLimit": 100, "tier": "free" }
- }
Response fields
| Field | Type | Description |
|---|---|---|
sitemapUrl | string | The sitemap that was discovered and read. |
found | boolean | false with count: 0 when no sitemap exists at the discovered location. |
count | integer | How many URLs are in urls — after the limit is applied. |
urls | string[] | The harvested URLs. |
Errors
| Status | When |
|---|---|
401 | Missing or invalid API key. |
403 | The URL is a private, loopback or cloud-metadata address and was blocked by SSRF protection. |
429 | Burst rate limit (60 req/10s per IP, 30 req/10s per key) or your daily quota. See Rate limits. |
502 | The sitemap could not be read. |
Errors return { "error": "…" }; see Errors.