跳转到主要内容
POST
/
search
搜索，并可选择抓取搜索结果
curl --request POST \
  --url https://api.firecrawl.dev/v2/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "limit": 5,
  "sources": [
    "web"
  ],
  "categories": [
    {
      "type": "github"
    }
  ],
  "tbs": "<string>",
  "location": "<string>",
  "country": "US",
  "timeout": 60000,
  "ignoreInvalidURLs": false,
  "scrapeOptions": {}
}
'
{
  "success": true,
  "data": {
    "web": [
      {
        "title": "<string>",
        "description": "<string>",
        "url": "<string>",
        "markdown": "<string>",
        "html": "<string>",
        "rawHtml": "<string>",
        "links": [
          "<string>"
        ],
        "screenshot": "<string>",
        "metadata": {
          "title": "<string>",
          "description": "<string>",
          "sourceURL": "<string>",
          "statusCode": 123,
          "error": "<string>"
        }
      }
    ],
    "images": [
      {
        "title": "<string>",
        "imageUrl": "<string>",
        "imageWidth": 123,
        "imageHeight": 123,
        "url": "<string>",
        "position": 123
      }
    ],
    "news": [
      {
        "title": "<string>",
        "snippet": "<string>",
        "url": "<string>",
        "date": "<string>",
        "imageUrl": "<string>",
        "position": 123,
        "markdown": "<string>",
        "html": "<string>",
        "rawHtml": "<string>",
        "links": [
          "<string>"
        ],
        "screenshot": "<string>",
        "metadata": {
          "title": "<string>",
          "description": "<string>",
          "sourceURL": "<string>",
          "statusCode": 123,
          "error": "<string>"
        }
      }
    ]
  },
  "warning": "<string>",
  "id": "<string>",
  "creditsUsed": 123
}

​
v2 新增功能

​
同时搜索多个来源

一次搜索网页、图片和新闻： 
{
  "query": "firecrawl 网页抓取",
  "sources": [ "web", "images", "news" ]
}

​
响应格式变更

v1：平铺的结果列表。v2：按来源类型分组： 
{
  "success": true,
  "data": {
    "web": [/* web results */],
    "images": [/* 图片结果 */],
    "news": [/* news results */]
  }
}

​
新功能

  • 按时间范围筛选（“past week”、“past month”）
  • 指定目标国家/地区
  • 分类筛选：在 GitHub 仓库或科研网站内搜索
  • Alpha 内测阶段搜索结果上限为 500 条
search 端点将网页搜索与 Firecrawl 的抓取能力相结合，为任意查询返回完整页面内容。 在请求中包含 scrapeOptions，并设置 formats: [{"type": "markdown"}]，即可为每条搜索结果获取完整的 markdown 内容；否则默认只返回结果（url、title、description）。你也可以使用其他 formats，例如 {"type": "summary"} 来获取精简内容。

​
支持的查询运算符

我们支持多种查询运算符，帮助你更高效地筛选搜索结果。
运算符功能示例
""精确（非模糊）匹配一段文本"Firecrawl"
-排除特定关键词或对其他运算符取反-bad, -site:firecrawl.dev
site:仅返回来自指定网站的结果site:firecrawl.dev
inurl:仅返回在 URL 中包含某个词的结果inurl:firecrawl
allinurl:仅返回在 URL 中包含多个词的结果allinurl:git firecrawl
intitle:仅返回在页面标题中包含某个词的结果intitle:Firecrawl
allintitle:仅返回在页面标题中包含多个词的结果allintitle:firecrawl playground
related:仅返回与特定域相关的结果related:firecrawl.dev
imagesize:仅返回尺寸完全匹配的图片imagesize:1920x1080
larger:仅返回大于指定尺寸的图片larger:1920x1080

​
location 参数

使用 location 参数获取按地理位置定向的搜索结果。格式：“string”。示例：“Germany”、“San Francisco,California,United States”。 查看支持的位置完整列表，了解所有可用的国家和语言。

​
country 参数

使用 country 参数以 ISO 国家/地区代码指定搜索结果所属国家/地区。默认值：“US”。 示例：“US”、“DE”、“FR”、“JP”、“UK”、“CA”。 
{
  "query": "餐厅",
  "country": "DE"
}

​
categories 参数

使用 categories 参数按特定类别过滤搜索结果：
  • github: 在 GitHub 仓库、代码、问题和文档中搜索
  • research: 搜索学术和研究类网站（arXiv、Nature、IEEE、PubMed 等）
  • pdf: 搜索 PDF

​
使用示例

{
  "query": "机器学习",
  "categories": ["github", "research"],
  "limit": 10
}

​
分类响应

每个结果都包含一个 category 字段，用于表示其来源： 
{
  "success": true,
  "data": {
    "web": [
      {
        "url": "https://github.com/example/ml-project",
        "title": "Machine Learning Project",
        "description": "Implementation of ML algorithms",
        "category": "github"
      },
      {
        "url": "https://arxiv.org/abs/2024.12345",
        "title": "ML Research Paper",
        "description": "Latest advances in machine learning",
        "category": "research"
      }
    ]
  }
}
使用 tbs 参数按时间范围过滤搜索结果，包括自定义日期区间。详细示例及支持的 formats 请参见 Search Feature 文档。

授权

​
Authorization
string
header
必填

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

请求体

application/json
​
query
string
必填

搜索查询语句

​
limit
integer
默认值:5

返回结果的最大数量

必填范围: 1 <= x <= 100
​
sources
(Web · object | Images · object | News · object)[]

要搜索的数据源。将决定响应中可用的数组。默认为 ['web']。

​
categories
(GitHub · object | Research · object | PDF · object)[]

根据类别筛选结果。默认值为 []，表示结果不会按类别进行过滤。

​
tbs
string

按时间筛选的搜索参数。支持预定义时间范围（qdr:h、qdr:d、qdr:w、qdr:m、qdr:y）和自定义日期范围（cdr:1,cd_min:MM/DD/YYYY,cd_max:MM/DD/YYYY）

​
location
string

用于搜索结果的位置参数（例如 San Francisco,California,United States）。为获得最佳效果，请同时设置该参数和 country 参数。

​
country
string
默认值:US

用于按地域定向搜索结果的 ISO 国家代码（例如 US）。为获得最佳效果，请同时设置此参数和 location 参数。

​
timeout
integer
默认值:60000

超时（毫秒）

​
ignoreInvalidURLs
boolean
默认值:false

从搜索结果中排除对其他 Firecrawl 端点无效的 URL。这样在将搜索结果数据输送到其他 Firecrawl API 端点时，有助于减少错误。

​
scrapeOptions
object

抓取搜索结果的选项

响应

成功的响应

​
success
boolean
​
data
object

搜索结果。可用的数组取决于你在请求中指定的源。默认情况下会返回 web 数组。

​
warning
string | null

在出现任何问题时显示的警告消息

​
id
string

搜索作业的 ID

​
creditsUsed
integer

本次搜索消耗的积分数量