/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
Possible values: [datacenter, residential]
Possible values: [0, 1, false, true]
Possible values: [0, 1, false, true]
Body
- Schema
- JSON
The base URL to start mapping from (required)
Search query to order results by relevance
Maximum number of links to return (default: 5000, max: 5000)
Request timeout in milliseconds
Controls sitemap behavior: "include" (default), "skip", "only"
Possible values: [include, only, skip]
Whether to include URLs from subdomains (default: true)
Exclude URLs with query parameters (default: true)
location object
Geo-targeting settings
ISO 3166-1 alpha-2 country code for proxy routing (e.g., "us", "gb", "de"). Defaults to "us".
Preferred language codes for the request (e.g., ["en", "fr"]).
Proxy network to route through: "residential" (default) or "datacenter".
Possible values: [datacenter, residential]
{
"url": "string",
"search": "string",
"limit": 0,
"timeout": 0,
"sitemap": "include",
"includeSubdomains": true,
"ignoreQueryParameters": true,
"location": {
"country": "string",
"languages": [
"string"
]
},
"proxy": "datacenter"
}
Responses
- 200
- 400
- 401
- 403
- 404
- 408
- 429
- 500
- 503
An array of discovered URLs from the target page and its sitemap.
Schema
- Fields
- Example (auto)
- Array [
- ]
[
"string"
]
The request contains errors or didn't properly encode content.
The request is missing, or contains bad, authorization credentials.
The request targets a destination that is not allowed.
Resource couldn't be found.
The request took has taken too long to process.
Too many requests are currently being processed.
An internal error occurred when handling the request.
Service is unavailable.