Overview
Generates properly formatted XML compliant with search engine requirements, supporting up to 50,000 URLs per sitemap.
Endpoint
One host, one path per API. The block below shows this call in four languages; every one of them is the same HTTP request. Making requests covers the timeouts, retries and parameter rules that apply to all of them. The SDKs wrap the same call in a typed client.
curl -X POST https://api.apiverve.com/v1/sitemapgenerator \
-H "x-api-key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"urls": [
"/",
"/about",
"/contact",
{
"url": "/blog",
"priority": 0.8,
"changeFreq": "daily"
},
{
"url": "/products",
"priority": 0.9
}
],
"baseUrl": "https://example.com",
"changeFreq": "weekly",
"priority": 0.5,
"includeLastMod": true
}'const res = await fetch('https://api.apiverve.com/v1/sitemapgenerator', {
method: 'POST',
headers: {
'x-api-key': 'your_api_key_here',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"urls": [
"/",
"/about",
"/contact",
{
"url": "/blog",
"priority": 0.8,
"changeFreq": "daily"
},
{
"url": "/products",
"priority": 0.9
}
],
"baseUrl": "https://example.com",
"changeFreq": "weekly",
"priority": 0.5,
"includeLastMod": true
}),
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const { data } = await res.json();
console.log(data);import requests
res = requests.post(
"https://api.apiverve.com/v1/sitemapgenerator",
headers={"x-api-key": "your_api_key_here"},
json={
"urls": [
"/",
"/about",
"/contact",
{
"url": "/blog",
"priority": 0.8,
"changeFreq": "daily"
},
{
"url": "/products",
"priority": 0.9
}
],
"baseUrl": "https://example.com",
"changeFreq": "weekly",
"priority": 0.5,
"includeLastMod": True
},
timeout=15,
)
res.raise_for_status()
print(res.json()["data"])package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
body := strings.NewReader(`{
"urls": [
"/",
"/about",
"/contact",
{
"url": "/blog",
"priority": 0.8,
"changeFreq": "daily"
},
{
"url": "/products",
"priority": 0.9
}
],
"baseUrl": "https://example.com",
"changeFreq": "weekly",
"priority": 0.5,
"includeLastMod": true
}`)
req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/sitemapgenerator", body)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("x-api-key", "your_api_key_here")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}Replace your_api_key_here with the key from your dashboard. When the inputs arrive as a list rather than one at a time, batch requests run up to 200 of them through this same API in a single call.
Authentication
Send your key in the x-api-key header. That is the only auth step — there is no token exchange and no per-endpoint scope to configure. Authentication covers creating, rotating and revoking keys.
A 401 means the key is missing, invalid or expired. A 403 means the key is valid but not permitted here — blocked by a key restriction or an IP allow-list. Running out of credits is a 429.
Parameters
Sent as JSON in the request body. Premium parameters are accepted on every plan but only take effect on plans that include them.
| Parameter | Type | Description |
|---|---|---|
urlsRequired | array | Array of URLs (strings or objects with url, priority, changeFreq, lastMod) url |
baseUrlOptional | string | Base URL to prepend to relative paths url |
changeFreqOptional | string | Default change frequencyalwayshourlydailyweeklymonthlyyearlyneverdefault weekly |
priorityOptional | number | Default priority default 0.5 · range 0–1 |
includeLastModOptional | boolean | Include lastmod dates in sitemap default true |
Response
Every API returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape. Response format covers the envelope, the other output formats and how premium fields are withheld.
{
"status": "ok",
"error": null,
"data": {
"sitemap": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<urlset xmlns=\"http://www.sitemaps.org/schemas/sitemap/0.9\">\n <url>\n <loc>https://example.com/</loc>\n <lastmod>2025-12-16</lastmod>\n <changefreq>weekly</changefreq>\n <priority>0.5</priority>\n </url>\n <url>\n <loc>https://example.com/about</loc>\n <lastmod>2025-12-16</lastmod>\n <changefreq>weekly</changefreq>\n <priority>0.5</priority>\n </url>\n <url>\n <loc>https://example.com/contact</loc>\n <lastmod>2025-12-16</lastmod>\n <changefreq>weekly</changefreq>\n <priority>0.5</priority>\n </url>\n <url>\n <loc>https://example.com/blog</loc>\n <lastmod>2025-12-16</lastmod>\n <changefreq>daily</changefreq>\n <priority>0.8</priority>\n </url>\n <url>\n <loc>https://example.com/products</loc>\n <lastmod>2025-12-16</lastmod>\n <changefreq>weekly</changefreq>\n <priority>0.9</priority>\n </url>\n</urlset>",
"urlCount": 5,
"sizeBytes": 892,
"sizeKb": 0.87,
"format": "XML",
"protocol": "sitemaps.org/0.9",
"settings": {
"defaultChangeFreq": "weekly",
"defaultPriority": 0.5,
"includeLastMod": true,
"baseUrl": "https://example.com"
}
}
}Response fields
Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.
| Field | Type | Example | Description |
|---|---|---|---|
sitemap | string | "<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://example.com/</loc>
<lastmod>2025-12-16</lastmod>
<changefreq>weekly</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://example.com/about</loc>
<lastmod>2025-12-16</lastmod>
<changefreq>weekly</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://example.com/contact</loc>
<lastmod>2025-12-16</lastmod>
<changefreq>weekly</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://example.com/blog</loc>
<lastmod>2025-12-16</lastmod>
<changefreq>daily</changefreq>
<priority>0.8</priority>
</url>
<url>
<loc>https://example.com/products</loc>
<lastmod>2025-12-16</lastmod>
<changefreq>weekly</changefreq>
<priority>0.9</priority>
</url>
</urlset>" | Generated XML sitemap content following sitemaps.org protocol |
urlCount | number | 5 | Total number of URLs included in the generated sitemap |
sizeBytesPremium | number | 892 | Total size of generated sitemap in bytes |
sizeKbPremium | number | 0.87 | Total size of generated sitemap in kilobytes |
format | string | "XML" | Output format type of generated sitemap content |
protocol | string | "sitemaps.org/0.9" | Sitemap protocol version used for XML generation |
settings | object | {...} | |
defaultChangeFreq | string | "weekly" | Default change frequency setting applied to all URLs |
defaultPriority | number | 0.5 | Default priority value assigned to all URLs |
includeLastMod | boolean | true | Flag indicating if last modified dates are included |
baseUrl | string | "https://example.com" | Base URL used to create absolute paths for relative URLs |
Errors
Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change. Error handling covers the full status list and which of them are worth retrying.
| Status | Meaning | What to do |
|---|---|---|
400 | Input was rejected | Read error; it names the parameter. |
401 | Key missing or invalid | Check the header name and the key value. |
403 | Key valid, but not permitted | A key restriction or IP allow-list; see key scoping. |
429 | Rate limited, or out of credits | Read error to tell them apart; see rate limits. |
Use cases
- SEO Optimization
- Generate sitemaps to help search engines index website content
- Website Management
- Create and maintain XML sitemaps for content management systems
- Build Automation
- Integrate sitemap generation into website deployment pipelines
- Multi-site Management
- Generate sitemaps for multiple websites with custom configurations
Other ways to use Sitemap Generator
Set up Sitemap Generator on APIVerve, or reach the same source a different way. Your APIVerve account and credits work on all of them — one key, one balance.
Related
More in Data Generation: