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

Query Parameters

zone
string
required

Zone

country
string

2-letter Country code

list_countries
boolean

Return JSON array of [{ip, country},..] instead of plain list of IPs

Response

200 - application/json

Successful response with plain IPs list separated by new line, or JSON array of [{ip, country},..] in case list_countries=true

Return JSON array of [{ip, country},..] when list_countries=true

Example:

ip
string

IP address

Example:

"1.1.1.1"

country
string

2-letter Country code

Example:

"us"