Skip to main content
GET
Map a site's URLs
Returns a site’s URLs, most useful first, without fetching the pages. 1 credit. Failed requests are never charged.

Guide: Map a site

Ordering, search, sources, scope and examples.

Authorizations

X-API-Key
string
header
required

Your Prefetch API key. Obtain one from the dashboard.

Query Parameters

url
string
required

The website URL to process. https:// is prepended automatically if no protocol is provided.

Example:

"https://stripe.com"

limit
integer
default:1000

Maximum number of links to return.

Required range: 1 <= x <= 5000

Rank and filter results by relevance to this query. Links that match nothing are dropped.

Example:

"pricing"

sitemap
enum<string>
default:include

Which sources to use. include merges sitemap entries with on-page links, skip uses on-page links only, only uses sitemaps only.

Available options:
include,
skip,
only
include_subdomains
boolean
default:true

Include links on subdomains of the target.

ignore_query_params
boolean
default:true

Treat URLs that differ only by query string as one page.

Response

Links discovered.

success
enum<boolean>
required
Available options:
true
data
object
required
meta
object
required