# 域名 Whois 概览

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/domain_analytics/whois/overview/live`

**Tags:** DataForSEO

附带 SEO 指标的 Whois 记录。每项包含 `domain`、`created_datetime`、`changed_datetime`、`expiration_datetime`、`updated_datetime`、`first_seen`、`epp_status_codes`、`tld`、`registered`、`registrar`，以及 `metrics` 和 `backlinks_info`。使用 `limit`、`offset` 和 `offset_token` 分页，并按 `get_dataforseo_domains_whois_available_filters` 中的字段过滤。

### 计费参考

- 计量方式：按上报的响应成本计量。
- 参考请求估算：0.012 美元。
- 参考客户倍率：1.0。不得对已结算的客户金额再次应用。

仅供参考的元数据，不是账户报价、保证价格或消费上限。资源额度不同于 Felo 额度。最终扣费以 Felo 计费记录为准。

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Request body

Required: **no**

### application/json

Schema:

```json
{
  "type": "array",
  "items": {
    "type": [
      "object",
      "null"
    ],
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "limit": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>返回的域名数量上限</em><br>可选字段<br>默认值：<code>100</code><br>最大值：<code>1000</code>"
          },
          "offset": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>返回项在结果数组中的偏移量</em><br>可选字段<br>默认值：<code>0</code><br>如果指定值 <code>10</code>，结果数组中的前十个 <code>items</code> 将被省略，数据将从后续项开始提供；<br><strong>注意：</strong>建议仅在检索最多 10,000 条结果时使用此参数；如需检索超过 10,000 条结果，请改用 <code>offset_token</code>"
          },
          "offset_token": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>用于后续请求的令牌</em><br>可选字段<br>在每次请求响应的同名字段中提供；<br>使用此参数可在单次请求尝试获取超过 100,000 条结果时避免超时；<br>通过指定响应数组中的唯一 <code>offset_token</code> 值，你将获得初始任务的后续结果；<br><code>offset_token</code> 值对每个后续任务都是唯一的<br><strong>注意：</strong>如果请求中指定了 <code>offset_token</code>，所有其他参数都应与此前的请求保持一致<br>有关此参数的更多信息，请参阅我们的 <a href=\"https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token\" target=\"_blank\">帮助中心</a>"
          },
          "filters": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": [
                "object",
                "null"
              ]
            },
            "description": "<em>结果筛选参数数组</em><br>可选字段<br><strong>可同时添加多个筛选条件（最多 8 个）</strong><br>应在条件之间设置逻辑运算符 <code>and</code>、<code>or</code><br>支持以下运算符：<br><code>regex</code>、<code>&lt;</code>、<code>&lt;=</code>、<code>&gt;</code>、<code>&gt;=</code>、<code>=</code>、<code>&lt;&gt;</code>、<code>in</code>、<code>not_in</code>、<code>like</code>、<code>not_like</code><br>可在 <code>like</code> 和 <code>not_like</code> 中使用 <code>%</code> 运算符，匹配任意长度（零个或多个字符）的字符串"
          },
          "order_by": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            },
            "description": "<em>结果排序规则</em><br>可选字段<br>可使用与 <code>filters</code> 数组相同的值对结果排序<br>可能的排序类型：<br><code>asc</code> - 结果将按升序排列<br><code>desc</code> - 结果将按降序排列<br>使用逗号作为分隔符<br>示例：<br><code>[\"metrics.organic.pos_1,desc\"]</code><br>默认规则：<br><code>[\"metrics.organic.count,desc\"]</code><br><strong>注意，单次请求中最多可设置三条排序规则</strong><br>应使用逗号分隔多条排序规则<br>示例：<br><code>[\"expiration_datetime,asc\",\"metrics.organic.etv,desc\",\"metrics.organic.pos_1,desc\"]</code>"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>用户自定义任务标识符</em><br>可选字段<br><em>字符数上限为 255</em><br>可使用此参数标识任务，并将其与结果对应<br>可在响应的 <code>data</code> 对象中找到指定的 <code>tag</code> 值"
          }
        },
        "example": [
          {
            "limit": 2,
            "filters": [
              [
                "epp_status_codes",
                "in",
                [
                  "client_transfer_prohibited",
                  "client_update_prohibited"
                ]
              ]
            ]
          }
        ]
      }
    ]
  },
  "example": [
    {
      "limit": 2,
      "filters": [
        [
          "epp_status_codes",
          "in",
          [
            "client_transfer_prohibited",
            "client_update_prohibited"
          ]
        ]
      ]
    }
  ]
}
```

## Responses

### 200 — 操作成功

Headers:
- `X-Request-Id` (string) — 联系 Felo 支持时需提供的请求标识符。

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveResponseInfo"
    }
  ]
}
```

### 400 — 无法处理该请求。请检查请求参数。

### 401 — 需要有效的 Felo API 密钥。

### 402 — 由于未满足计费要求，请求无法继续。

### 403 — 该账户无权执行此操作。

### 429 — 已达到请求或支出限额。

### 502 — 服务无法完成该请求。

### 503 — API 或计费服务暂时不可用。

