Skip to main content
POST
Map a site

Authorizations

X-API-Key
string
header
required

Body

application/json
url
string
required

The site whose URLs you want to enumerate. Must be http(s).

Example:

"https://example.com"

Also include same-site links found on the starting page, not just the site's page list.

Example:

true

limit
number

Maximum number of URLs to return.

Required range: 1 <= x <= 5000
Example:

1000

Keep only discovered URLs containing this term.

Maximum string length: 200
Example:

"pricing"

sitemap
enum<string>

Whether to use the site's published page list: skip it, include it alongside discovered links, or use it only.

Available options:
skip,
include,
only
Example:

"include"

sitemapInclude
string

On sitemap-index sites, only descend into sub-sitemaps whose URL contains one of these comma-separated terms (case-insensitive). E.g. "post" to target article sitemaps.

Maximum string length: 200
Example:

"post"

sitemapExclude
string

Skip sub-sitemaps whose URL contains any of these comma-separated terms (case-insensitive). Compose with sitemapInclude — e.g. include "post" + exclude "tag,category,author" avoids WordPress taxonomy sitemaps (post_tag-sitemap, …-taxonomies-post_tag-*) that also contain "post".

Maximum string length: 200
Example:

"tag,category,author"

order
enum<string>
default:newest

Sort order by sitemap lastmod. "newest" (default) returns the most recent URLs first — the wanted end of a large archive under the limit. URLs without a lastmod sort last.

Available options:
newest,
oldest,
sitemap
before
string

Cursor for paging a large archive newest→oldest: return only URLs with lastmod at or before this ISO timestamp. Page by passing the oldest lastmod from the previous page; dedupe by url across pages.

Example:

"2024-06-01T00:00:00Z"

offset
number

Skip the first N results (in the sorted order) then return the next limit. Pagination for sources with no lastmod (WordPress-core), where the date cursor can't apply. Page sequentially (0, limit, 2·limit, …) so the sub-sitemap cache keeps deep pages fast.

Required range: 0 <= x <= 100000
Example:

5000

includeSubdomains
boolean

Also include URLs on subdomains of the site. Default off.

Example:

false

ignoreQueryParameters
boolean

Treat URLs that differ only by query string as one. Default off.

Example:

false

Response

200 - application/json

The discovered URLs.

data
object
required