Skip to main content
GET

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

id
string
required

A Snapshot ID is a unique identifier for a specific data snapshot, used to retrieve results from a data collection job triggered via the API. Read more about Snapshot ID.

Example:

"snap_m2bxug4e2o352v1jv1"

Query Parameters

format
enum<string>
default:jsonl

Format of the response

Available options:
json,
jsonl,
csv
compress
boolean
default:false

Compress the response in gzip format

batch_size
integer

Number of records to include in each response batch

Required range: x >= 1000
part
integer

Number of batch to return. The numbering starts from 1.

Response

OK

The response is of type object.