API

Learn about Bright Data’s API for the Residential proxy network, how to get started, basic guidelines, and some tips for optimal use.

API Documentation - Residential proxy network

Our API documentation below describes how to use Bright Data's API commands and optional flags used for automating and controlling single or recurrent actions executed in regard to your Residential proxy zone.

Bright Data's API supports various programming languages, such as shell, Node.js, Java, C#, VB, PHP, Python, Ruby, Perl, etc.

Authentication methods

When you send a request, using your Residential proxy you'll need to use your zone credentials as an authentication method (<CUSTOMER_ID> and <ZONE_PASSWORD>).

When you send an account management request, you'll need to use an API token as your authentication method.

Residential Proxy Request Syntax

The simplest GET request with a Residential Proxy

curl--proxy brd.superproxy.io:22225 --proxy-user brd-customer-<CUSTOMER_ID>-zone-<ZONE_NAME>:<ZONE_PASSWORD> "https://lumtest.com/myip.json" 

The expected output for this request should look like the following:

{"ip":"ALLOCATED_IP","country":"PK","asn":{"asnum":203020,"org_name":"HostRoyale Technologies Pvt Ltd"},"geo":{"city":"Islamabad","region":"IS","region_name":"Islamabad","postal_code":"44040","latitude":33.7233,"longitude":73.0435,"tz":"Asia/Karachi","lum_city":"islamabad","lum_region":"is"}}

Breakdown of the basic request elements

brd.superproxy.io 

Address of our load balancer that will find the fastest Super Proxy for your request

22225 

Infrastructure port of our Super Proxies that is used to receive your requests

-user brd-customer-<CUSTOMER_ID>-zone-<ZONE_NAME> 

Username authentication. In its most basic form, it defines your username and what zone you will use for your request. 

<ZONE_PASSWORD> 

Zone password. All zones have passwords that are used for authentication

For an in-depth interactive display of all the API use cases, integrations, and preferences, please see our API examples page.

Please note: You'll need to sign up (for free), and log in to the Bright Data control panel in order to access this API tool. If you add your payment method, you’ll even receive a $5 credit to get you started!

General Proxy API Functions

Below are the API functions that apply to most of our proxy products

Residential-Specific API Functions

Below are the API functions that apply to our Residential proxy network

Selecting a Specific gIP

Option available only for zones with multiple IPs allocated. To target a specific gIP allocated to your zone, use -gip-gip_name request parameter.

curl--proxy brd.superproxy.io:22225 --proxy-user brd-customer-<CUSTOMER_ID>-zone-<ZONE_NAME>-gip-us_7922_fl_hollywood_0:<ZONE_PASSWORD> "http://target.si

Was this article helpful?