Bright Data Docs home pagelight logodark logo
  • Support
  • Sign up
  • Sign up
Welcome
Proxy Infrastructure
Web Access APIs
Data Feeds
API Reference
General
Integrations
Introduction
  • Overview
Product Guides
  • Residential
    • Introduction
    • Quick Start
    • Configure
    • Access Policy
    • Send your first request
    • FAQs
  • Data Center
  • ISP
  • Mobile
  • Proxy Manager
  • Proxy configuration options
  • Proxy errors troubleshooting
  • Overcoming website blocking
  • Proxy products FAQ
  • SOCKS and SOCKS5 Proxies
Residential

Residential products FAQ

Find answers to common questions about integrating, configuring, and using Bright Data’s Residential proxy products, including IP types, geotargeting, and error codes.

To integrate the proxies into your code, please visit the API examples page, which can be accessed via your zone’s settings, under “access parameters”:

On this page, you can choose integration examples for most modern coding languages, just choose the integration type, your proxy zone, coding language, etc. and the page will generate a code snippet you can use right away.

Check out a few examples in the API examples page mentioned above (just choose “other software” in the “language” drop-down menu), or check our Integrations page, where we have specific guides to integrate our proxies within the most popular tools across the industry today.

Important note: If you are using Bright Data’s Web Unlocker API, Residential Proxies or the SERP API you probably need to use our SSL certificate to enable end-to-end secure connections. See instructions here.

We have prepared detailed guides for the most commonly used tools. You can find links to the guides in the list below:

BrowserScan https://docs.brightdata.com/integrations/browserscan

XLogin https://docs.brightdata.com/integrations/xlogin

GeeLark https://docs.brightdata.com/integrations/geelark

Puppeteer https://docs.brightdata.com/integrations/puppeteer

Playwright https://docs.brightdata.com/integrations/playwright

Selenium https://docs.brightdata.com/integrations/selenium

AdsPower https://docs.brightdata.com/integrations/adspower

Dolphin Anty https://docs.brightdata.com/integrations/dolphin-anty

Incogniton https://docs.brightdata.com/integrations/incogniton

Marketerbrowser https://docs.brightdata.com/integrations/marketerbrowser

SMLOGIN https://docs.brightdata.com/integrations/smlogin

Hidemyacc https://docs.brightdata.com/integrations/hidemyacc

OpenBullet https://docs.brightdata.com/integrations/openbullet

Switchyomega https://docs.brightdata.com/integrations/switchyomega

PhantomBuster https://docs.brightdata.com/integrations/phantombuster

BitBrowser https://docs.brightdata.com/integrations/bitbrowser

Maskfog https://docs.brightdata.com/integrations/maskfog

Ghost Browser https://docs.brightdata.com/integrations/ghost-browser

Postman https://docs.brightdata.com/integrations/postman

NGINX https://docs.brightdata.com/integrations/nginx

StablerSOLO https://docs.brightdata.com/integrations/stablersolo

VMLogin https://docs.brightdata.com/integrations/vmlogin

GoLogin https://docs.brightdata.com/integrations/gologin

Windows https://docs.brightdata.com/integrations/windows

Scrapy https://docs.brightdata.com/integrations/scrapy

AEZAKMI https://docs.brightdata.com/integrations/aezakmi

Beautifulsoup https://docs.brightdata.com/integrations/beautifulsoup

WebHarvy https://docs.brightdata.com/integrations/webharvy

Ubuntu https://docs.brightdata.com/integrations/ubuntu

Lalicat https://docs.brightdata.com/integrations/lalicat

Multilogin https://docs.brightdata.com/integrations/multilogin

Undetectable https://docs.brightdata.com/integrations/undetectable

Apify https://docs.brightdata.com/integrations/apify

iPhone https://docs.brightdata.com/integrations/ios

MuLogin https://docs.brightdata.com/integrations/mulogin

Changedetection https://docs.brightdata.com/integrations/changedetection

Morelogin https://docs.brightdata.com/integrations/morelogin

Proxifier https://docs.brightdata.com/integrations/proxifier

Texau https://docs.brightdata.com/integrations/texau

Android https://docs.brightdata.com/integrations/android

Kameleo https://docs.brightdata.com/integrations/kameleo

Screaming Frog https://docs.brightdata.com/integrations/screaming-frog

Foxy https://docs.brightdata.com/integrations/foxyproxy

SessionBox https://docs.brightdata.com/integrations/sessionbox

Insomniac https://docs.brightdata.com/integrations/insomniac

Helium Scraper https://docs.brightdata.com/integrations/helium-scraper

