Passer au contenu principal
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>"
  ]
}

​
Nouveautés de la v2

​
Meilleur contrôle des sitemaps

Trois façons de gérer les sitemaps :
  • "include" - Utiliser le sitemap et trouver d’autres pages (par défaut)
  • "skip" - Ignorer complètement le sitemap
  • "only" - Renvoyer uniquement les URL du sitemap
{
  "url": "https://example.com",
  "sitemap": "only"
}

​
Format de réponse modifié

Nous renvoyons désormais les liens dans le tableau d’objets links avec des métadonnées enrichies. 
{
  "url": "https://example.com",
  "links": [
    {
      "url": "https://example.com/page1",
      "title": "Page 1",
      "description": "Description de la Page 1"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
url
string<uri>
required

The base URL to start crawling from

​
search
string

Search query to use for mapping. During the Alpha phase, the 'smart' part of the search functionality is limited to 500 search results. However, if map finds more results, there is no limit applied.

​
sitemap
enum<string>
default:include

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.

Available options:
skip,
include,
only
​
includeSubdomains
boolean
default:true

Include subdomains of the website

​
ignoreQueryParameters
boolean
default:true

Do not return URLs with query parameters

​
limit
integer
default:5000

Maximum number of links to return

Required range: x <= 30000
​
timeout
integer

Timeout in milliseconds. There is no timeout by default.

Response

Successful response

​
success
boolean
​
links
string[]