> ## Documentation Index
> Fetch the complete documentation index at: https://docs.brightdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 代理 REST API

> 通过 REST API 访问代理网络。

<Warning>
  必须拥有 API 密钥才能访问 Bright Data 的代理 API。如需获取 API 密钥，请点击 API 密钥教程

  [API Key tutorial](/api-reference/authentication#how-do-i-generate-a-new-api-key%3F)
</Warning>

**API 端点**: `POST` `/request`

**API URL:** [https://api.brightdata.com/request](https://api.brightdata.com/request)

### 支持的参数

<ParamField path="zone" type="string" required="true">
  负责处理请求的代理区域名称。
</ParamField>

<ParamField path="url" type="string" required="true">
  请求的目标 URL。
</ParamField>

<ParamField path="method" type="string" default="GET">
  如需通过代理请求 HTML，请输入 `GET`。
</ParamField>

<ParamField path="format" type="string">
  如需通过代理请求原始 HTML，请选择 `raw`。

  如需请求 JSON 格式的响应，请选择 `json`。
</ParamField>

<ParamField path="country" type="string">
  请求所经由的代理所在国家/地区的代码。
</ParamField>

<ParamField path="city" type="string">
  请求所经由的代理所在城市的名称，必须先定义国家/地区。

  适用范围：数据中心和 ISP（已预配置城市的区域）；住宅和移动网络（默认）。
</ParamField>

<ParamField path="zip" type="string">
  请求所经由的代理所在地的邮政编码，必须先定义国家/地区。

  仅适用于住宅网络。
</ParamField>

<ParamField path="ASN" type="string">
  请求所经由的代理的 ASN 代码，必须先定义国家/地区。

  仅适用于住宅网络。
</ParamField>

<ParamField path="carrier" type="string">
  移动网络专用：请求所经由的运营商的代码。

  仅适用于移动网络。
</ParamField>

<ParamField path="os" type="string">
  在代理上设置的客户端操作系统。

  仅适用于移动网络。
</ParamField>

<ParamField path="dns" type="string">
  `local`：在客户端本地执行域名映射；`remote`：在远程代理节点执行域名映射。
</ParamField>

<ParamField path="session" type="string">
  客户端传递的会话标识字符串，具有相同会话参数的所有请求都将转发到同一代理节点。
</ParamField>

<ParamField path="ip" type="string">
  适用于数据中心和 ISP 区域：将请求转发到由该 ip 标识的特定代理。
</ParamField>

<ParamField path="gip" type="string">
  适用于住宅和移动网络区域：将请求转发到由该 `gip` 标识的特定代理组。
</ParamField>

<ParamField path="c_tag" type="string">
  在请求中添加唯一 c\_tag 标记。 响应时，企业服务器会在响应标头中回显相同的标记。 这种无缝的标记传递机制可确保每个响应与其对应的请求精准匹配，有效避免混淆并简化数据管理。
</ParamField>

<ParamField path="direct" type="boolean">
  该参数设为 true 时，请求将由 Bright Data 的超级代理（位于数据中心的代理）处理，而不是由代理节点自身处理。
</ParamField>

<ResponseExample>
  ```json RAW theme={null}
  {
    HTTP/1.1 200 OK
    Content-type: text/html
    Header_1: header_text
    HTML Body from target website.... 
  }
  ```

  ```json JSON theme={null}
  {
    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"
    }
  }

  ```
</ResponseExample>

<RequestExample>
  ```sh Shell theme={null}
  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
  ```
</RequestExample>