SaleFreaks https://docs.brightdata.com/integrations/salefreaks

Postern https://docs.brightdata.com/integrations/postern

Antik https://docs.brightdata.com/integrations/antik

Easync https://docs.brightdata.com/integrations/easync

ParseHub https://docs.brightdata.com/integrations/parsehub

Sphere Browser https://docs.brightdata.com/integrations/sphere-browser

Octoparse https://docs.brightdata.com/integrations/octoparse

ixBrowser https://docs.brightdata.com/integrations/ixbrowser

Shadowrocket https://docs.brightdata.com/integrations/shadowrocket

Firefox https://docs.brightdata.com/integrations/firefox

Chrome https://docs.brightdata.com/integrations/chrome

MacOS https://docs.brightdata.com/integrations/macos

ClonBrowser https://docs.brightdata.com/integrations/clonbrowser

Octo Browser https://docs.brightdata.com/integrations/octobrowser

Genlogin https://docs.brightdata.com/integrations/genlogin

Web Scraper https://docs.brightdata.com/integrations/webscraper

If the tool you’re using does not appear on the list and you would like to get a guide for it, contact us!

When sending your request, add the -country flag, after your zone’s name in the request, followed by the 2-letter ISO code for that country.

In the example below: We added -country-us to our request, so we will send a request originating from the United States (“us”).

curl "http://target.site" --proxy brd.superproxy.io:33335 --proxy-user brd-customer-<customer_id>-zone-<zone_name>-country-us: <zone_password>
The allocation of a country within the EU is random.
Relevant for DC, ISP, and Web Unlocker/SERP API

You can target the entire European Union region in the same manner as “Country” above by adding “eu” after “country” in your request: -country-eu

Requests sent using -country-eu, will use IPs from one of the countries below which are included automatically within “eu”:

AL, AZ, KG, BA, UZ, BI, XK, SM, DE, AT, CH, UK, GB, IE, IM, FR, ES, NL, IT, PT, BE, AD, MT, MC, MA, LU, TN, DZ, GI, LI, SE, DK, FI, NO, AX, IS, GG, JE, EU, GL, VA, FX, FO

In order to target a specific city you will need to use a Shared (pay-per-IP) or Dedicated proxy network.

When configuring your proxy zone, after selecting your preferred country, you can add a city, to further specify your geotargeting

Once you click on ‘Add city’ you will be displayed the available cities to target, for the selected country. In order to check the number of available IPs for a specific geolocation.

Once configured, you’ll be able to send requests from the selected city, using the following syntax

curl "http://target.site" --proxy brd.superproxy.io:33335 --proxy-user brd-customer-<customer_id>-zone-<zone_name>-country-<country>-city-<city>: <zone_password>

When selecting a two-word city it’ll be written as one word.

For example, when targeting Buenos Aires the syntax of the request will be:

-country-ar-city-buenosaires

To view more geotargeting examples, you may want to review our proxy integration examples page.

Bright Data offers proxies in every country in the world, except in the following countries:

  • Iran

  • Iraq

  • Syria

  • Lebanon

  • Palestine

  • North Korea

  • Cuba

  • Sudan

  • Crimea region of Russia

If you need proxies from there countries, unfortunately Bright Data will not be able to help you.

The event log will show you (at most) the last 200 requests you made with any zone in your account.

In your Bright Data control panel’s proxies page: https://brightdata.com/cp/zones

Go to the “Event Log” tab:

The presented data is:

  • Date: Time and date of the request

  • Zone: What Zone was used for the request

  • Source IP: What IP the request was made from

  • URL: The target site of the request

  • Result: Success or Fail of the request

  • This can be done by adding the session parameter to the proxy username:
brd.superproxy.io:33335 br-customer-<customer_id>-zone-<zone_name>-session-rand39484

Generate the random number on thread startup, and change it when you want to change the Proxy Peer assigned for the thread’s connection.

  • Session ID can be any random string/counter: requests with the same session string will use the same Proxy Peer (as long as possible); requests with different session strings will be assigned different Proxy Peers.
  • Using the following characters in the session ID will throw an error: - " `

  • This feature is only available for our proxy products, it will not work for Scraping Automation products such as the Web Unlocker

  • To force an IP change, just modify the session ID

  • If an assigned Proxy Peer (exit node IP) becomes unavailable, the Super Proxy will return an error “502 - No peers available” for the first request and then on the second request the super proxy will assign a new peer even if you do not change the session ID.

  • The Session IP is kept persistent for up to 5 minute of idle time. After 5 minutes with no requests, the IP is released back to the pool. To keep this Session/IP for longer, send a tiny keep-alive request every 30 seconds, to prevent this session from becoming idle for over a minute. This request may be anything small, such as /favicon.ico, or even a request that returns 404 (as long as the web server does not disconnect the socket due to this request).

