基础抓取
/scrape 端点。
抓取 PDF
parsers 选项(例如 parsers: ["pdf"])。你可以通过 mode 选项来控制解析策略:
auto(默认)— 先尝试基于文本的快速提取,如有需要再回退到 OCR。fast— 仅进行基于文本(嵌入文本)的解析。速度最快,但会跳过扫描件或图片较多的页面。ocr— 对每一页强制使用 OCR 解析。适用于扫描文档,或在auto误判页面类型时使用。
{ type: "pdf" } 和 "pdf" 都默认使用 mode: "auto"。
抓取选项
/scrape 端点时,你可以通过以下选项来自定义请求。
Formats (formats)
formats 数组控制抓取器返回哪些输出类型。默认值:["markdown"]。
字符串 formats:直接传入名称 (例如 "markdown") 。
对象 formats:传入包含
type 和其他选项的对象。
移动端抓取
mobile: true 以模拟移动设备。当响应式网站在桌面端隐藏部分内容,或为移动浏览器提供不同布局时,这很有用。
对于有区域差异的网站,可结合 location 和移动端截图来验证渲染后的布局:
mobile: true 后仍然呈现桌面端布局,请通过 headers 添加移动端 User-Agent:
内容过滤
onlyMainContent 为 true (默认值) 时,会先去掉页面框架内容 (导航、页脚等) 。includeTags 和 excludeTags 是基于原始页面 DOM 而不是过滤后的结果进行匹配的,因此你的选择器应以元素在源 HTML 中的实际呈现为准。若将 onlyMainContent: false,则会使用整页 HTML 作为后续标签过滤的起点。
时间与缓存
PDF 解析
Actions
wait action 与 waitFor 的累计等待时间不得超过 60 秒。
actions 执行说明
- 在使用 Write 前,需要先执行一次
click以聚焦目标元素。 - Scroll 可以接受一个可选的
selector,用于滚动特定元素而不是整个页面。 - Wait 接受
milliseconds(固定延迟)或selector(等待元素可见)两种参数中的一种。 - actions 按顺序执行:每一步都会在下一步开始前完成。
- actions 不支持 PDF。如果 URL 解析为 PDF 文档,请求将会失败。
高级操作示例
cURL
cURL
cURL
cURL
executeJavascript 操作的返回值都会记录在响应中的 actions.javascriptReturns 数组里。
完整抓取示例
cURL
<h1>、<p>、<a> 和 .main-content,同时排除 #ad 和 #footer,在开始抓取前等待 1 秒,将超时时间设置为 15 秒,并启用 PDF 解析。
有关详细信息,请参阅完整的 Scrape API 参考文档。
通过 formats 提取 JSON
formats 中的 JSON 格式对象,即可一次性提取结构化数据:
Agent endpoint
/v2/agent 端点进行自动化的多页面数据提取。Agent 以异步方式运行:你先创建一个任务,然后通过轮询获取结果。
代理选项
检查 agent 状态
GET /v2/agent/{jobId} 以检查进度。响应中的 status 字段将为 "processing"、"completed" 或 "failed"。
cURL
firecrawl.agent()),用于启动任务并自动轮询,直到任务完成。
爬取多个页面
/v2/crawl 端点。爬取会以异步方式运行,并返回一个任务 ID。使用 limit 参数控制爬取的页面数量。若省略该参数,爬取最多会处理 10,000 个页面。
cURL
返回结果
检查爬取任务
cURL
next 参数,也就是下一页结果的 URL。
爬取 prompt 和参数预览
prompt,让 Firecrawl 推导爬取设置。请先预览这些设置:
cURL
爬虫选项
/v2/crawl 端点时,你可以使用以下选项自定义爬取行为。
路径过滤
爬取范围
Sitemap 和去重
爬取任务的抓取选项
抓取示例
cURL
网站链接映射
/v2/map 端点用于识别与指定网站相关的 URL。
cURL
Map 选项
其 API 参考文档见此:Map 端点文档
Firecrawl 白名单设置
允许 Firecrawl 抓取你的网站
- User Agent(用户代理):请在防火墙或安全规则中允许
FirecrawlAgent。 - IP addresses(IP 地址):Firecrawl 不使用固定的对外 IP 地址集合。
允许你的应用调用 Firecrawl API
api.firecrawl.dev):
- IP Address:
35.245.250.27

