POST
/
request
cURL
curl --request POST \
  --url https://api.brightdata.com/request \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "zone": "web_unlocker1",
  "url": "https://example.com/page",
  "format": "json",
  "method": "GET",
  "country": "us",
  "data_format": "markdown"
}'
"OK"
Related guide: Unlocker API Introduction

Bright Data Python SDK

For an easy start using our tools check out our new Python SDK.

Authorizations

​
Authorization
string
header
required

Use your Bright Data API Key as a Bearer token in the Authorization header.

Get API Key from: https://brightdata.com/cp/setting/users.

Example: Authorization: Bearer b5648e1096c6442f60a6c4bbbe73f8d2234d3d8324554bd6a7ec8f3f251f07df

Query Parameters

​
async
boolean

Set this to true for asynchronous

Body

application/json
​
zone
string
required

Zone identifier that defines your Bright Data product configuration. Each zone contains targeting rules, output preferences, and access permissions. Manage zones at: https://brightdata.com/cp/zones

Example:

"web_unlocker1"

​
url
string
required

Complete target URL to scrape. Must include protocol (http/https), be publicly accessible.

Example:

"https://example.com/page"

​
format
enum<string>
required

Response format: raw returns HTML content as string, json returns structured data.

Available options:
raw,
json
Example:

"json"

​
method
string
default:GET

Method for requesting an HTML via proxy is GET.

Example:

"GET"

​
country
string

Two-letter ISO 3166-1 country code for proxy location (e.g., us, gb, de, ca, au). If not specified, system auto-selects optimal location based on your zone configuration. List of country codes: https://docs.brightdata.com/general/faqs#where-can-i-see-the-list-of-country-codes

Example:

"us"

​
data_format
enum<string>

Additional response format transformation: markdown converts HTML content to clean markdown format, screenshot captures a PNG image of the rendered page.

Available options:
markdown,
screenshot
Example:

"markdown"

Response

OK

The response is of type string.

Example:

"OK"