---
title: "Map multiple URLs based on options"
method: POST
path: "/map"
tags: ["Mapping"]
---

# Map multiple URLs based on options

`POST /map`

## Request body

- object
  - `url` string, uri, required — The base URL to start crawling from
  - `search` string — Specify a search query to order the results by relevance. Example: 'blog' will return URLs that contain the word 'blog' in the URL ordered by relevance.
  - `sitemap` 'skip' | 'include' | 'only' — Sitemap mode when mapping. If you set it to `skip`, the sitemap won't be used to find URLs. If you set it to `only`, only URLs that are in the sitemap will be returned. By default (`include`), the sitemap and other methods will be used together to find URLs.
  - `includeSubdomains` boolean — Include subdomains of the website
  - `ignoreQueryParameters` boolean — Do not return URLs with query parameters
  - `ignoreCache` boolean — Bypass the sitemap cache to retrieve fresh URLs. Sitemap data is cached for up to 7 days; use this parameter when your sitemap has been recently updated.
  - `limit` integer — Maximum number of links to return
  - `timeout` integer — Timeout in milliseconds. There is no timeout by default.
  - `location` object — Location settings for the request. When specified, this will use an appropriate proxy if available and emulate the corresponding language and timezone settings. Defaults to 'US' if not specified.
    - `country` string — ISO 3166-1 alpha-2 country code (e.g., 'US', 'AU', 'DE', 'JP')
    - `languages` string[] — Preferred languages and locales for the request in order of priority. Defaults to the language of the specified location. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language
  - `threatProtection` ThreatProtectionOverride — Per-request [Threat Protection](https://docs.firecrawl.dev/features/threat-protection) override. Fields you provide replace the corresponding fields of your organization's policy for this request only; omitted fields keep their organization-level values. Requires Threat Protection to be enabled for your team (enterprise feature) — otherwise the request is rejected with a 403. If your organization has disabled request overrides, any request that includes this object is rejected with a 403. If Threat Protection is enforced for your team, `mode` may not be set to `off`.
    - `mode` 'off' | 'normal' — URL scanning mode for this request. `normal` checks URLs against Google Web Risk (+2 credits per URL scanned).
    - `riskScoreThreshold` integer — Normalized risk score (0–100) at or above which a classifier verdict blocks the URL. Lower is stricter.
    - `blacklist` string[] — Domains to always block, as plain domains (`example.com`) or wildcard globs (`*.example.com`). No protocol, path, or port.
    - `whitelist` string[] — Domains to always allow, as plain domains or wildcard globs. Wins over every other rule.
    - `blockedTlds` string[] — Top-level domains to block outright, lowercase without the leading dot (e.g. `zip`).
    - `failurePolicy` 'open' | 'closed' — What to do when the classifier can't be reached: `closed` blocks the request, `open` allows it.

## Response `200`

Successful response

- MapResponse
  - `success` boolean
  - `links` object[]
    - `url` string, uri, required
    - `title` string — The title of the page, if available.
    - `description` string — A description of the page, if available.

## Other responses

- `402` — Payment required
- `429` — Too many requests
- `500` — Server error

---

[API](https://skmtc.dev/firecrawl/apis/firecrawl-api.md) · [All operations](https://skmtc.dev/firecrawl/apis/firecrawl-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/firecrawl/firecrawl-api/revisions/e350fafb5a2a/schema)