Skip to main content

​
Make your first request in minutes

Once your Unlocker API is created, you can begin unlocking websites immediately. This guide walks you through sending your first successful request, explains the available access methods, and provides ready-to-use examples.

Postman Example

Node.js Example

Python Example

​
Choose an access method

Bright Data provides two ways to access the Web Unlocker API. Both methods return identical results, but are optimized for different workflows.

Direct API access (recommended)

A pure REST API method for easy access and straightforward integration.

Native proxy-based access

For workflows that rely on proxy-based routing.
A simple and RESTful way to interact with Bright Data’s Web Unlocker API. Direct API access abstracts proxy management and allows you to send requests via a central endpoint, ensuring ease of use and straightforward REST API integration.

​
Best for:

  • Centralized endpoint: Access Web Unlocker API via a single, RESTful endpoint.
  • Streamlined direct integration: Eliminating the complexity of managing proxies or routing.
  • Single API key authentication: Secure and easy to use, replacing the need for username-password management.

​
Sending your first request

After setting up your Web Unlocker API zone, you can find:
  • Your API key
  • A ready-to-use request example
  • Your zone name
in the Overview tab of your Unlocker API zone.
Web Unlocker API Overview tab
The following is an example of a simple Web Unlocker API cURL request:
Direct API access - cURL
curl -H "Content-Type: application/json" -H "Authorization: Bearer [INSERT_YOUR_API_KEY]" -d "{\"zone\": \"[INSERT_YOUR_WEB_UNLOCKER_ZONE_NAME]\", \"url\": \"[INSERT_YOUR_TARGET_URL]\", \"format\": \"raw\", \"body\": \"{\\\"key\\\":\\\"value\\\"}\"}" https://api.brightdata.com/request

​
Request breakdown

  1. API Endpoint: https://api.brightdata.com/request
  2. Authorization Header: Authorization: Bearer [INSERT YOUR API key]
    • Your API key is found within your Web Unlocker API zone.
  3. Payload:
    • zone: Your specific Web Unlocker API zone name.
    • url: The target URL you wish to access via Web Unlocker API.
    • format: Defines the response format. Use raw to receive the raw response from the target site.
    • [Optional] body: Specifies the raw POST payload sent to the target URL. e.g. "body": "{\"key\":\"value\"}"

​
Generating your Bright Data API key

A Bright Data API key is your secure authentication token for accessing Web Unlocker API via Direct API access. When adding a new Web Unlocker API zone in the control panel, an API key will be generated automatically and can be found within the Overview tab of your zone.
Web Unlocker API key
To generate a new API key:
  • Navigate to Account settings.
  • Scroll down and click the Add API key button.
  • Follow the on-screen instructions to complete the process.
We strongly recommend having an expiration date set on your API key for increased security.
The API key will be shown to you on the screen only so make sure you copy and store it in a safe location per your organization’s policies

​
Native proxy-based access

Proxy-based access is designed for workflows that already use proxy routing. Instead of a REST endpoint, requests are sent through Bright Data’s super proxy.

​
Required credentials

In order to access Web Unlocker, you will need to provide credentials which are comprised of:
  1. Your customer ID
  2. Your Web Unlocker API zone name
  3. Your Web Unlocker API password
  4. Bright Data SSL certificate

​
Customer ID

Customer ID can be found in the welcome email you received, or by clicking your account initial letter on the top right screen of your control panel, or by clicking here: Account settings .

​
Zone name and password

Your zone name and password can be found in the overview tab of your unlocker zone in the control panel.

​
Bright Data SSL Certificate

Prevent SSL errors by setting up Bright Data SSL certificate
SSL Certificate can be found by clicking “SSL certificate” wizard on your zone’s overview top menu. See further instructions here: SSL certificate. Alternatively, you can ignore SSL errors.

​
Web Unlocker API: HTTPS Proxy code examples

Once you have your credentials, use the following code to send your first request: 
curl "http://lumtest.com/myip.json" --proxy brd.superproxy.io:33335 --proxy-user brd-customer-<customer_id>-zone-<zone_name>:<zone_password>
The code above uses the residential proxy to send a request to http://lumtest.com/myip.json. It returns your IP information in a JSON format:
Output
{
  "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"
  }
}
Now, replace “https://lumtest.com/myip.json” with the website of your choice.