Endpoints de mapeamento
Mapear
POST
/
map
Mapear várias URLs de acordo com as opções
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": true,
"limit": 5000,
"timeout": 123,
"location": {
"country": "US",
"languages": [
"en-US"
]
}
}
'import requests
url = "https://api.firecrawl.dev/v1/map"
payload = {
"url": "<string>",
"search": "<string>",
"ignoreSitemap": True,
"sitemapOnly": False,
"includeSubdomains": True,
"limit": 5000,
"timeout": 123,
"location": {
"country": "US",
"languages": ["en-US"]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
search: '<string>',
ignoreSitemap: true,
sitemapOnly: false,
includeSubdomains: true,
limit: 5000,
timeout: 123,
location: {country: 'US', languages: ['en-US']}
})
};
fetch('https://api.firecrawl.dev/v1/map', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.firecrawl.dev/v1/map",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'search' => '<string>',
'ignoreSitemap' => true,
'sitemapOnly' => false,
'includeSubdomains' => true,
'limit' => 5000,
'timeout' => 123,
'location' => [
'country' => 'US',
'languages' => [
'en-US'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.firecrawl.dev/v1/map"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"search\": \"<string>\",\n \"ignoreSitemap\": true,\n \"sitemapOnly\": false,\n \"includeSubdomains\": true,\n \"limit\": 5000,\n \"timeout\": 123,\n \"location\": {\n \"country\": \"US\",\n \"languages\": [\n \"en-US\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.firecrawl.dev/v1/map")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"search\": \"<string>\",\n \"ignoreSitemap\": true,\n \"sitemapOnly\": false,\n \"includeSubdomains\": true,\n \"limit\": 5000,\n \"timeout\": 123,\n \"location\": {\n \"country\": \"US\",\n \"languages\": [\n \"en-US\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.firecrawl.dev/v1/map")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"search\": \"<string>\",\n \"ignoreSitemap\": true,\n \"sitemapOnly\": false,\n \"includeSubdomains\": true,\n \"limit\": 5000,\n \"timeout\": 123,\n \"location\": {\n \"country\": \"US\",\n \"languages\": [\n \"en-US\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"links": [
"<string>"
]
}{
"error": "Payment required to access this resource."
}{
"error": "Request rate limit exceeded. Please wait and try again later."
}{
"error": "An unexpected error occurred on the server."
}Observação: Uma nova versão v2 desta API já está disponível e oferece recursos e desempenho aprimorados.
Autorizações
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Corpo
application/json
A URL base de onde iniciar o rastreamento
Consulta de pesquisa usada para mapeamento. Durante a fase Alpha, o componente "inteligente" da funcionalidade de pesquisa é limitado a 500 resultados. Porém, se o mapeamento encontrar mais resultados, nenhum limite será aplicado.
Ignorar o sitemap do site durante o rastreamento.
Retorne apenas os links encontrados no sitemap do site
Incluir subdomínios do site
Número máximo de links a retornar
Intervalo obrigatório:
x <= 30000Tempo limite em milissegundos. Não há tempo limite definido por padrão.
Configurações de localização da requisição. Quando definidas, será usado um proxy apropriado, se disponível, e serão emuladas as configurações correspondentes de idioma e fuso horário. O padrão é "US" se não for especificado.
Show child attributes
Show child attributes
⌘I
Mapear várias URLs de acordo com as opções
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": true,
"limit": 5000,
"timeout": 123,
"location": {
"country": "US",
"languages": [
"en-US"
]
}
}
'import requests
url = "https://api.firecrawl.dev/v1/map"
payload = {
"url": "<string>",
"search": "<string>",
"ignoreSitemap": True,
"sitemapOnly": False,
"includeSubdomains": True,
"limit": 5000,
"timeout": 123,
"location": {
"country": "US",
"languages": ["en-US"]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
search: '<string>',
ignoreSitemap: true,
sitemapOnly: false,
includeSubdomains: true,
limit: 5000,
timeout: 123,
location: {country: 'US', languages: ['en-US']}
})
};
fetch('https://api.firecrawl.dev/v1/map', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.firecrawl.dev/v1/map",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'search' => '<string>',
'ignoreSitemap' => true,
'sitemapOnly' => false,
'includeSubdomains' => true,
'limit' => 5000,
'timeout' => 123,
'location' => [
'country' => 'US',
'languages' => [
'en-US'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.firecrawl.dev/v1/map"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"search\": \"<string>\",\n \"ignoreSitemap\": true,\n \"sitemapOnly\": false,\n \"includeSubdomains\": true,\n \"limit\": 5000,\n \"timeout\": 123,\n \"location\": {\n \"country\": \"US\",\n \"languages\": [\n \"en-US\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.firecrawl.dev/v1/map")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"search\": \"<string>\",\n \"ignoreSitemap\": true,\n \"sitemapOnly\": false,\n \"includeSubdomains\": true,\n \"limit\": 5000,\n \"timeout\": 123,\n \"location\": {\n \"country\": \"US\",\n \"languages\": [\n \"en-US\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.firecrawl.dev/v1/map")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"search\": \"<string>\",\n \"ignoreSitemap\": true,\n \"sitemapOnly\": false,\n \"includeSubdomains\": true,\n \"limit\": 5000,\n \"timeout\": 123,\n \"location\": {\n \"country\": \"US\",\n \"languages\": [\n \"en-US\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"links": [
"<string>"
]
}{
"error": "Payment required to access this resource."
}{
"error": "Request rate limit exceeded. Please wait and try again later."
}{
"error": "An unexpected error occurred on the server."
}