### 504 — 服务在处理请求时超时。

### default — 错误响应；上游透传响应可能采用提供方格式

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_BacklinksInfo

`#/components/schemas/Response36Afe1097B20_BacklinksInfo`

```json
{
  "type": "object",
  "properties": {
    "referring_domains": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>平均引用域名数量</em>",
      "format": "int64"
    },
    "referring_main_domains": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>平均引用主域名数量</em>",
      "format": "int64"
    },
    "referring_pages": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>平均引用页面数量</em>",
      "format": "int64"
    },
    "dofollow": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>平均 dofollow 链接数</em>",
      "format": "int64"
    },
    "backlinks": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>平均反向链接数</em>",
      "format": "int64"
    },
    "time_update": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>反向链接数据的更新日期和时间</em><br>            采用 UTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”；<br>            示例：<br>            <code class=\"long-string\">2019-11-15 12:57:46 +00:00</code>"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`

```json
{
  "properties": {
    "version": {
      "type": [
        "string",
        "null"
      ],
      "description": "API 的当前版本"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "通用状态码\n完整响应码列表见此处"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "通用信息性消息\n完整的一般信息性消息列表见此处"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "总执行时间，秒"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "任务总费用，美元",
      "format": "double"
    },
    "tasks_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "tasks 数组中的任务数",
      "format": "int64"
    },
    "tasks_error": {
      "type": [
        "integer",
        "null"
      ],
      "description": "tasks 数组中返回错误的任务数",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseTaskInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`

```json
{
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ],
      "description": "任务标识符\n我们系统中 UUID 格式的唯一任务标识符"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "任务的状态码\n由 DataForSEO 生成，范围如下：10000-60000\n完整响应码列表见此处"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "任务的信息性消息\n完整的一般信息性消息列表见此处"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "执行时间，秒"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "任务总费用，美元",
      "format": "double"
    },
    "result_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "result 数组中的元素数",
      "format": "int64"
    },
    "path": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "URL 路径"
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "object",
          "null"
        ]
      },
      "description": "包含你在 POST 请求中指定的相同参数"
    }
  }
}
```

### Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveItem

`#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveItem`

```json
{
  "type": "object",
  "properties": {
    "domain": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>域名</em>"
    },
    "created_datetime": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>注册日期和时间</em><br>域名首次注册的日期和时间（采用 <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" rel=\"noopener noreferrer\" target=\"_blank\">ISO 8601 格式</a>） <br>示例： <br><code>\"1997-03-29 03:00:00 +00:00\"</code>"
    },
    "changed_datetime": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>域名条目变更的日期和时间</em><br>域名条目上次修改的日期和时间（采用 <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" rel=\"noopener noreferrer\" target=\"_blank\">ISO 8601 格式</a>）<br>示例： <br><code>\"2021-01-14 08:36:28 +00:00\"</code>"
    },
    "expiration_datetime": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>域名到期的日期和时间</em><br>域名到期时间的日期和时间（采用 <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" rel=\"noopener noreferrer\" target=\"_blank\">ISO 8601 格式</a>） <br>示例： <br><code>\"2022-11-26 17:21:23 +00:00\"</code>"
    },
    "updated_datetime": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>域名更新的日期和时间</em><br>域名上次更新的日期和时间（采用 <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" rel=\"noopener noreferrer\" target=\"_blank\">ISO 8601 格式</a>） <br>示例： <br><code>\"2021-01-29 13:59:38 +00:00\"</code>"
    },
    "first_seen": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>我们的爬虫首次发现该域名的日期和时间</em><br>采用 UTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”<br>示例： <br><code>\"2019-11-15 12:57:46 +00:00\"</code>"
    },
    "epp_status_codes": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "<em>可扩展配置协议状态代码</em><br>域名注册状态，<a href=\"https://www.icann.org/resources/pages/epp-status-codes-2014-06-16-en\" rel=\"noopener noreferrer\" target=\"_blank\">如 ICANN 所定义</a>"
    },
    "tld": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>顶级域名</em><br><a href=\"https://www.iana.org/domains/root/db\" rel=\"noopener noreferrer\" target=\"_blank\">DNS 根区</a>中的顶级域名"
    },
    "registered": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "<em>域名注册状态</em><br>如果为 <code>false</code>，域名注册已过期<br><strong>注意：过期域名只会在数据库中保留很短时间</strong>"
    },
    "registrar": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>域名注册商</em><br>如果为 <code>null</code>，则域名注册商未知<br>示例：<br><code>NameCheap, Inc.</code>"
    },
    "metrics": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_MetricsBundleInfo"
        }
      ],
      "description": "<em>与指定域名相关的排名数据</em>"
    },
    "backlinks_info": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_BacklinksInfo"
        }
      ],
      "description": "<em>返回域名的反向链接数据</em>"
    }
  },
  "description": "条目数组"
}
```

### Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveResponseInfo

