Crawl multiple URLs based on options
curl --request POST \
--url https://api.firecrawl.dev/v0/crawl \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"crawlerOptions": {
"includes": [
"<string>"
],
"excludes": [
"<string>"
],
"generateImgAltText": false,
"returnOnlyUrls": false,
"maxDepth": 123,
"mode": "default",
"ignoreSitemap": false,
"limit": 10000,
"allowBackwardCrawling": false,
"allowExternalContentLinks": false
},
"pageOptions": {
"headers": {},
"includeHtml": false,
"includeRawHtml": false,
"onlyIncludeTags": [
"<string>"
],
"onlyMainContent": false,
"removeTags": [
"<string>"
],
"replaceAllPathsWithAbsolutePaths": false,
"screenshot": false,
"fullPageScreenshot": false,
"waitFor": 0
}
}
'import requests
url = "https://api.firecrawl.dev/v0/crawl"
payload = {
"url": "<string>",
"crawlerOptions": {
"includes": ["<string>"],
"excludes": ["<string>"],
"generateImgAltText": False,
"returnOnlyUrls": False,
"maxDepth": 123,
"mode": "default",
"ignoreSitemap": False,
"limit": 10000,
"allowBackwardCrawling": False,
"allowExternalContentLinks": False
},
"pageOptions": {
"headers": {},
"includeHtml": False,
"includeRawHtml": False,
"onlyIncludeTags": ["<string>"],
"onlyMainContent": False,
"removeTags": ["<string>"],
"replaceAllPathsWithAbsolutePaths": False,
"screenshot": False,
"fullPageScreenshot": False,
"waitFor": 0
}
}
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>',
crawlerOptions: {
includes: ['<string>'],
excludes: ['<string>'],
generateImgAltText: false,
returnOnlyUrls: false,
maxDepth: 123,
mode: 'default',
ignoreSitemap: false,
limit: 10000,
allowBackwardCrawling: false,
allowExternalContentLinks: false
},
pageOptions: {
headers: {},
includeHtml: false,
includeRawHtml: false,
onlyIncludeTags: ['<string>'],
onlyMainContent: false,
removeTags: ['<string>'],
replaceAllPathsWithAbsolutePaths: false,
screenshot: false,
fullPageScreenshot: false,
waitFor: 0
}
})
};
fetch('https://api.firecrawl.dev/v0/crawl', 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/v0/crawl",
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>',
'crawlerOptions' => [
'includes' => [
'<string>'
],
'excludes' => [
'<string>'
],
'generateImgAltText' => false,
'returnOnlyUrls' => false,
'maxDepth' => 123,
'mode' => 'default',
'ignoreSitemap' => false,
'limit' => 10000,
'allowBackwardCrawling' => false,
'allowExternalContentLinks' => false
],
'pageOptions' => [
'headers' => [
],
'includeHtml' => false,
'includeRawHtml' => false,
'onlyIncludeTags' => [
'<string>'
],
'onlyMainContent' => false,
'removeTags' => [
'<string>'
],
'replaceAllPathsWithAbsolutePaths' => false,
'screenshot' => false,
'fullPageScreenshot' => false,
'waitFor' => 0
]
]),
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/v0/crawl"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"crawlerOptions\": {\n \"includes\": [\n \"<string>\"\n ],\n \"excludes\": [\n \"<string>\"\n ],\n \"generateImgAltText\": false,\n \"returnOnlyUrls\": false,\n \"maxDepth\": 123,\n \"mode\": \"default\",\n \"ignoreSitemap\": false,\n \"limit\": 10000,\n \"allowBackwardCrawling\": false,\n \"allowExternalContentLinks\": false\n },\n \"pageOptions\": {\n \"headers\": {},\n \"includeHtml\": false,\n \"includeRawHtml\": false,\n \"onlyIncludeTags\": [\n \"<string>\"\n ],\n \"onlyMainContent\": false,\n \"removeTags\": [\n \"<string>\"\n ],\n \"replaceAllPathsWithAbsolutePaths\": false,\n \"screenshot\": false,\n \"fullPageScreenshot\": false,\n \"waitFor\": 0\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/v0/crawl")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"crawlerOptions\": {\n \"includes\": [\n \"<string>\"\n ],\n \"excludes\": [\n \"<string>\"\n ],\n \"generateImgAltText\": false,\n \"returnOnlyUrls\": false,\n \"maxDepth\": 123,\n \"mode\": \"default\",\n \"ignoreSitemap\": false,\n \"limit\": 10000,\n \"allowBackwardCrawling\": false,\n \"allowExternalContentLinks\": false\n },\n \"pageOptions\": {\n \"headers\": {},\n \"includeHtml\": false,\n \"includeRawHtml\": false,\n \"onlyIncludeTags\": [\n \"<string>\"\n ],\n \"onlyMainContent\": false,\n \"removeTags\": [\n \"<string>\"\n ],\n \"replaceAllPathsWithAbsolutePaths\": false,\n \"screenshot\": false,\n \"fullPageScreenshot\": false,\n \"waitFor\": 0\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.firecrawl.dev/v0/crawl")
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 \"crawlerOptions\": {\n \"includes\": [\n \"<string>\"\n ],\n \"excludes\": [\n \"<string>\"\n ],\n \"generateImgAltText\": false,\n \"returnOnlyUrls\": false,\n \"maxDepth\": 123,\n \"mode\": \"default\",\n \"ignoreSitemap\": false,\n \"limit\": 10000,\n \"allowBackwardCrawling\": false,\n \"allowExternalContentLinks\": false\n },\n \"pageOptions\": {\n \"headers\": {},\n \"includeHtml\": false,\n \"includeRawHtml\": false,\n \"onlyIncludeTags\": [\n \"<string>\"\n ],\n \"onlyMainContent\": false,\n \"removeTags\": [\n \"<string>\"\n ],\n \"replaceAllPathsWithAbsolutePaths\": false,\n \"screenshot\": false,\n \"fullPageScreenshot\": false,\n \"waitFor\": 0\n }\n}"
response = http.request(request)
puts response.read_body{
"jobId": "<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."
}接口
爬取
POST
/
crawl
Crawl multiple URLs based on options
curl --request POST \
--url https://api.firecrawl.dev/v0/crawl \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"crawlerOptions": {
"includes": [
"<string>"
],
"excludes": [
"<string>"
],
"generateImgAltText": false,
"returnOnlyUrls": false,
"maxDepth": 123,
"mode": "default",
"ignoreSitemap": false,
"limit": 10000,
"allowBackwardCrawling": false,
"allowExternalContentLinks": false
},
"pageOptions": {
"headers": {},
"includeHtml": false,
"includeRawHtml": false,
"onlyIncludeTags": [
"<string>"
],
"onlyMainContent": false,
"removeTags": [
"<string>"
],
"replaceAllPathsWithAbsolutePaths": false,
"screenshot": false,
"fullPageScreenshot": false,
"waitFor": 0
}
}
'import requests
url = "https://api.firecrawl.dev/v0/crawl"
payload = {
"url": "<string>",
"crawlerOptions": {
"includes": ["<string>"],
"excludes": ["<string>"],
"generateImgAltText": False,
"returnOnlyUrls": False,
"maxDepth": 123,
"mode": "default",
"ignoreSitemap": False,
"limit": 10000,
"allowBackwardCrawling": False,
"allowExternalContentLinks": False
},
"pageOptions": {
"headers": {},
"includeHtml": False,
"includeRawHtml": False,
"onlyIncludeTags": ["<string>"],
"onlyMainContent": False,
"removeTags": ["<string>"],
"replaceAllPathsWithAbsolutePaths": False,
"screenshot": False,
"fullPageScreenshot": False,
"waitFor": 0
}
}
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>',
crawlerOptions: {
includes: ['<string>'],
excludes: ['<string>'],
generateImgAltText: false,
returnOnlyUrls: false,
maxDepth: 123,
mode: 'default',
ignoreSitemap: false,
limit: 10000,
allowBackwardCrawling: false,
allowExternalContentLinks: false
},
pageOptions: {
headers: {},
includeHtml: false,
includeRawHtml: false,
onlyIncludeTags: ['<string>'],
onlyMainContent: false,
removeTags: ['<string>'],
replaceAllPathsWithAbsolutePaths: false,
screenshot: false,
fullPageScreenshot: false,
waitFor: 0
}
})
};
fetch('https://api.firecrawl.dev/v0/crawl', 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/v0/crawl",
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>',
'crawlerOptions' => [
'includes' => [
'<string>'
],
'excludes' => [
'<string>'
],
'generateImgAltText' => false,
'returnOnlyUrls' => false,
'maxDepth' => 123,
'mode' => 'default',
'ignoreSitemap' => false,
'limit' => 10000,
'allowBackwardCrawling' => false,
'allowExternalContentLinks' => false
],
'pageOptions' => [
'headers' => [
],
'includeHtml' => false,
'includeRawHtml' => false,
'onlyIncludeTags' => [
'<string>'
],
'onlyMainContent' => false,
'removeTags' => [
'<string>'
],
'replaceAllPathsWithAbsolutePaths' => false,
'screenshot' => false,
'fullPageScreenshot' => false,
'waitFor' => 0
]
]),
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/v0/crawl"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"crawlerOptions\": {\n \"includes\": [\n \"<string>\"\n ],\n \"excludes\": [\n \"<string>\"\n ],\n \"generateImgAltText\": false,\n \"returnOnlyUrls\": false,\n \"maxDepth\": 123,\n \"mode\": \"default\",\n \"ignoreSitemap\": false,\n \"limit\": 10000,\n \"allowBackwardCrawling\": false,\n \"allowExternalContentLinks\": false\n },\n \"pageOptions\": {\n \"headers\": {},\n \"includeHtml\": false,\n \"includeRawHtml\": false,\n \"onlyIncludeTags\": [\n \"<string>\"\n ],\n \"onlyMainContent\": false,\n \"removeTags\": [\n \"<string>\"\n ],\n \"replaceAllPathsWithAbsolutePaths\": false,\n \"screenshot\": false,\n \"fullPageScreenshot\": false,\n \"waitFor\": 0\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/v0/crawl")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"crawlerOptions\": {\n \"includes\": [\n \"<string>\"\n ],\n \"excludes\": [\n \"<string>\"\n ],\n \"generateImgAltText\": false,\n \"returnOnlyUrls\": false,\n \"maxDepth\": 123,\n \"mode\": \"default\",\n \"ignoreSitemap\": false,\n \"limit\": 10000,\n \"allowBackwardCrawling\": false,\n \"allowExternalContentLinks\": false\n },\n \"pageOptions\": {\n \"headers\": {},\n \"includeHtml\": false,\n \"includeRawHtml\": false,\n \"onlyIncludeTags\": [\n \"<string>\"\n ],\n \"onlyMainContent\": false,\n \"removeTags\": [\n \"<string>\"\n ],\n \"replaceAllPathsWithAbsolutePaths\": false,\n \"screenshot\": false,\n \"fullPageScreenshot\": false,\n \"waitFor\": 0\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.firecrawl.dev/v0/crawl")
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 \"crawlerOptions\": {\n \"includes\": [\n \"<string>\"\n ],\n \"excludes\": [\n \"<string>\"\n ],\n \"generateImgAltText\": false,\n \"returnOnlyUrls\": false,\n \"maxDepth\": 123,\n \"mode\": \"default\",\n \"ignoreSitemap\": false,\n \"limit\": 10000,\n \"allowBackwardCrawling\": false,\n \"allowExternalContentLinks\": false\n },\n \"pageOptions\": {\n \"headers\": {},\n \"includeHtml\": false,\n \"includeRawHtml\": false,\n \"onlyIncludeTags\": [\n \"<string>\"\n ],\n \"onlyMainContent\": false,\n \"removeTags\": [\n \"<string>\"\n ],\n \"replaceAllPathsWithAbsolutePaths\": false,\n \"screenshot\": false,\n \"fullPageScreenshot\": false,\n \"waitFor\": 0\n }\n}"
response = http.request(request)
puts response.read_body{
"jobId": "<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."
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
Successful response
⌘I