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

PARTNER_NAME
string
required

Name of the proxy zone which will service your request.

Query Parameters

type
string
required

required signup type (residential|shared_dc|dedicated_dc|shared_isp|smart_resi)

more_than
number
default:1000

minimum amount of free ips on the type

mode
string

Flag to change output format. If set to raw, the API will return the exact amount of ips per country and more_than will be ignored.

Response

200 - application/json

OK

Example: