> ## Documentation Index
> Fetch the complete documentation index at: https://help.decodo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Parameters

> Request parameters and response fields for /map: sitemap, path filters, domain scope, JavaScript rendering, and geo

## 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.<br />`include` - both the sitemap and the links on the page. Default value.<br />`only` - only URLs listed in the sitemap.<br />`skip` - only the links on the page.<br />Only the top-level sitemap is read - nested sitemaps aren't followed. |
| `select_paths` | array | | Only URLs whose path matches at least one pattern are returned. Example: `blog`. |
| `exclude_paths` | array | | URLs whose path matches any pattern are left out. Example: ` blog` |
| `domain_filter` | string | | Which domains to include.<br />`domain` - the main domain only. Default value.<br />`subdomain` - the main domain and its subdomains (e.g. `www.example.com` → `blog.example.com`).<br />`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

<CodeGroup>
  ```shellscript cURL theme={null}
  # 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"
  }
  '
  ```
</CodeGroup>

## 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 response can return up to \~147,000 URLs.

| Key | Description |
| :- | :- |
| `content.links` | All URLs found, after filters are applied. |
| `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). |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.