Skip to content

New AI assistant answers: ChatGPT, Gemini, Copilot and AI Mode by API

SerpKite
Get API key

POST /v1/map

Website Map API

Find every page of a site without crawling it. SerpKite reads robots.txt and the sitemaps, adds the start page's links, cleans and de-duplicates the URLs, and ranks them against your search words.

Get a free API key Read the reference
1 credit per call that found URLs (free when nothing is found) 2,500 free credits, no card Failed calls are free

Overview

What the Website Map API does

The Website Map API lists the pages of a website without reading them. It reads the sitemaps named in robots.txt (or /sitemap.xml), follows sitemap indexes, understands XML, gzip, RSS/Atom and plain-text sitemaps, and adds the links of the start page.

URLs are cleaned (fragments and tracking parameters such as utm_*, gclid and fbclid dropped), kept on the site's host, filtered by your path regexes and de-duplicated. With search, they are ranked by how well their path words and titles match it, so search: "pricing" puts the pricing pages first.

Use it to choose what to read next with the Web Extract API, or to scope a crawl.

What you get

request object
The normalised request: url, limit, sitemap, include_subdomains, and the filters you sent.
results[] array
url, title (link text or page title, when known), lastmod (the sitemap's, as written), source (sitemap or page).
meta object
request_id, credits_used, latency_ms, count.

Request

curl https://api.serpkite.com/v1/map \
  -H "Authorization: Bearer $SERPKITE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://docs.python.org/3/","search":"asyncio","limit":50}'

Response (illustrative, placeholder domains)

200 OK · application/json 
{
  "request": {
    "endpoint": "map",
    "url": "https://docs.python.org/3/",
    "limit": 50,
    "sitemap": "include",
    "include_subdomains": false,
    "search": "asyncio"
  },
  "results": [
    {
      "url": "https://docs.python.org/3/library/asyncio.html",
      "title": "asyncio — Asynchronous I/O",
      "source": "page"
    },
    {
      "url": "https://docs.python.org/3/library/asyncio-task.html",
      "lastmod": "2026-09-01",
      "source": "sitemap"
    }
  ],
  "meta": {
    "request_id": "req_01J8ZK4M6Q2V7",
    "credits_used": 1,
    "latency_ms": 840,
    "count": 2
  }
}

Every response also carries X-Credits-Used, X-Credits-Remaining, X-Cache and X-Tokens-Estimate headers. Full endpoint reference

Reference

Parameters

The fields /v1/map accepts in its JSON body.

Website Map API parameters
Name Type Default Description
url required string – Any page of the site. Sitemaps are read from its origin.
search string – Keep only URLs relevant to these words, most relevant first (up to 512 characters). With a thin sitemap, also reads up to 8 linked pages one level deeper.
limit integer 100 URLs to return, 1–5,000.
sitemap string include include sitemaps and the start page's links, only sitemaps, skip sitemaps (links only). Values: include, only, skip.
include_subdomains boolean false Also keep URLs on subdomains of the start page's host.
include_paths string[] – Up to 20 regular expressions matched against the URL path; keep only paths matching one, e.g. ^/docs/.
exclude_paths string[] – Up to 20 regular expressions matched against the URL path; never keep paths matching one.
ignore_query_parameters boolean false Treat URLs that differ only in their query string as one (the first one found is kept).

Full reference, error codes and headers are in the /v1/map reference.

Use cases

What people build with the Website Map API

01

Find the right pages

Rank a site's URLs by a phrase and read only the top matches.

02

SEO inventory

List a competitor's pages with sitemap lastmod dates to see what they publish.

03

Crawl planning

Map a site first, then crawl or extract just the sections that matter.

Pricing

Website Map API pricing

Cost per call

1 credit

per call that found URLs (free when nothing is found)

  • From $0.60 per 1,000 calls at volume.
  • Credits never expire. No subscription.
  • Failed, empty and blocked calls are refunded.
  • 2,500 free credits = 2,500 calls, then 1,000 credits a month.
See all pricing
Website Map API cost per pack
Pack Price Per 1k credits Per 1k calls Calls per pack
Starter $10 $1.00 $1.00 10,000
Growth $50 $0.80 $0.80 62,500
Pro $300 $0.60 $0.60 500,000

FAQ

Website Map API: common questions

Keep exploring

Related APIs and integrations

Website Crawler API Crawl a site or section to Markdown, async, robots.txt respected. Web Extract API Up to 20 URLs or PDFs per call to Markdown, with ranked passages. Webpage to Markdown API Any URL to clean Markdown plus metadata, for RAG.

Use it from

Start building

Start with the Website Map API

2,500 free credits, then 1,000 every month. No credit card.

Get a free API key Read the reference