Skip to main content
POST
/
request
cURL
curl --request POST \
  --url https://api.brightdata.com/request \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "zone": "<string>",
  "url": "<string>",
  "format": "raw",
  "method": "GET",
  "country": "<string>",
  "city": "<string>",
  "zip": "<string>",
  "ASN": "<string>",
  "carrier": "<string>",
  "os": "<string>",
  "dns": "local",
  "session": "<string>",
  "ip": "<string>",
  "gip": "<string>",
  "c_tag": "<string>",
  "direct": true
}
'
"OK"
See instruction on how to create API key: API key creation

Authorizations

Authorization
string
header
required

在 Authorization 头中使用您的 Bright Data API Key 作为 Bearer token。

认证方法:

  1. 从 Bright Data 账户设置获取您的 API Key: https://brightdata.com/cp/setting/users
  2. 在请求的 Authorization 头中包含 API Key
  3. 格式: Authorization: Bearer YOUR_API_KEY

示例:

Authorization: Bearer b5648e1096c6442f60a6c4bbbe73f8d2234d3d8324554bd6a7ec8f3f251f07df

了解如何获取 Bright Data API Key: https://docs.brightdata.com/cn/api-reference/authentication#如何生成新的-api-key?

Body

application/json
zone
string
required

将为您的请求提供服务的代理区域名称。

url
string
required

请求的目标 URL。

format
enum<string>
required

通过代理请求原始 HTML 的格式为 raw

请求 JSON 响应的格式为 json

Available options:
raw,
json
method
string
default:GET

通过代理请求 HTML 的方法为 GET

country
string

请求通过的代理所在的国家代码。

city
string

请求通过的代理所在的城市名称,必须定义国家。

在数据中心和 ISP 区域中支持预配置城市,在住宅和移动网络中默认支持。

zip
string

请求通过的代理所在的邮政编码,必须定义国家。

仅在住宅网络中支持。

ASN
string

请求通过的代理所在的 ASN 代码,必须定义国家。

仅在住宅网络中支持。

carrier
string

仅适用于移动网络:请求通过的运营商代码。

仅在移动网络中支持。

os
string

设置在代理上的客户端操作系统。

仅在移动网络中支持。

dns
enum<string>

使用 localremote 设置域名映射是在客户端本地还是在远程代理节点上完成。

Available options:
local,
remote
session
string

客户端传递的字符串以标记会话,所有具有相同 session 参数的请求将被传递到相同的代理节点。

ip
string

在数据中心和 ISP 区域中:将请求转发到由 ip 标识的特定代理。

gip
string

住宅移动 区域中:将请求转发到由 gip 标识的特定代理组。

c_tag
string

在请求中包含唯一的 c_tag 标志。响应中,业务端会在头部返回相同的标志。此无缝交换确保每个响应都绑定到其对应的请求,消除混淆并简化数据管理。

direct
boolean

将参数设置为 true 会指示通过 Bright Data 超级代理(数据中心代理,而非代理节点本身)处理请求。

Response

成功

The response is of type string.

Example:

"OK"