Sitemap Extraction API Documentation

Choose the sitemap API endpoint

Make your first request

curl https://sitemapkit.com/api/v1/sitemap/full \
  -X POST \
  -H "x-api-key: sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com"}'

The free tier includes 20 processing credits per month. Create an API key, or open the OpenAPI 3.1 document directly.

Credits and capacity

Extraction and monitoring use 1 credit per 1,000 URLs returned, rounded up, with a minimum of 1. Discovery uses 1 credit. Cached API and member tool responses use no credits. Failed executions are refunded. Credits reset on the first day of each UTC calendar month.

An execution temporarily reserves credits for its requested maximum. Unused credits are returned when it finishes. If your remaining quota is smaller, the URL limit is reduced to fit. A 429 response means your plan limit was reached; a 503 with CRAWL_CAPACITY_BUSY means the shared queue is full or unavailable. Respect Retry-After before retrying.

What the sitemap extraction API returns

The full endpoint reports how many sitemap files it found and processed, followed by one deduplicated URL list. The truncated field tells you when the response reached your maxUrls limit.

{
  "success": true,
  "data": {
    "domain": "example.com",
    "sitemapsDiscovered": 3,
    "sitemapsProcessed": 3,
    "urls": [
      {
        "loc": "https://example.com/page",
        "lastmod": "2026-08-20",
        "changefreq": null,
        "priority": null
      }
    ],
    "totalUrls": 1284,
    "truncated": false,
    "sources": ["robots.txt", "sitemap-index"]
  }
}

Each URL record includes loc and preserves lastmod, changefreq, and priority when the source sitemap provides them.

Run the sitemap API from your terminal

The open-source SitemapKit CLI wraps the discovery and extraction endpoints for shell scripts and CI jobs. It prints JSON to standard output and returns a non-zero exit code when a request fails.

export SITEMAPKIT_API_KEY=sk_live_...
npx github:0nl1n1n/sitemapkit-cli full https://example.com

View the commands and source on GitHub.

Test all three endpoints in Postman

Import the collection, set its apiKey variable, and run ready-made requests for discovery, extraction, or both. Each request checks for a successful JSON response.

Download the SitemapKit Postman collection