`#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveResponseInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
    },
    {
      "type": "object",
      "properties": {
        "tasks": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveTaskInfo"
              }
            ]
          },
          "description": "<em>任务数组</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveResultInfo

`#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "total_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>我们数据库中与你的请求相关的结果总数</em>",
      "format": "int64"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em><code>items</code> 数组中返回的结果数</em>",
      "format": "int64"
    },
    "offset": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em> POST 请求中指定的结果偏移值</em>"
    },
    "offset_token": {
      "type": [
        "string",
        "null"
      ]
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveItem"
          }
        ]
      },
      "description": "<em>包含排名和流量数据</em>"
    }
  }
}
```

### Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveTaskInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_DomainAnalyticsWhoisOverviewLiveResultInfo"
              }
            ]
          },
          "description": "<em>结果数组</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_MetricsBundleInfo

`#/components/schemas/Response36Afe1097B20_MetricsBundleInfo`

```json
{
  "type": "object",
  "properties": {
    "organic": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_MetricsInfo"
        }
      ],
      "properties": {
        "is_new": {
          "type": [
            "integer",
            "null"
          ],
          "description": "新增排名元素数量\n表示该域名新增的排名元素数量",
          "format": "int64"
        },
        "is_up": {
          "type": [
            "integer",
            "null"
          ],
          "description": "排名上升\n表示该域名在 Google 搜索中排名上升的元素数量",
          "format": "int64"
        },
        "is_down": {
          "type": [
            "integer",
            "null"
          ],
          "description": "排名下降\n表示该域名在 Google 搜索中排名下降的元素数量",
          "format": "int64"
        },
        "is_lost": {
          "type": [
            "integer",
            "null"
          ],
          "description": "丢失的排名元素\n表示该域名此前出现在 SERP 中、但最近一次检查时未找到的排名元素数量",
          "format": "int64"
        }
      },
      "description": "<em>自然搜索的排名和流量数据</em>"
    },
    "paid": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_MetricsInfo"
        }
      ],
      "description": "<em>付费搜索的排名和流量数据</em>"
    }
  }
}
```

### Response36Afe1097B20_MetricsInfo

`#/components/schemas/Response36Afe1097B20_MetricsInfo`

```json
{
  "type": "object",
  "properties": {
    "pos_1": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>该域名排名第 1 的自然 SERP 数量</em>"
    },
    "pos_2_3": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>该域名排名第 2-3 的自然 SERP 数量</em>"
    },
    "pos_4_10": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>该域名排名第 4-10 的自然 SERP 数量</em>"
    },
    "pos_11_20": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>该域名排名第 11-20 的自然 SERP 数量</em>"
    },
    "pos_21_30": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>该域名排名第 21-30 的自然 SERP 数量</em>"
    },
    "pos_31_40": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>该域名排名第 31-40 的自然 SERP 数量</em>"
    },
    "pos_41_50": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>该域名排名第 41-50 的自然 SERP 数量</em>"
    },
    "pos_51_60": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>该域名排名第 51-60 的自然 SERP 数量</em>"
    },
    "pos_61_70": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>该域名排名第 61-70 的自然 SERP 数量</em>"
    },
    "pos_71_80": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>该域名排名第 71-80 的自然 SERP 数量</em>"
    },
    "pos_81_90": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>该域名排名第 81-90 的自然 SERP 数量</em>"
    },
    "pos_91_100": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>该域名排名第 91-100 的自然 SERP 数量</em>"
    },
    "etv": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>估算流量</em><br>该域名的估算自然搜索月流量<br>由该域名排名的所有关键词的 CTR（点击率）与搜索量的乘积计算得出<br>如需了解该指标的计算方式，请参阅<a href=\"https://dataforseo.com/help-center/how-is-etv-calculated\" rel=\"noopener noreferrer\" target=\"_blank\">此帮助中心文章</a>"
    },
    "count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>包含该域名的自然 SERP 总数</em>",
      "format": "int64"
    },
    "estimated_paid_traffic_cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>将自然搜索流量转化为付费流量的预估成本</em><br>表示该域名排名所有关键词的广告投放预估月度成本（美元）<br>该指标按自然搜索 <code>etv</code> 与付费 <code>cpc</code> 值的乘积计算，表示通过 Google 搜索中的 PPC 广告获得预估月度自然流量的成本<br>在<a href=\"https://dataforseo.com/help-center/how-is-traffic-cost-calculated\" rel=\"noopener noreferrer\" target=\"_blank\">这篇帮助中心文章</a>中了解该指标的计算方法"
    },
    "is_new": {
      "type": [
        "integer",
        "null"
      ],
      "description": "新增排名元素数量\n表示该域名新增的排名元素数量",
      "format": "int64"
    },
    "is_up": {
      "type": [
        "integer",
        "null"
      ],
      "description": "排名上升\n表示该域名在 Google 搜索中排名上升的元素数量",
      "format": "int64"
    },
    "is_down": {
      "type": [
        "integer",
        "null"
      ],
      "description": "排名下降\n表示该域名在 Google 搜索中排名下降的元素数量",
      "format": "int64"
    },
    "is_lost": {
      "type": [
        "integer",
        "null"
      ],
      "description": "丢失的排名元素\n表示该域名此前出现在 SERP 中、但最近一次检查时未找到的排名元素数量",
      "format": "int64"
    }
  }
}
```