Proxy REST API

You must have an API Key to access Bright Data proxy APIs. Get it here: API Key tutorial

API Endpoint: POST /request API URL: https://api.brightdata.com/request

Supported parameters

string

required

Name of the proxy zone which will service your request.

string

required

Target URL for your request.

string

default:"GET"

Method for requesting an HTML via proxy is GET.

string

Format for requesting a raw HTML via proxy is raw.Format for request a JSON response is json.

string

Country code of proxy which request is relayed thru.

string

City name of proxy which request is relayed thru, must have country defined.Supported in DC & ISP for zones preconfigured with cities, and in Residential and mobile networks by default.

string

Zip code which request is relayed thru, must have country defined.Supported in Residential networks only.

string

ASN code which request is relayed thru, must have country defined.Supported in Residential networks only.

string

For mobile network only: carrier code in which request is relayed thru.Supported in mobile networks only.

string

Operating system of the client to set on proxy.Supported in mobile networks only.

string

Use local or remote to set if domain name mapping is done locally on client side or on remote proxy peer.

string

A string relayed by the client to mark a session, all requests with the same session parameter will be relayed to the same proxy peer.

string

In Datacenter and ISP zones: Relay the request to a specific proxy identified by the ip.

string

In Residential and Mobile zones: Relay the request to a specific proxy group identified by the gip.

string

Include a unique c_tag flag in their requests. In response, businesses echo back the same tag in the header. This seamless exchange ensures that each response is bound to its corresponding request, eliminating confusion and streamlining data management.

boolean

Setting the parameter to true will instruct to process the request by Bright Data super proxy, a datacenter located proxy and not the proxy peer itself.

{
  HTTP/1.1 200 OK
  Content-type: text/html
  Header_1: header_text

  HTML Body from target website.... 
}

{
  HTTP/1.1 200 OK
  Content-type: text/json

  {
    "status_code": 200,
    "headers": {"header_1": "header_txt1", ...},
    "body": "target website text_or_utf8_bin_data"
  }
}

curl -H "Authorization: Bearer [API KEY HERE]" -H "Content-Type: application/json" -d '{"zone": "Zone information","url": "https://geo.brdtest.com/welcome.txt", "format": "raw"}' https://api.brightdata.com/request

Pending review

Unreachable pages

Supported parameters

​Supported parameters

Supported parameters