Skip to main content
Firecrawl Docs

Map

1 min read
post/map
Request example
Response
post/map

Authorization

Authorizationstringheaderrequired#
Bearer authentication header of the form Bearer <token>, where <token> is your API key.

Body

application/json
urlstringrequired#
The base URL to start crawling from
searchstring#
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.
sitemapenum<string>#
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.

Default: "include"

Options:skipincludeonly
includeSubdomainsboolean#
Include subdomains of the website

Default: true

ignoreQueryParametersboolean#
Do not return URLs with query parameters

Default: true

ignoreCacheboolean#
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.

Default: false

limitinteger#
Maximum number of links to return

Default: 5000

Range: <= 100000

timeoutinteger#
Timeout in milliseconds. There is no timeout by default.
locationobject#
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.
Show child attributes
countrystring#
ISO 3166-1 alpha-2 country code (e.g., 'US', 'AU', 'DE', 'JP')

Default: "US"

Pattern: ^[A-Z]{2}$

languagesstring[]#
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
auditMetadataobject#
User attribution included with SIEM logging events when SIEM Logging is enabled for the organization.
Show child attributes
usernamestringrequired#
The username associated with the request.

Length: max 1024

threatProtectionobject#
Per-request 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.
Show child attributes
modeenum<string>#
URL scanning mode for this request. normal checks URLs against Google Web Risk (+2 credits per URL scanned).
Options:offnormal
riskScoreThresholdinteger#
Normalized risk score (0–100) at or above which a classifier verdict blocks the URL. Lower is stricter.

Range: 0–100

blackliststring[]#
Domains to always block, as plain domains (example.com) or wildcard globs (*.example.com). No protocol, path, or port.

Items: max 1000

whiteliststring[]#
Domains to always allow, as plain domains or wildcard globs. Wins over every other rule.

Items: max 1000

blockedTldsstring[]#
Top-level domains to block outright, lowercase without the leading dot (e.g. zip).

Items: max 1000

failurePolicyenum<string>#
What to do when the classifier can't be reached: closed blocks the request, open allows it.
Options:openclosed

Responses

application/json
Successful response
successboolean#
linksobject[]#
Show child attributes
urlstringrequired#
titlestring#
The title of the page, if available.
descriptionstring#
A description of the page, if available.
Search the Developer IndexParse