Bright Data

Bright Data Unlock API

Submit and retrieve unlock requests.

Documentation GitHub OpenAPI

Operations 3

POST /request Unlock a URL (Synchronous) #

POST /unblocker/req Submit Asynchronous Unlock Request #

GET /unblocker/get_result Get Asynchronous Unlock Result #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/bright-data-unlock-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Bright Data Web Unlocker Unlock API
  description: 'Web Unlocker is a single-endpoint unblocking service. Submit any target URL and Bright Data

    handles residential proxy selection, JavaScript rendering, CAPTCHA solving, fingerprint

    management, and anti-bot evasion, returning the fully rendered response. Supports both

    synchronous (one-shot) and asynchronous (submit + poll) modes.


    Authentication uses a Bearer API token. Successful requests only — failed unlocks are not billed.

    '
  version: '1.0'
  contact:
    name: Bright Data
    url: https://docs.brightdata.com
servers:
- url: https://api.brightdata.com
  description: Production
security:
- BearerAuth: []
tags:
- name: Unlock
  description: Submit and retrieve unlock requests.
paths:
  /request:
    post:
      summary: Unlock a URL (Synchronous)
      description: 'Submit a URL for synchronous unblocking. Bright Data returns the rendered response (HTML,

        JSON, or raw bytes) once the page is unlocked. Use the asynchronous endpoints for long-running

        targets or batch flows.

        '
      operationId: unlockSync
      tags:
      - Unlock
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - url
              - zone
              properties:
                url:
                  type: string
                  format: uri
                zone:
                  type: string
                  description: Web Unlocker zone name.
                country:
                  type: string
                  description: ISO 3166-1 alpha-2 country code.
                format:
                  type: string
                  enum:
                  - raw
                  - json
                method:
                  type: string
                  enum:
                  - GET
                  - POST
                data:
                  type: string
      responses:
        '200':
          description: Unlocked response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
            text/html:
              schema:
                type: string
  /unblocker/req:
    post:
      summary: Submit Asynchronous Unlock Request
      operationId: unlockAsync
      tags:
      - Unlock
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - url
              - zone
              properties:
                url:
                  type: string
                  format: uri
                zone:
                  type: string
                country:
                  type: string
                response_id:
                  type: string
                  description: Optional caller-provided correlation id.
                callback_url:
                  type: string
                  format: uri
                  description: Webhook for completion.
                format:
                  type: string
                  enum:
                  - raw
                  - json
      responses:
        '200':
          description: Submitted.
          content:
            application/json:
              schema:
                type: object
                properties:
                  response_id:
                    type: string
  /unblocker/get_result:
    get:
      summary: Get Asynchronous Unlock Result
      operationId: getUnlockResult
      tags:
      - Unlock
      parameters:
      - name: response_id
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Result.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - pending
                    - ready
                    - failed
                  result:
                    type: object
                    additionalProperties: true
                  status_code:
                    type: integer
        '202':
          description: Not yet ready.
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer