Skip to main content
GET
cURL
使用此端点在异步采集任务完成后直接从 Bright Data API 拉取抓取数据。这是最简单的投递方式:触发任务,轮询直到快照状态为 ready,然后按需下载结果。

何时使用 API 下载

以下情况适合使用 API 下载:
  • 你希望采用拉取式工作流,而不是把数据推送到自己的基础设施。
  • 你不需要把结果投递到特定的存储桶或 webhook 端点。
  • 你的结果集不超过单次请求 5 GB 的上限。
  • 你在做原型或临时任务,不想配置投递目标。
如果需要自动投递或更大的结果集,请参阅其他投递方式(webhook、Amazon S3、Google Cloud Storage、Azure、Snowflake)。

工作原理

  1. 通过 POST /datasets/v3/trigger 触发异步采集,响应中包含 snapshot_id
  2. 轮询 GET /datasets/v3/progress/{snapshot_id},直到 statusready
  3. 使用 snapshot_id 调用此端点下载数据。
结果数据在采集完成后保留 16 天。请在此期限内下载,或配置投递方式让数据自动推送到你的存储。

快速示例

cURL
响应是你所请求格式的原始数据集。JSON 返回记录数组,NDJSON 和 JSON Lines 每行返回一条记录,CSV 返回一个标题行加数据行。

分部分下载大型快照

对于超过几百 MB 的快照,请把下载拆分为多个部分,以避免超时和客户端内存压力:
  1. 指定 batch_size(最少 1000 条记录)和 part=1 请求第一部分。
  2. 调用 GET /datasets/v3/snapshot/{snapshot_id}/parts 查看共有多少部分。
  3. 递增 part 参数请求其余各部分。
所有部分请求中的 batch_sizeformatcompress 必须保持一致,否则 API 会返回错误。

限制

端点

授权

Authorization
string
header
必填

在 Authorization 头中使用您的 Bright Data API Key 作为 Bearer token。

认证方法:

  1. 从 Bright Data 账户设置获取您的 API Key: https://brightdata.com/cp/setting/users
  2. 在请求的 Authorization 头中包含 API Key
  3. 格式: Authorization: Bearer YOUR_API_KEY

示例:

了解如何获取 Bright Data API Key: https://docs.brightdata.com/cn/api-reference/authentication#如何生成新的-api-key?

路径参数

snapshot_id
string
必填

触发采集时返回的 ID

示例:

"s_m4x7enmven8djfqak"

查询参数

format
enum<string>

接收数据的格式

可用选项:
json,
ndjson,
jsonl,
csv
compress
boolean

结果是否应压缩

batch_size
integer

按 X 条记录分批

必填范围: x >= 1000
part
integer

如果提供了 batch_size,则指定下载哪一部分

响应

成功

以所需格式返回的数据