POST
/
map
curl --request POST \
  --url https://api.firecrawl.dev/v1/map \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "<string>",
  "search": "<string>",
  "ignoreSitemap": true,
  "sitemapOnly": false,
  "includeSubdomains": false,
  "limit": 5000,
  "timeout": 123
}'
{
  "success": true,
  "links": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
url
string
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 1000 search results. However, if map finds more results, there is no limit applied.

​
ignoreSitemap
boolean
default:true

Ignore the website sitemap when crawling.

​
sitemapOnly
boolean
default:false

Only return links found in the website sitemap

​
includeSubdomains
boolean
default:false

Include subdomains of the website

​
limit
integer
default:5000

Maximum number of links to return

Required range: x <= 5000
​
timeout
integer

Timeout in milliseconds. There is no timeout by default.

Response

200
application/json
Successful response
​
success
boolean
​
links
string[]
Suggest editsRaise issue