Sandbox::https://help.decodo.com/docs/web-data-api-map-parameters

POST endpoint

https://data.decodo.com/v1/map /map is synchronous - the list of URLs comes back in the same response.

Input parameters

Parameter	Type	Required	Description
`url`	string	✅	The page to discover URLs from. Must be a valid, reachable URL.
`sitemap`	string		Where to collect URLs from. `include` - both the sitemap and the links on the page. Default value. `only` - only URLs listed in the sitemap. `skip` - only the links on the page. Only the top-level sitemap is read - nested sitemaps aren’t followed. If the site’s sitemap is a sitemap index, `only` returns a `400` error, and `include` falls back to the links on the page.
`select_paths`	array		Regex patterns. Only URLs whose path matches at least one pattern are returned. Example: `["^/blog"]`.
`exclude_paths`	array		Regex patterns. URLs whose path matches any pattern are left out. Example: `["^/use-cases"]`.
`domain_filter`	string		Which domains to include. `domain` - the main domain only. Default value. `subdomain` - the main domain and its subdomains (e.g. `example.com` → `blog.example.com`). `all` - the main domain, subdomains, and external websites.
`JS_rendering`	boolean		Set to `true` to render JavaScript before collecting links. Use it for sites that load their navigation with JavaScript. Charged at the premium proxy + JS rate. Default value is `false`.
`geo`	string		Country to send the request from. Accepts a full country name or a 2-letter country code.
`locale`	string		Language and region to request the page in, e.g. `en-US`.

Request Examples

# replace 'TOKEN VALUE' with your API key
curl --request 'POST' \
  --url 'https://data.decodo.com/v1/map' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer TOKEN VALUE' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com",
  "sitemap": "include",
  "select_paths": ["^/blog"],
  "exclude_paths": ["^/use-cases"],
  "domain_filter": "subdomain",
  "geo": "United States"
}
'

Output

URLs from the sitemap and the page are merged into one list. Duplicates are removed, and URLs are normalized first - so example.com/page/, example.com/page#section and example.com/page count as one URL. A single call can return up to 147K URLs. The response holds a results array with one object containing these keys:

Key	Description
`content.links`	All URLs found, after filters are applied. Each item is an object with a `url` key.
`status_code`	`200` if at least one of the requests (page or sitemap) succeeded.
`url`	The URL you submitted.
`sitemap_status`	Which URL sources were actually used. See the values below.
`map_id`	Unique ID of this request. Share it with support if you need help.
`created_at`	When the request was received (UTC).
`updated_at`	When the response was completed (UTC).

`sitemap_status` values

Value	Meaning
`include`	URLs were collected from both the sitemap and the links on the page.
`only`	URLs were collected from the sitemap only.
`skip`	URLs were collected from the links on the page only. You’ll also get `skip` with `sitemap: "include"` if the site has no usable sitemap.

Response example

{
  "results": [
    {
      "content": {
        "links": [
          { "url": "https://decodo.com/blog" },
          { "url": "https://decodo.com/blog/asos-hacked" },
          { "url": "https://decodo.com/blog/topics/news" },
          { "url": "https://decodo.com/blog/how-to-scrape-bing-search" }
        ]
      },
      "status_code": 200,
      "url": "https://decodo.com",
      "sitemap_status": "skip",
      "map_id": "ad357923-0203-4677-87bd-2b2b69e78b1f",
      "created_at": "2026-10-07 11:09:54",
      "updated_at": "2026-10-07 11:09:54"
    }
  ]
}

Support

Need help or just want to say hello? Our support is available 24/7.
You can also reach us anytime via email at support@decodo.com.

Feedback

Can’t find what you’re looking for? Request an article!
Have feedback? Share your thoughts on how we can improve.

ABOUT

RESIDENTIAL PROXIES

STATIC RESIDENTIAL (ISP) PROXIES

DATACENTER PROXIES

FREE PROXIES

SITE UNBLOCKER

WEB DATA API

VIDEO DOWNLOADER

DECODO TOOLS

AI

INTEGRATIONS

ACCOUNT & DASHBOARD

PAYMENTS

TROUBLESHOOTING

TIPS & TRICKS

USEFUL LINKS

Parameters

POST endpoint

Input parameters

Request Examples

Output

`sitemap_status` values

Response example

Support

Feedback

​POST endpoint

​Input parameters

​Request Examples

​Output

​sitemap_status values

​Response example

Support

Feedback

POST endpoint

Input parameters

Request Examples

Output

`sitemap_status` values

Response example