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 zproxy.lum-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
|
zproxy.lum-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
- Country Targeting - Learn how to send a request from a specific country.
- State targeting - Learn how to send a request from a specific state (for countries where state applies).
- City targeting - Learn how to send a request from a specific city.
- Zipcode targeting - Learn how to target a specific zip code, when sending your request.
- ASN targeting - Learn how to target a specific autonomous system number, when sending your request.
- Control IP rotation - Learn how to control your request IP rotation.
- Selecting Super Proxy in a Specific Country - Learn how to select a super proxy from a specific country.
-
Configuring DNS resolution - Learn how to choose where DNS resolution is performed (remotely or locally)
- Request Error Handling - Learn how to request error handling when sending your request.
-
Sending requests directly from Super Proxy - Learn how to send your request directly from the super proxy.
- API Token Options - Learn about the different API options.
- Target-Specific OS - Learn how to target a specific operating system.
Residential-Specific API Functions
Below are the API functions that apply to our Residential proxy network
- Mobile Carrier Targeting - Learn how to target a specific mobile carrier.
- Selecting a Specific gIP - Learn how to target a specific gIP allocated to your zone.
Mobile Carrier Targeting
You can choose to use a specific carrier from this list:
a1, aircel, airtel, att, celcom, chinamobile, claro, comcast, cox, digi, dt, docomo, dtac, etisalat, idea, kyivstar, meo, megafon, mtn, mtnza, mts, optus, orange, qwest, reliance_jio, robi, sprint, telefonica, telstra, tmobile, tigo, tim, verizon, vimpelcom, vodacomza, vodafone, vivo, zain, vivabo, telenormyanmar, kcelljsc, swisscom, singtel, asiacell, windit, cellc, ooredoo, drei, umobile, cableone, proximus, tele2, mobitel, o2, bouygues, free, sfr, digicel
- Example for carrier Deutsche Telekom:
lum-customer-{YOUR_CUSTOMER_ID}-zone-{YOUR_ZONE}-carrier-dt
- Example for carrier Sprint:
lum-customer-{YOUR_CUSTOMER_ID}-zone-{YOUR_ZONE}-carrier-sprint
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 zproxy.lum-superproxy.io:22225 --proxy-user brd-customer-<CUSTOMER_ID>-zone-<ZONE_NAME>-gip-us_7922_fl_hollywood_0:<ZONE_PASSWORD> "http://target.si
Categories