Sitemap Generator API
Overview
To use Sitemap Generator, you need an API key. You can get one by creating a free account and visiting your dashboard.
POST Endpoint
https://api.apiverve.com/v1/sitemapgeneratorExample
How to call the Sitemap Generator API in different programming languages.
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 response = 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
})
});
const data = await response.json();
console.log(data);import requests
headers = {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
payload = {
"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
}
response = requests.post('https://api.apiverve.com/v1/sitemapgenerator', headers=headers, json=payload)
data = response.json()
print(data)package main
import (
"fmt"
"io"
"net/http"
"bytes"
"encoding/json"
)
func main() {
payload := map[string]interface{}{
"urls": "/,/about,/contact,[object Object],[object Object]",
"baseUrl": "https://example.com",
"changeFreq": "weekly",
"priority": "0.5",
"includeLastMod": "true"
}
jsonPayload, _ := json.Marshal(payload)
req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/sitemapgenerator", bytes.NewBuffer(jsonPayload))
req.Header.Set("X-API-Key", "your_api_key_here")
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}{
"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"
}
}
}Authentication
The Sitemap Generator API requires authentication via API key. Include your API key in the request header:
X-API-Key: your_api_key_hereInteractive API Playground
Test the Sitemap Generator API directly in your browser with live requests and responses.
Parameters
The following parameters are available for the Sitemap Generator API:
Generate Sitemap
| Parameter | Type | Required | Description | Default | Example |
|---|---|---|---|---|---|
urls | array | required | Array of URLs (strings or objects with url, priority, changeFreq, lastMod) Format: url (e.g., ["/about", "/contact", {"url": "/blog", "priority": 0.8}]) | - | |
baseUrl | string | optional | Base URL to prepend to relative paths Format: url (e.g., https://example.com) | - | |
changeFreq | string | optional | Default change frequency Supported values: alwayshourlydailyweeklymonthly | ||
priority | number | optional | Default priority Range: 0 - 1 | ||
includeLastMod | boolean | optional | Include lastmod dates in sitemap |
Response
The Sitemap Generator API returns responses in JSON, XML, YAML, and CSV formats. The JSON response is shown in the Example section above; alternative formats below.
Other Response Formats
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>ok</status>
<error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<data>
<sitemap><?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></sitemap>
<urlCount>5</urlCount>
<sizeBytes>892</sizeBytes>
<sizeKb>0.87</sizeKb>
<format>XML</format>
<protocol>sitemaps.org/0.9</protocol>
<settings>
<defaultChangeFreq>weekly</defaultChangeFreq>
<defaultPriority>0.5</defaultPriority>
<includeLastMod>true</includeLastMod>
<baseUrl>https://example.com</baseUrl>
</settings>
</data>
</response>
status: ok
error: null
data:
sitemap: |-
<?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>
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
| key | value |
|---|---|
| sitemap | <?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> | |
| 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 Structure
All API responses follow a consistent structure with the following fields:
| Field | Type | Description | Example |
|---|---|---|---|
status | string | Indicates whether the request was successful ("ok") or failed ("error") | ok |
error | string | null | Contains error message if status is "error", otherwise null | null |
data | object | null | Contains the API response data if successful, otherwise null | {...} |
Learn more about response formats →
Response Data Fields
When the request is successful, the data object contains the following fields:
| Field | Type | Sample Value | Description |
|---|---|---|---|
sitemap | string | - | |
urlCount | number | - | |
sizeBytes | number | - | |
sizeKb | number | - | |
format | string | - | |
protocol | string | - | |
settings | object | - | |
â”” defaultChangeFreq | string | - | |
â”” defaultPriority | number | - | |
â”” includeLastMod | boolean | - | |
â”” baseUrl | string | - |
Headers
Only X-API-Key is required. Optional headers include Accept for response format negotiation (JSON, XML, or YAML), User-Agent, and X-Request-ID for request tracing. See all request headers →
GraphQL AccessALPHA
Access Sitemap Generator through GraphQL to combine it with other API calls in a single request. Query only the sitemap generator data you need with precise field selection, and orchestrate complex data fetching workflows.
Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.
POST https://api.apiverve.com/v1/graphqlquery {
sitemapgenerator(
input: {
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
}
) {
sitemap
urlCount
sizeBytes
sizeKb
format
protocol
settings {
defaultChangeFreq
defaultPriority
includeLastMod
baseUrl
}
}
}Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.
CORS Support
The Sitemap Generator API accepts cross-origin requests from any origin, so it can be called directly from browser-based applications without a proxy. See CORS support →
Rate Limiting
Sitemap Generator requests are throttled per minute on the Free plan and unthrottled on paid plans. Exceeding the limit returns 429 Too Many Requests; rate-limit usage is reported in the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers. See per-plan limits and best practices →
Error Codes
The Sitemap Generator API uses standard HTTP status codes — 200 on success, 400 for invalid parameters, 401 for missing or invalid keys, 403 for insufficient credits, 429 for rate-limit exhaustion, and 500/503 for server-side issues. Each error response includes an X-Request-ID header you can quote when contacting support. See full error handling guide →
SDKs for Sitemap Generator
Official Sitemap Generator packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →
No-Code Integrations
Sitemap Generator works with Zapier, Make, Pipedream, n8n, and Power Automate using the same API key. See setup guides →
Frequently Asked Questions
How do I get an API key for Sitemap Generator?
How many credits does Sitemap Generator cost?
Each successful Sitemap Generator API call consumes credits based on plan tier. Check the pricing section above for the exact credit cost. Failed requests and errors don't consume credits, so you only pay for successful sitemap generator lookups.
Can I use Sitemap Generator in production?
The free plan is for testing and development only. For production use of Sitemap Generator, upgrade to a paid plan (Starter, Pro, or Mega) which includes commercial use rights, no attribution requirements, and guaranteed uptime SLAs. All paid plans are production-ready.
Can I use Sitemap Generator from a browser?
What happens if I exceed my Sitemap Generator credit limit?
When you reach your monthly credit limit, Sitemap Generator API requests will return an error until you upgrade your plan or wait for the next billing cycle. You'll receive notifications at 80% and 95% usage to give you time to upgrade if needed.








