POST
/
map
Map multiple URLs based on options
curl --request POST \
  --url https://api.firecrawl.dev/v2/map \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "<string>",
  "search": "<string>",
  "sitemap": "include",
  "includeSubdomains": true,
  "ignoreQueryParameters": true,
  "limit": 5000,
  "timeout": 123
}'
{
  "success": true,
  "links": [
    "<string>"
  ]
}

What’s New in v2

Better Sitemap Control

Three ways to handle sitemaps:
  • "include" - Use sitemap + find other pages (default)
  • "skip" - Ignore sitemap completely
  • "only" - Only return sitemap URLs
{
  "url": "https://example.com",
  "sitemap": "only"
}

Response format changed

We now return the links in the links array of objects with enhanced metadata.
{
  "url": "https://example.com",
  "links": [
    {
      "url": "https://example.com/page1",
      "title": "Page 1",
      "description": "Page 1 description"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Response

200
application/json

Successful response

The response is of type object.