Skip to main content
GET
cURL
Paste your API key to the authorization field. To get an API key, Create an account and learn how to generate an API key

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

NETWORK_TYPE
enum<string>
required

Can be one of following:

all: All network type

res: Residential

dc: Datacenter

mobile: Mobile

Available options:
all,
res,
dc,
mobile

Response

200 - application/json

OK

The response is of type object.