Bright Data allows targeting the following Operating Systems:

curl --proxy-user brd-customer-<customer_id>-zone-<zone_name>-os-windows:<zone_password> --proxy brd.superproxy.io:33335 "<target_site>"

When using Bright Data’s Residential Proxy network, you may find the need to use a specific IP allocated to your zone.

  1. Send a test request with a ‘—verbose’ or ‘-v’ option added (this will turn on verbose logging)
curl "https://lumtest.com/myip.json" --verbose --proxy brd.superproxy.io:33335 --proxy-user brd-customer-<customer_id>-zone-<zone_name>:<zone_password>
  1. Locate the x-brd-ip response header and copy its value

  1. Add the -ip- flag to your request, after your zone’s name and use the hashed IP value copied in the previous step

  2. Send a test request, and review the response

curl "https://lumtest.com/myip.json" --proxy brd.superproxy.io:33335 --proxy-user brd-customer-<customer_id>-zone-<zone_name>-ip-<hashed-ip>:<zone_password>

We recommend using https://lumtest.com/myip.json as the target domain for testing, and to review your IP credentials.

This feature can be enabled by adding the ASN parameter to your Zone configuration, under Geolocation Targeting.

Once the configuration is saved, the ASN flag can be added to the Zone’s credentials
and be integrated when using the Residential proxies. For example:

curl --proxy brd.superproxy.io:33335 --proxy-user brd-customer-<customer_id>-zone-<zone_name>-asn-<asn-number>:<zone_password> "<target_site>"

Note: Values for ASN number can be found here.

Dedicated residential IPs can be targeted in the form of gIPs. They can be allocated under the zone’s configuration page by selecting a “Dedicated” IP type and choosing a number of gips. Also targeting a specific domain is required.

Once the configuration is saved, selecting “Show allocated Dedicated residential IPs” will provide a list of hash values that represent group IPs.

These values can be used to target a specific gip. For example:

curl --proxy brd.superproxy.io:33335 --proxy-user brd-customer-<customer_id>-zone-<zone_name>-gip-<gip_hash_value>:<zone_password> "<target_site>"

When outside of China
Targeting Chinese Residential IP peers is enough:

curl --proxy brd.superproxy.io:33335 --proxy-user brd-customer-<customer_id>-zone-<zone_name>-country-cn:<zone_password> "<target_site>"
  • 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
  • For Example
brd-customer-<customer_id>-zone-<zone_name>-carrier-dt

​
For single-step scraping:

SERP API is the ideal product for targeting SERPs as it has a guaranteed success rate (pay only for success) with active unlocking, automatically chooses the best proxies, customizes headers, fingerprinting, solves CAPTCHAs, and more.

​
For multi-step scraping (playwright/puppeteer/selenium):

Browser API is the ideal product as it is our fully cloud-hosted browser designed to help you easily focus on your multi-step data collection while we take care of the full proxy and unblocking infrastructure for you, including CAPTCHA solving.

Residential Proxy - No, SERP API is the ideal product for targeting SERPs as it has a guaranteed success rate (pay only for success) with active unlocking, automatically chooses the best proxies, customizes headers, fingerprinting, solves CAPTCHAs, and more. Targeting Google SERPs from the Residential network will result in Super-proxy bypass, which will casue the request to be sent from our servers instead of the peer.

Datacenter & ISP Proxies - No. When attempting to specifically target Google through either of these proxy networks, your request will be denied and you will receive the following error message in the response headers:

HTTP/1.1 403 Search engine host is not allowed
X-Luminati-Error: Forbidden: This target URL isn't supported on proxy networks, use the SERP API product for targeting this URL. You may contact your account manager or open a support ticket for assistance

When targeting search engines through the Residential or Mobile networks, the request will not go through the Residential or Mobile peer but instead will be sent directly through one of our super proxies. The reason for this behavior is to support the integration of the Residential and Mobile networks with a browser, which might need to load search engine resource endpoints from the target website.

In case you target a search engine domain using Residential or Mobile networks, the request will be passed directly through the super proxy, and the following response header will serve as an indication:

x-luminati-ip: superproxy bypass

Was this page helpful?

Send your first requestIntroduction
linkedinyoutubegithub
Powered by Mintlify
Assistant
Responses are generated using AI and may contain mistakes.