Map

POST

map

基于选项对多个 URL 进行映射

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."
}

注意：本 API 的全新 v2 版本现已发布，具备更强大的功能和更高的性能。

授权

Authorization

string

header

必填

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

请求体

application/json

url

string<uri>

必填

开始爬取时使用的基础 URL

string

用于映射的搜索查询。在 Alpha 阶段，搜索功能中的「智能」部分最多只会处理 500 条搜索结果。不过，如果 Map 找到更多结果，则不会对这些结果施加任何限制。

ignoreSitemap

boolean

默认值:true

抓取网站时忽略其 sitemap。

sitemapOnly

boolean

默认值:false

仅返回网站站点地图中包含的链接

includeSubdomains

boolean

默认值:true

包含该网站子域名

limit

integer

默认值:5000

要返回的最大链接数

必填范围: x <= 30000

timeout

integer

超时时间（毫秒）。默认情况下没有超时限制。

location

object

请求的地理位置设置。指定后（如果可用），将使用相应的代理，并模拟对应的语言和时区设置。如果未指定，默认值为“US”。

Show child attributes

响应

成功响应

success

boolean

links

string[]

基于选项对多个 URL 进行映射

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."
}

使用 API

抓取端点

爬取端点

映射端点

搜索端点

提取端点

账户端点

授权

请求体

响应