Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Use your Bright Data API Key as a Bearer token in the Authorization header.

How to authenticate:

  1. Obtain your API Key from the Bright Data account settings at https://brightdata.com/cp/setting/users
  2. Include the API Key in the Authorization header of your requests
  3. Format: Authorization: Bearer YOUR_API_KEY

Example:

Learn how to get your Bright Data API key: https://docs.brightdata.com/api-reference/authentication

Path Parameters

snapshot_id
string
required

The ID that was returned when the collection was triggered

Example:

"s_m4x7enmven8djfqak"

Query Parameters

format
enum<string>

Format of the data to be received

Available options:
json,
ndjson,
jsonl,
csv
compress
boolean

Whether the result should be compressed or not

batch_size
integer

Divide into batches of X records

Required range: x >= 1000

Response

200 - application/json

OK

parts
integer

Number of parts that were created