For AI agents: a documentation index is available at /llms.txt
Skip to main content

/map

POST 

/map

Primarily discovers URLs from the site's sitemap, supplemented with link extraction from the page via the smart-scrape strategy pipeline (HTTP-first, browser fallback for JS-rendered pages). Use the search parameter to order results by relevance.

Request​

Query Parameters

    timeout number
    token string
    allowedDomains string[]
    credentials object
    externalProxyServer string
    integrationId string
    proxy ProxyType

    Possible values: [datacenter, residential]

    proxyCity string
    proxyCountry string
    proxyLocaleMatch string

    Possible values: [0, 1, false, true]

    proxyPreset string
    proxyState string
    proxySticky string

    Possible values: [0, 1, false, true]

Body

    urlstringrequired

    The base URL to start mapping from (required)

    searchstring

    Search query to order results by relevance

    limitnumber

    Maximum number of links to return (default: 5000, max: 5000)

    timeoutnumber

    Request timeout in milliseconds

    sitemapstring

    Controls sitemap behavior: "include" (default), "skip", "only"

    Possible values: [include, only, skip]

    includeSubdomainsboolean

    Whether to include URLs from subdomains (default: true)

    ignoreQueryParametersboolean

    Exclude URLs with query parameters (default: true)

    location object

    Geo-targeting settings

    countrystring

    ISO 3166-1 alpha-2 country code for proxy routing (e.g., "us", "gb", "de"). Defaults to "us".

    languagesstring[]

    Preferred language codes for the request (e.g., ["en", "fr"]).

    proxystring

    Proxy network to route through: "residential" (default) or "datacenter".

    Possible values: [datacenter, residential]

Responses​

An array of discovered URLs from the target page and its sitemap.

Schema
  • Array [
  • string
  • ]
Was this page helpful?