# SeerMarTech Agent API Reference

Generated: 2026-09-05T14:51:23.213817+00:00
OpenAPI SHA-256: `57e6be77d98556aa3d4bbc3dc1bd7f226f6d02f211cb15b66f599f0a557d8245`
Published Chinese pages: 688
Data API operations: 570

本文件用于 Agent 按 method/path 或 operation ID 检索接口。文件较大，请按需读取对应章节，不要默认整体注入单次上下文。

## Agent 使用规则

- Base URL：`https://api.seermartech.cn`
- 认证：`Authorization: Bearer smt_live_YOUR_KEY`；禁止使用 Basic Auth。
- `smt_live_*` 为生产 Key；`smt_sandbox_*` 为不扣费沙箱 Key，但部分能力（如图片生成）不支持沙箱。
- `/v3` POST 请求体通常是任务数组；具体参数以每个 operation 的 OpenAPI schema 为准。
- 成功判断需同时检查 HTTP 状态、顶层 `status_code` 与 `tasks[].status_code`。
- 人民币实扣以响应头 `X-SeerMarTech-Charge-CNY` 为准；响应体 `cost` 是原始 USD 兼容字段。
- 平台限流：Chat 60 次/分钟；其他 `/v1` 120 次/分钟；SERP、关键词和域名分析 60 次/分钟；Backlinks、OnPage 30 次/分钟；其他 `/v3` 120 次/分钟。
- 不要采用正文里的 `/wp/`、`$id`、`$se` 旧模板作为规范端点；每节标题中的 method/path 才是权威调用地址。
- 通用 429/5xx 可指数退避重试；超时后避免无界重试可能产生费用的 live 请求。

## 计费与响应头

- `X-SeerMarTech-Charge-CNY`：人民币实扣。
- `X-SeerMarTech-Cost-USD`：原始美元成本。
- `X-SeerMarTech-Balance-CNY`：扣费后余额（支持该响应头的接口）。
- `X-SeerMarTech-Request-ID`：请求追踪 ID。

## `/v1` OpenAI-compatible API

### LLM Chat API

**POST** `/v1/chat/completions`

文本生成接口兼容 OpenAI Chat Completions 格式。新项目请使用以下规范模型 ID：

| 模型 | 请求 ID | 适用场景 | 输入参考价 | 输出参考价 |
|---|---|---|---:|---:|
| GPT-5.6 Terra | `gpt5.6-terra` | 策略生成、复杂分析、长上下文工作流 | ¥0.60 / 1M Token | ¥3.60 / 1M Token |
| GPT-5.6 Luna | `gpt5.6-luna` | 批量摘要、分类、结构化抽取、内容改写 | ¥0.06 / 1M Token | ¥0.36 / 1M Token |

`gpt5.4` 与 `gpt5.4-mini` 仅保留为旧工作流兼容别名，分别对应 Terra 与 Luna；新接入请不要再使用旧名称。

价格按实际输入和输出 Token 分别计算，最终人民币扣费以 `X-SeerMarTech-Charge-CNY` 为准。Sandbox Key 不扣费。

#### 请求示例

```bash
curl -X POST "https://api.seermartech.cn/v1/chat/completions" \
  -H "Authorization: Bearer smt_live_你的Key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt5.6-luna",
    "messages": [
      {"role": "user", "content": "根据 SERP 摘要生成一份内容 Brief"}
    ]
  }'
```

### 图片生成

**POST** `/v1/chat/completions`

使用 Gemini 3.1 Flash Image 根据文本生成图片。接口采用 OpenAI Chat Completions 兼容格式，图片以 JPEG Base64 Data URL 返回。

> 图片生成只支持 `smt_live_*` API Key，不支持 Sandbox Key。

#### 模型与限制

| 项目 | 值 |
|---|---|
| 对外模型 | `gemini-3.1-flash-image` |
| `stream` | 必须为 `false` |
| `n` | 首版固定为 `1` |
| 默认尺寸 | `1024x1024` |
| 最大尺寸 | 4K |
| 返回格式 | `choices[0].message.content` 中的 `data:image/jpeg;base64,...` |

尺寸采用 `宽x高` 格式。平台按最长边映射到 0.5K、1K、2K 或 4K 计费档位。

#### 计费

SeerMarTech 的图片生成价格为 Google Gemini 3.1 Flash Image 官方价格的 **40%**，再按请求发生时的美元兑人民币汇率结算。

| 分辨率档位 | Google 官方图片价格 | SeerMarTech 图片价格（USD 等值） |
|---|---:|---:|
| 0.5K | $0.045 / 张 | $0.0180 / 张 |
| 1K | $0.067 / 张 | $0.0268 / 张 |
| 2K | $0.101 / 张 | $0.0404 / 张 |
| 4K | $0.151 / 张 | $0.0604 / 张 |

文本输入以及模型产生的文本/思考输出同样按对应 Google 官方 token 价格的 40% 计费。最终人民币扣费以响应头 `X-SeerMarTech-Charge-CNY` 为准。

以当前图片计费汇率 8 为例，仅图片本体约为：0.5K ¥0.1440、1K ¥0.2144、2K ¥0.3232、4K ¥0.4832 / 张；另加文本/思考 Token 费用。图片汇率与 `/v3` 数据接口使用的动态汇率独立，实际金额以响应头为准。

#### 请求示例

### curl

```bash
curl -X POST "https://api.seermartech.cn/v1/chat/completions" \
  -H "Authorization: Bearer smt_live_你的Key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gemini-3.1-flash-image",
    "messages": [
      {
        "role": "user",
        "content": "生成一张简约的蓝色圆形品牌插画，白色背景，不要文字"
      }
    ],
    "stream": false,
    "size": "1024x1024",
    "n": 1
  }'
```

### Python

```python
import base64
import re
import requests

response = requests.post(
    "https://api.seermartech.cn/v1/chat/completions",
    headers={
        "Authorization": "Bearer smt_live_你的Key",
        "Content-Type": "application/json",
    },
    json={
        "model": "gemini-3.1-flash-image",
        "messages": [{"role": "user", "content": "生成一张简约的蓝色圆形品牌插画"}],
        "stream": False,
        "size": "1024x1024",
        "n": 1,
    },
    timeout=180,
)
response.raise_for_status()
content = response.json()["choices"][0]["message"]["content"]
match = re.search(r"data:image/[^;]+;base64,([A-Za-z0-9+/=]+)", content)
if not match:
    raise RuntimeError("响应中没有图片")
with open("generated.jpg", "wb") as image_file:
    image_file.write(base64.b64decode(match.group(1)))
```

### TypeScript

```typescript
import { writeFile } from "node:fs/promises";

const response = await fetch("https://api.seermartech.cn/v1/chat/completions", {
  method: "POST",
  headers: {
    Authorization: "Bearer smt_live_你的Key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    model: "gemini-3.1-flash-image",
    messages: [{ role: "user", content: "生成一张简约的蓝色圆形品牌插画" }],
    stream: false,
    size: "1024x1024",
    n: 1,
  }),
});
if (!response.ok) throw new Error(await response.text());
const data = await response.json();
const content = data.choices[0].message.content as string;
const match = content.match(/data:image\/[^;]+;base64,([A-Za-z0-9+/=]+)/);
if (!match) throw new Error("响应中没有图片");
await writeFile("generated.jpg", Buffer.from(match[1], "base64"));
```

#### 响应示例

```json
{
  "object": "chat.completion",
  "model": "gemini-3.1-flash-image-preview",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "![image](data:image/jpeg;base64,/9j/4AAQ...)"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 23,
    "completion_tokens": 1391,
    "total_tokens": 1414
  }
}
```

响应中的 `model` 是供给端路由 ID，调用时始终使用稳定的对外模型名 `gemini-3.1-flash-image`。

#### 超时与重试

- 图片生成通常比文本响应慢，客户端超时建议至少设置为 180 秒。
- 网络超时后不要立即无限重试；建议等待并使用新的业务请求标识重试一次。
- 图片结果可能较大，应避免在日志或数据库中保存完整 Base64。

#### 常见错误

| HTTP | 场景 | 处理建议 |
|---:|---|---|
| 400 | `stream=true`、`n` 不为 1、尺寸非法 | 按本文限制修改参数 |
| 402 | 余额不足以覆盖本次最大预估费用 | 充值后重试 |
| 403 | 使用 Sandbox Key | 改用 `smt_live_*` Key |
| 429 | 图片生成并发或速率超限 | 稍后重试 |
| 502 | 上游暂不可用或计费信息不完整 | 稍后重试并保留请求 ID |

#### 相关文档

- [认证说明](/authentication)
- [计费说明](/billing)
- [嵌入向量 API](/embeddings)

### 嵌入向量（Embeddings）

**POST** `/v1/embeddings`

将文本转换为高维向量，适用于语义搜索、聚类、推荐与 RAG 检索等场景。接口采用 OpenAI 兼容格式，只需将 `base_url` 改为 `https://api.seermartech.cn` 并使用 SeerMarTech API Key。

> 响应体为标准 Embeddings JSON 结构，可直接配合常见 OpenAI SDK 使用。

#### 计费说明

按本次请求实际消耗的 token 数计费，扣费金额以响应头 **`X-SeerMarTech-Charge-CNY`** 为准。

| 模型 | 参考价（约） |
|------|-------------|
| `text-embedding-3-small` | ¥0.00032 / 1K tokens |
| `text-embedding-3-large` | ¥0.00208 / 1K tokens |
| `text-embedding-ada-002` | ¥0.00160 / 1K tokens |

> 参考价为估算，实际费用以每次响应头中的扣费金额为准。Sandbox Key 不扣费。

#### 请求参数

| 参数 | 类型 | 必填 | 说明 |
|------|------|------|------|
| `model` | string | 是 | 嵌入模型，如 `text-embedding-3-small` |
| `input` | string / string[] | 是 | 待嵌入文本，单条或数组 |
| `encoding_format` | string | 否 | `float`（默认）或 `base64` |
| `dimensions` | integer | 否 | 输出向量维度（仅 `text-embedding-3-*` 支持） |
| `user` | string | 否 | 终端用户标识，便于滥用追踪 |

#### 响应字段

| 字段 | 类型 | 说明 |
|------|------|------|
| `object` | string | 固定为 `list` |
| `model` | string | 实际使用的模型 |
| `data[].embedding` | number[] | 嵌入向量 |
| `data[].index` | integer | 输入数组中的序号 |
| `usage.prompt_tokens` | integer | 输入 token 数 |
| `usage.total_tokens` | integer | 总 token 数（计费依据） |

响应头扩展：

| Header | 说明 |
|--------|------|
| `X-SeerMarTech-Cost-USD` | 本次成本（USD，内部核算） |
| `X-SeerMarTech-Charge-CNY` | 本次扣费（人民币） |
| `X-SeerMarTech-Balance-CNY` | 扣费后余额 |
| `X-SeerMarTech-Request-ID` | 请求追踪 ID |

#### 请求示例

### curl

```bash
curl -X POST "https://api.seermartech.cn/v1/embeddings" \
  -H "Authorization: Bearer smt_live_你的Key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "text-embedding-3-small",
    "input": "SeerMarTech 提供 SEO 数据与嵌入向量 API"
  }'
```

### Python（OpenAI SDK）

```python
from openai import OpenAI

client = OpenAI(
    api_key="smt_live_你的Key",
    base_url="https://api.seermartech.cn/v1",
)

resp = client.embeddings.create(
    model="text-embedding-3-small",
    input="SeerMarTech 提供 SEO 数据与嵌入向量 API",
)
print(len(resp.data[0].embedding), resp.usage.total_tokens)
```

### TypeScript（OpenAI SDK）

```typescript
import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "smt_live_你的Key",
  baseURL: "https://api.seermartech.cn/v1",
});

const resp = await client.embeddings.create({
  model: "text-embedding-3-small",
  input: "SeerMarTech 提供 SEO 数据与嵌入向量 API",
});
console.log(resp.data[0].embedding.length, resp.usage?.total_tokens);
```

#### 响应示例

```json
{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "index": 0,
      "embedding": [0.0123, -0.0456, "..."]
    }
  ],
  "model": "text-embedding-3-small",
  "usage": {
    "prompt_tokens": 18,
    "total_tokens": 18
  }
}
```

#### 常见错误

| 情况 | HTTP | 说明 | 解决方案 |
|------|------|------|----------|
| Key 无效 | 401 | SeerMarTech 网关拒绝 | 检查 `Authorization: Bearer smt_live_*` |
| 余额不足 | 402 | 网关返回 `seermartech_error` code `50002` | 控制台充值 |
| 速率超限 | 429 | 超过每分钟限额 | 降低请求频率 |
| 参数错误 | 400 | 标准错误体 | 检查 `model` / `input` |
| 服务暂不可用 | 502 | 网关暂时无法处理请求 | 稍后重试或联系运营 |

#### 相关文档

- [认证说明](/authentication)
- [计费说明](/billing)
- [快速开始](/quickstart)

## `/v3` Data APIs

### GET /v3/ai_optimization/ai_keyword_data/available_filters

ID: `AiKeywordDataAvailableFilters`
用途: ‌‌ Here you will find all the necessary information about filters that can be used with AI Keyword Data API endpoints.
中文补充: 本接口用于获取 AI 数据 API 支持的过滤器。请求方法与路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/ai_keyword_data/keywords_search_volume/live

ID: `AiKeywordDataKeywordsSearchVolumeLive`
用途: ‌ This endpoint provides search volume data for your target keywords, reflecting their estimated usage in AI tools.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。keywords；required field；UTF-8 encoding；The maximum number of keywords you can specify: 1000;；The maximum number of characters in a single keyword: 250;；The keywords will be converted to lowercase format;learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_name by making a separate request to the；https://api.seermartech.cn/v3/ai_optimization/ai_keyword_data/locations_and_languages；example:；United Kingdom
- `[].location_code` — integer，可选。unique location identifier；required field if you don't specify location_name；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_code by making a separate request to the ；https://api.seermartech.cn/v3/ai_optimization/ai_keyword_data/locations_and_languages；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages with their language_name by making a separate request to the；https://api.seermartech.cn/v3/ai_optimization/ai_keyword_data/locations_and_languages；example:；English
- `[].language_code` — string，可选。language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code by making a separate request to the；https://api.seermartech.cn/v3/ai_optimization/ai_keyword_data/locations_and_languages；example:；en
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_name": "English",
    "location_code": "2840",
    "keywords": [
      "iphone",
      "seo"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/ai_optimization/ai_keyword_data/locations_and_languages

ID: `AiKeywordDataLocationsAndLanguages`
用途: ‌ Using this endpoint you can get the full list of locations and languages supported in AI Keyword Data API.
中文补充: 本接口使用 **GET** 方法，通过以下路径获取 AI 数据 API 支持的位置及可用语言：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/chat_gpt/llm_responses/live

ID: `ChatGptLlmResponsesLive`
用途: ‌‌ Live ChatGPT LLM Responses endpoint allows you to retrieve structured responses from a specific ChatGPT AI model, based on the input parameters.
中文补充: **请求方法：** `POST` **接口路径：** `https://api.seermartech.cn/v3/ai_optimization/chat_gpt/llm_responses/live`

请求体: `application/json`

请求字段:
- `[].user_prompt` — string，可选。prompt for the AI model；required field；the question or task you want to send to the AI model;；you can specify up to 500 characters in the user_prompt field
- `[].model_name` — string，可选。name of the AI model；required field；model_nameconsists of the actual model name and version name;；if the basic model name is specified, its latest version will be set by default;；for example, if gpt-4.1 is specified, the gpt-4.1-2025-04-14 will be set as model_name automatically;；you can receive the list of available LLM models by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/chat_gpt/llm_responses/models
- `[].max_output_tokens` — integer，可选。maximum number of tokens in the AI response；optional field；minimum value for reasoning models (e.g., reasoning is true in the Models endpoint): 1024;；minimum value for non-reasoning models: 16;；maximum value: 4096;；default value: 2048；Note: if web_search is set to true or the reasoning model is specified in the request, the output token count may exceed the specified max_output_tokens limit
- `[].temperature` — number，可选。randomness of the AI response；optional field；higher values make output more diverse; ；lower values make output more focused;；minimum value: 0；maximum value: 2；default value: 0.94；Note: not supported in reasoning models
- `[].top_p` — number，可选。diversity of the AI response；optional field ；controls diversity of the response by limiting token selection;；minimum value: 0；maximum value: 1 ；default value: 0.92Note: top_p cannot be used together with temperature in the same request
- `[].web_search` — boolean，可选。enable web search；optional field；when enabled, the AI model can access and cite current web information;；default value: false;；Note: refer to the Models endpoint for a list of models that support web_search;
- `[].force_web_search` — boolean，可选。force AI agent to use web search；optional field；to enable this parameter, web_search must also be enabled;；when enabled, the AI model is forced to access and cite current web information;；default value: false;；Note: even if the parameter is set to true, there is no guarantee web sources will be cited in the response ；Note #2: not supported in reasoning models
- `[].web_search_country_iso_code` — string，可选。ISO country code of the location；optional field；to enable this parameter, web_search must also be enabled;；when enabled, the AI model will search the web from the country you specify;；Note: not supported in o3-mini, o1-pro, o1 models
- `[].web_search_city` — string，可选。city name of the location；optional field；Note: not supported in o3-mini, o1-pro, o1 models
- `[].system_message` — string，可选。instructions for the AI behaviour；optional field；defines the AI's role, tone, or specific behavior ；you can specify up to 500 characters in the system_message field
- `[].message_chain` — array<object>，可选。conversation history optional field array of message objects representing previous conversation turns; each object must contain: role string with either user or ai role; message string with message content (max 500 characters); you can specify maximum of 10 message objects in the array; Note: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai); example: "message_chain": [{"role":"user","message":"Hello, what’s up?"},{"role":"ai","message":"Hello! I’m doing well, thank you. How can I assist you today?"}]
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "system_message": "communicate as if we are in a business meeting",
    "message_chain": [
      {
        "role": "user",
        "message": "Hello, what’s up?"
      },
      {
        "role": "ai",
        "message": "Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?"
      }
    ],
    "max_output_tokens": "200",
    "temperature": "0.3",
    "top_p": "0.5",
    "model_name": "gpt-4.1-mini",
    "web_search": "true",
    "web_search_country_iso_code": "FR",
    "web_search_city": "Paris",
    "user_prompt": "provide information on how relevant the amusement park business is in France now"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/ai_optimization/chat_gpt/llm_responses/models

ID: `ChatGptLlmResponsesModels`
用途: You will receive the list of available Chat GPT AI models by calling this API. As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
中文补充: 本接口使用 **GET** 方法，路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/ai_optimization/chat_gpt/llm_responses/task_get/{id}

ID: `ChatGptLlmResponsesTaskGet`
用途: ‌ Chat GPT LLM Responses endpoint allows you to retrieve structured responses from a specific Chat GPT model, based on the input parameters.

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/chat_gpt/llm_responses/task_post

ID: `ChatGptLlmResponsesTaskPost`
用途: ‌ ChatGPT LLM Responses endpoint allows you to retrieve structured responses from a specific ChatGPT model, based on the input parameters.
中文补充: LLM Responses API 用于获取大语言模型针对指定问题、品牌、竞争对手、或主题生成的回答，帮助你开展 AI 搜索优化和对话式搜索分析。

请求体: `application/json`

请求字段:
- `[].user_prompt` — string，可选。prompt for the AI model；required field；the question or task you want to send to the AI model;；you can specify up to 500 characters in the user_prompt field
- `[].model_name` — string，可选。name of the AI model；required field；model_nameconsists of the actual model name and version name;；if the basic model name is specified, its latest version will be set by default;；for example, if gpt-4.1 is specified, the gpt-4.1-2025-04-14 will be set as model_name automatically;；you can receive the list of available LLM models by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/chat_gpt/llm_responses/models
- `[].max_output_tokens` — integer，可选。maximum number of tokens in the AI response；optional field；minimum value for reasoning models (e.g., reasoning is true in the Models endpoint): 1024;；minimum value for non-reasoning models: 16;；maximum value: 4096;；default value: 2048
- `[].temperature` — number，可选。randomness of the AI response；optional field；higher values make output more diverse; ；lower values make output more focused;；minimum value: 0；maximum value: 2；default value: 0.94；Note: not supported in reasoning models
- `[].top_p` — number，可选。diversity of the AI response；optional field ；controls diversity of the response by limiting token selection;；minimum value: 0；maximum value: 1 ；default value: 0.92Note: top_p cannot be used together with temperature in the same request
- `[].web_search` — boolean，可选。enable web search；optional field；when enabled, the AI model can access and cite current web information;；default value: false;；Note: refer to the Models endpoint for a list of models that support web_search;
- `[].force_web_search` — boolean，可选。force AI agent to use web search；optional field；to enable this parameter, web_search must also be enabled;；when enabled, the AI model is forced to access and cite current web information;；default value: false;；Note: even if the parameter is set to true, there is no guarantee web sources will be cited in the response ；Note #2: not supported in reasoning models
- `[].web_search_country_iso_code` — string，可选。ISO country code of the location；optional field；to enable this parameter, web_search must also be enabled;；when enabled, the AI model will search the web from the country you specify;；Note: not supported in o3-mini, o1-pro, o1 models
- `[].web_search_city` — string，可选。city name of the location；optional field；Note: not supported in o3-mini, o1-pro, o1 models
- `[].system_message` — string，可选。instructions for the AI behaviour；optional field；defines the AI's role, tone, or specific behavior;；you can specify up to 500 characters in the system_message field
- `[].message_chain` — array<object>，可选。conversation history optional field array of message objects representing previous conversation turns; each object must contain: role string with either user or ai role; message string with message content (max 500 characters); you can specify maximum of 10 message objects in the array; Note: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai); example: "message_chain": [{"role":"user","message":"Hello, what’s up?"},{"role":"ai","message":"Hello! I’m doing well, thank you. How can I assist you today?"}]
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special character in postback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special character in pingback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data array of the response

最小请求示例:

```json
[
  {
    "system_message": "communicate as if we are in a business meeting",
    "message_chain": [
      {
        "role": "user",
        "message": "Hello, what’s up?"
      },
      {
        "role": "ai",
        "message": "Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?"
      }
    ],
    "model_name": "gpt-4.1-mini",
    "user_prompt": "provide information on how relevant the amusement park business is in France now"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/ai_optimization/chat_gpt/llm_responses/tasks_ready

ID: `ChatGptLlmResponsesTasksReady`
用途: ‌ This endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/ai_optimization/chat_gpt/llm_scraper/languages

ID: `ChatGptLlmScraperLanguages`
用途: You will receive the list of languages by calling this API.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/chat_gpt/llm_scraper/live/advanced

ID: `ChatGptLlmScraperLiveAdvanced`
用途: ‌‌ Live ChatGPT LLM Scraper endpoint provides results from ChatGPT searches. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) parameters.
中文补充: 本接口通过实时方式获取 ChatGPT 搜索结果。返回取决于请求中指定的搜索位置和语言，可通过以下接口获取可用选项：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；you can specify up to 2000 characters in the keyword field；all %## will be decoded (plus character ‘+’ will be decoded to a space character)；if you need to use the “%” character for your keyword, please specify it as “%25”;；if you need to use the “+” character for your keyword, please specify it as “%2B”learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code；if you use this field, you don't need to specify location_code；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/chat_gpt/llm_scraper/locations；example:；United States
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/chat_gpt/llm_scraper/locations；example:；2840
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code;；if you use this field, you don't need to specify language_code;；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/chat_gpt/llm_scraper/languages
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name;；if you use this field, you don't need to specify language_name;；you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/chat_gpt/llm_scraper/languages
- `[].force_web_search` — boolean，可选。force AI agent to use web search；optional field；when enabled, the AI model is forced to access and cite current web information;；default value: false;；Note: even if the parameter is set to true, there is no guarantee web sources will be cited in the response
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/chat_gpt/llm_scraper/live/html

ID: `ChatGptLlmScraperLiveHtml`
用途: ‌ Live ChatGPT LLM Scraper API HTML provides a raw HTML page of the results for the specified keyword, language, and location.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；you can specify up to 2000 characters in the keyword field；all %## will be decoded (plus character ‘+’ will be decoded to a space character)；if you need to use the “%” character for your keyword, please specify it as “%25”;；if you need to use the “+” character for your keyword, please specify it as “%2B”learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code；if you use this field, you don't need to specify location_code；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/{{low_se_name}}/locations；example:；United States
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/{{low_se_name}}/{{low_se_type}}/locations；example:；2840
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/{{low_se_name}}/{{low_se_type}}/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/{{low_se_name}}/{{low_se_type}}/languages；example:enn
- `[].force_web_search` — boolean，可选。force AI agent to use web search；optional field；when enabled, the AI model is forced to access and cite current web information;；default value: false;；Note: even if the parameter is set to true, there is no guarantee web sources will be cited in the response
- `[].expand_citations` — boolean，可选。return expanded citation bar in HTML results；optional field；to enable this parameter, force_web_search must also be enabled;；when enabled, the endpoint will return HTML data from the expanded citation bar;；default value: false
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/ai_optimization/chat_gpt/llm_scraper/locations

ID: `ChatGptLlmScraperLocations`
用途: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/ai_optimization/chat_gpt/llm_scraper/locations/{country}

ID: `ChatGptLlmScraperLocationsCountry`
用途: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.

路径与查询参数:
- `country` — path，string，必填。country ISO code；optional field；specify the ISO code if you want to filter the list of locations by country；example:；us

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/ai_optimization/chat_gpt/llm_scraper/task_get/advanced/{id}

ID: `ChatGptLlmScraperTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；a universally unique identifier (UUID)；unique task identifier in our system；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/ai_optimization/chat_gpt/llm_scraper/task_get/html/{id}

ID: `ChatGptLlmScraperTaskGetHtml`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 7 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/chat_gpt/llm_scraper/task_post

ID: `ChatGptLlmScraperTaskPost`
用途: ‌‌ ChatGPT LLM Scraper API provides results from ChatGPT searches. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) parameters.

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；you can specify up to 2000 characters in the keyword field；all %## will be decoded (plus character ‘+’ will be decoded to a space character)；if you need to use the “%” character for your keyword, please specify it as “%25”;；if you need to use the “+” character for your keyword, please specify it as “%2B”learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code；if you use this field, you don't need to specify location_code；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/chat_gpt/llm_scraper/locations；example:；United States
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/chat_gpt/llm_scraper/locations；example:；2840
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code;；if you use this field, you don't need to specify language_code;；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/chat_gpt/llm_scraper/languages
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name;；if you use this field, you don't need to specify language_name;；you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/chat_gpt/llm_scraper/languagesn
- `[].force_web_search` — boolean，可选。force AI agent to use web search；optional field；when enabled, the AI model is forced to access and cite current web information;；default value: false;；Note: even if the parameter is set to true, there is no guarantee web sources will be cited in the response
- `[].expand_citations` — boolean，可选。return expanded citation bar in HTML results；optional field；to enable this parameter, force_web_search must also be enabled;；when enabled, the HTML endpoint will return data from the expanded citation bar;；default value: false
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatype；required field if you specify postback_url；corresponds to the function you used for setting a task；possible values:；advanced, html
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "what is chatgpt"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/ai_optimization/chat_gpt/llm_scraper/tasks_ready

ID: `ChatGptLlmScraperTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/claude/llm_responses/live

ID: `ClaudeLlmResponsesLive`
用途: ‌‌ Live Claude LLM Responses endpoint allows you to retrieve structured responses from a specific Claude model, based on the input parameters.
中文补充: 本接口使用 **POST** 方法调用：

请求体: `application/json`

请求字段:
- `[].user_prompt` — string，可选。prompt for the AI model；required field；the question or task you want to send to the AI model;；you can specify up to 500 characters in the user_prompt field
- `[].model_name` — string，可选。name of the AI model；required field；model_nameconsists of the actual model name and version name;；if the basic model name is specified, its latest version will be set by default;；for example, if claude-opus-4-0 is specified, the claude-opus-4-20250514 will be set as model_name automatically;；you can receive the list of available LLM models by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/claude/llm_responses/models
- `[].max_output_tokens` — integer，可选。maximum number of tokens in the AI response；optional field；minimum value: 1;；maximum value: 4096;；default value: 2048;；Note: if web_search is set to true or the reasoning model is specified in the request, the output token count may exceed the specified max_output_tokens limit；Note #2: if use_reasoning is set to true, the minimum value for max_output_tokens is 1025
- `[].temperature` — number，可选。randomness of the AI response；optional field；higher values make output more diverse; ；lower values make output more focused;；minimum value: 0；maximum value: 1；default value: 0.7Note: temperature cannot be used together with top_p in the same request
- `[].top_p` — number，可选。diversity of the AI response；optional field ；controls diversity of the response by limiting token selection;；minimum value: 0；maximum value: 1 ；default value: nullNote: top_p cannot be used together with temperature in the same request
- `[].web_search` — boolean，可选。enable web search for current information；optional field；when enabled, the AI model can access and cite current web information;；Note: refer to the Models endpoint for a list of models that support web_search; ；default value: false;；The cost of the parameter can be calculated on the Pricing page
- `[].force_web_search` — boolean，可选。force AI agent to use web search；optional field；to enable this parameter, web_search must also be enabled;；when enabled, the AI model is forced to access and cite current web information;；default value: false;；Note: even if the parameter is set to true, there is no guarantee web sources will be cited in the response
- `[].web_search_country_iso_code` — string，可选。ISO country code of the location used for searching the web；optional field；possible values: 'AR','AT','AU','BE','BR','CA','CH','CL','CN','DE','DK','ES','FI','FR','GB','HK','ID','IN','IT','JP','KR','MX','MY','NL','NO','NZ','PH','PL','PT','RU','SA','SE','TR','TW','US','ZA'
- `[].web_search_city` — string，可选。city name of the location used for searching the web；optional field
- `[].system_message` — string，可选。instructions for the AI behaviour；optional field；defines the AI's role, tone, or specific behavior;；you can specify up to 500 characters in the system_message field
- `[].message_chain` — array<object>，可选。conversation history optional field array of message objects representing previous conversation turns; each object must contain: role string with either user or ai role; message string with message content (max 500 characters); you can specify maximum of 10 message objects in the array; Note: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai); example: "message_chain": [{"role":"user","message":"Hello, what’s up?"},{"role":"ai","message":"Hello! I’m doing well, thank you. How can I assist you today?"}]
- `[].use_reasoning` — boolean，可选。enable reasoning for the AI model；optional field；when enabled, the model will perform reasoning before generating a response；refer to the Models endpoint for a list of models that support reasoning；default value: false；Note: if set to true, the minimum value for max_output_tokens is 1025；Note #2: if set to true, force_web_search must be set to false；Note #3: if set to true, the temperature and top_p cannot be used
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "system_message": "communicate as if we are in a business meeting",
    "message_chain": [
      {
        "role": "user",
        "message": "Hello, what’s up?"
      },
      {
        "role": "ai",
        "message": "Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?"
      }
    ],
    "max_output_tokens": "200",
    "model_name": "claude-opus-4-0",
    "temperature": "0.3",
    "web_search": "true",
    "web_search_country_iso_code": "FR",
    "user_prompt": "provide information on how relevant the amusement park business is in France now"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/ai_optimization/claude/llm_responses/models

ID: `ClaudeLlmResponsesModels`
用途: You will receive the list of available Claude AI models by calling this API. As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
中文补充: 本接口使用 **GET** 方法，通过以下路径获取当前可用的 Claude AI 模型列表：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/ai_optimization/claude/llm_responses/task_get/{id}

ID: `ClaudeLlmResponsesTaskGet`
用途: ‌ Claude LLM Responses endpoint allows you to retrieve structured responses from a specific Claude model, based on the input parameters.

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/claude/llm_responses/task_post

ID: `ClaudeLlmResponsesTaskPost`
用途: ‌ Claude LLM Responses endpoint allows you to retrieve structured responses from a specific Claude model, based on the input parameters.
中文补充: **请求方法：POST** **请求路径：`/v3/ai_optimization/claude/llm_responses/task_post`**

请求体: `application/json`

请求字段:
- `[].user_prompt` — string，可选。prompt for the AI model；required field；the question or task you want to send to the AI model;；you can specify up to 500 characters in the user_prompt field
- `[].model_name` — string，可选。name of the AI model；required field；model_nameconsists of the actual model name and version name;；if the basic model name is specified, its latest version will be set by default;；for example, if claude-opus-4-0 is specified, the claude-opus-4-20250514 will be set as model_name automatically;；you can receive the list of available LLM models by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/claude/llm_responses/models
- `[].max_output_tokens` — integer，可选。maximum number of tokens in the AI response；optional field；minimum value: 1;；maximum value: 4096;；default value: 2048;；Note: if web_search is set to true or the reasoning model is specified in the request, the output token count may exceed the specified max_output_tokens limit；Note #2: if use_reasoning is set to true, the minimum value for max_output_tokens is 1025
- `[].temperature` — number，可选。randomness of the AI response；optional field；higher values make output more diverse; ；lower values make output more focused;；minimum value: 0；maximum value: 1；default value: 0.7Note: temperature cannot be used together with top_p in the same request
- `[].top_p` — number，可选。diversity of the AI response；optional field ；controls diversity of the response by limiting token selection;；minimum value: 0；maximum value: 1 ；default value: nullNote: top_p cannot be used together with temperature in the same request
- `[].web_search` — boolean，可选。enable web search for current information；optional field；when enabled, the AI model can access and cite current web information;；Note: refer to the Models endpoint for a list of models that support web_search; ；default value: false;；The cost of the parameter can be calculated on the Pricing page
- `[].force_web_search` — boolean，可选。force AI agent to use web search；optional field；to enable this parameter, web_search must also be enabled;；when enabled, the AI model is forced to access and cite current web information;；default value: false;；Note: even if the parameter is set to true, there is no guarantee web sources will be cited in the response
- `[].web_search_country_iso_code` — string，可选。ISO country code of the location used for searching the web；optional field；possible values: 'AR','AT','AU','BE','BR','CA','CH','CL','CN','DE','DK','ES','FI','FR','GB','HK','ID','IN','IT','JP','KR','MX','MY','NL','NO','NZ','PH','PL','PT','RU','SA','SE','TR','TW','US','ZA'
- `[].web_search_city` — string，可选。city name of the location used for searching the web；optional field
- `[].system_message` — string，可选。instructions for the AI behaviour；optional field；defines the AI's role, tone, or specific behavior;；you can specify up to 500 characters in the system_message field
- `[].message_chain` — array<object>，可选。conversation history optional field array of message objects representing previous conversation turns; each object must contain: role string with either user or ai role; message string with message content (max 500 characters); you can specify maximum of 10 message objects in the array; Note: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai); example: "message_chain": [{"role":"user","message":"Hello, what’s up?"},{"role":"ai","message":"Hello! I’m doing well, thank you. How can I assist you today?"}]
- `[].use_reasoning` — boolean，可选。enable reasoning for the AI model；optional field；when enabled, the model will perform reasoning before generating a response；refer to the Models endpoint for a list of models that support reasoning；default value: false；Note: if set to true, the minimum value for max_output_tokens is 1025；Note #2: if set to true, force_web_search must be set to false；Note #3: if set to true, the temperature and top_p cannot be used
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special character in postback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special character in pingback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "system_message": "communicate as if we are in a business meeting",
    "message_chain": [
      {
        "role": "user",
        "message": "Hello, what’s up?"
      },
      {
        "role": "ai",
        "message": "Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?"
      }
    ],
    "max_output_tokens": "1024",
    "temperature": "0.3",
    "web_search_country_iso_code": "FR",
    "model_name": "claude-sonnet-4-0",
    "web_search": "true",
    "user_prompt": "provide information on how relevant the amusement park business is in France now"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/ai_optimization/claude/llm_responses/tasks_ready

ID: `ClaudeLlmResponsesTasksReady`
用途: ‌ This endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
中文补充: 本接口使用 **GET** 方法，路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/gemini/llm_responses/live

ID: `GeminiLlmResponsesLive`
用途: ‌‌ Live Gemini LLM Responses endpoint allows you to retrieve structured responses from a specific Gemini AI model, based on the input parameters.
中文补充: **方法：** `POST` **路径：** `https://api.seermartech.cn/v3/ai_optimization/gemini/llm_responses/live`

请求体: `application/json`

请求字段:
- `[].user_prompt` — string，可选。prompt for the AI model；required field；the question or task you want to send to the AI model;；you can specify up to 500 characters in the user_prompt field
- `[].model_name` — string，可选。name of the AI model；required field；model_nameconsists of the actual model name and version name;；if the basic model name is specified, its latest version will be set by default;；for example, if gemini-1.5-pro is specified, the gemini-1.5-pro-002 will be set as model_name automatically;；you can receive the list of available LLM models by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/gemini/llm_responses/models
- `[].max_output_tokens` — integer，可选。maximum number of tokens in the AI response；optional field；minimum value: 1；maximum value: 4096;；default value: 2048;；Note: if web_search is set to true or the reasoning model is specified in the request, the output token count may exceed the specified max_output_tokens limit；Note #2: if use_reasoning is set to true, the minimum value for max_output_tokens is 1024
- `[].temperature` — number，可选。randomness of the AI response；optional field；higher values make output more diverse ；lower values make output more focused；minimum value: 0；maximum value: 2；default value: 1.3
- `[].top_p` — number，可选。diversity of the AI response；optional field ；controls diversity of the response by limiting token selection；minimum value: 0；maximum value: 1 ；default value: 0.9
- `[].web_search` — boolean，可选。enable web search for current information；optional field；when enabled, the AI model can access and cite current web information;；Note: refer to the Models endpoint for a list of models that support web_search; ；default value: false;；The cost of the parameter can be calculated on the Pricing page
- `[].system_message` — string，可选。instructions for the AI behavior；optional field；defines the AI's role, tone, or specific behavior ；you can specify up to 500 characters in the system_message field
- `[].message_chain` — array<object>，可选。conversation history optional field array of message objects representing previous conversation turns; each object must contain: role string with either user or ai role; message string with message content (max 500 characters); you can specify maximum of 10 message objects in the array; Note: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai); example: "message_chain": [{"role":"user","message":"Hello, what’s up?"},{"role":"ai","message":"Hello! I’m doing well, thank you. How can I assist you today?"}]
- `[].use_reasoning` — boolean，可选。enable reasoning for the AI model；optional field；when enabled, the model will perform reasoning before generating a response；refer to the Models endpoint for a list of models that support reasoning；default value: false；Note: if set to true, the minimum value for max_output_tokens is 1024；Note #2: for Gemini Pro models, the use_reasoning will automatically be set to true
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "system_message": "communicate as if we are in a business meeting",
    "message_chain": [
      {
        "role": "user",
        "message": "Hello, what’s up?"
      },
      {
        "role": "ai",
        "message": "Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?"
      }
    ],
    "max_output_tokens": "200",
    "temperature": "0.3",
    "top_p": "0.5",
    "model_name": "gemini-2.5-flash",
    "web_search": "true",
    "user_prompt": "provide information on how relevant the amusement park business is in France now"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/ai_optimization/gemini/llm_responses/models

ID: `GeminiLlmResponsesModels`
用途: You will receive the list of available Gemini AI models by calling this API. As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/ai_optimization/gemini/llm_responses/task_get/{id}

ID: `GeminiLlmResponsesTaskGet`
用途: ‌ Gemini LLM Responses endpoint allows you to retrieve structured responses from a specific Gemini model, based on the input parameters.

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/gemini/llm_responses/task_post

ID: `GeminiLlmResponsesTaskPost`
用途: ‌ Gemini LLM Responses endpoint allows you to retrieve structured responses from a specific Gemini model, based on the input parameters.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].user_prompt` — string，可选。prompt for the AI model；required field；the question or task you want to send to the AI model;；you can specify up to 500 characters in the user_prompt field
- `[].model_name` — string，可选。name of the AI model；required field；model_nameconsists of the actual model name and version name;；if the basic model name is specified, its latest version will be set by default;；for example, if gemini-1.5-pro is specified, the gemini-1.5-pro-002 will be set as model_name automatically;；you can receive the list of available LLM models by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/gemini/llm_responses/models
- `[].max_output_tokens` — integer，可选。maximum number of tokens in the AI response；optional field；minimum value: 1;；maximum value: 4096;；default value: 2048;；Note: if web_search is set to true or the reasoning model is specified in the request, the output token count may exceed the specified max_output_tokens limit；Note #2: if use_reasoning is set to true, the minimum value for max_output_tokens is 1024
- `[].temperature` — number，可选。randomness of the AI response；optional field；higher values make output more diverse ；lower values make output more focused；minimum value: 0；maximum value: 2；default value: 1.3
- `[].top_p` — number，可选。diversity of the AI response；optional field ；controls diversity of the response by limiting token selection；minimum value: 0；maximum value: 1 ；default value: 0.9
- `[].web_search` — boolean，可选。enable web search for current information；optional field；when enabled, the AI model can access and cite current web information;；Note: refer to the Models endpoint for a list of models that support web_search; ；default value: false;；The cost of the parameter can be calculated on the Pricing page
- `[].system_message` — string，可选。instructions for the AI behavior；optional field；defines the AI's role, tone, or specific behavior ；you can specify up to 500 characters in the system_message field
- `[].message_chain` — array<object>，可选。conversation history optional field array of message objects representing previous conversation turns; each object must contain: role string with either user or ai role; message string with message content (max 500 characters); you can specify maximum of 10 message objects in the array; Note: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai); example: "message_chain": [{"role":"user","message":"Hello, what’s up?"},{"role":"ai","message":"Hello! I’m doing well, thank you. How can I assist you today?"}]
- `[].use_reasoning` — boolean，可选。enable reasoning for the AI model；optional field；when enabled, the model will perform reasoning before generating a response；refer to the Models endpoint for a list of models that support reasoning；default value: false；Note: if set to true, the minimum value for max_output_tokens is 1024；Note #2: for Gemini Pro models, the use_reasoning will automatically be set to true
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special character in postback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special character in pingback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "system_message": "communicate as if we are in a business meeting",
    "message_chain": [
      {
        "role": "user",
        "message": "Hello, what’s up?"
      },
      {
        "role": "ai",
        "message": "Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?"
      }
    ],
    "model_name": "gemini-2.5-flash",
    "user_prompt": "provide information on how relevant the amusement park business is in France now"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/ai_optimization/gemini/llm_responses/tasks_ready

ID: `GeminiLlmResponsesTasksReady`
用途: ‌ This endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
中文补充: 本接口使用 **GET** 方法，路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/ai_optimization/gemini/llm_scraper/languages

ID: `GeminiLlmScraperLanguages`
用途: You will receive the list of languages by calling this API.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/gemini/llm_scraper/live/advanced

ID: `GeminiLlmScraperLiveAdvanced`
用途: ‌‌ Live Gemini LLM Scraper endpoint provides structured results from Gemini. The results are specific to the selected location (see the List of Locations), language (see the List of Languages), and keyword.
中文补充: **POST `/v3/ai_optimization/gemini/llm_scraper/live/advanced`**

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；you can specify up to 2000 characters in the keyword field；all %## will be decoded (plus character ‘+’ will be decoded to a space character)；if you need to use the “%” character for your keyword, please specify it as “%25”;；if you need to use the “+” character for your keyword, please specify it as “%2B”learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/gemini/llm_scraper/locations；example:；United States
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/gemini/llm_scraper/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude,radius" formatthe maximum number of decimal digits for "latitude" and "longitude": 7the minimum value for "radius": 199 (mm)the maximum value for "radius": 199999 (mm)example:53.476225,-2.243572,200
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code;；if you use this field, you don't need to specify language_code;；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/gemini/llm_scraper/languages；example: English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name;；if you use this field, you don't need to specify language_name;；you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/gemini/llm_scraper/languages；example: enn
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/gemini/llm_scraper/live/html

ID: `GeminiLlmScraperLiveHtml`
用途: ‌ Live Gemini LLM Scraper API HTML provides a raw HTML page of the results for the specified keyword, language (see the List of Languages), and location (see the List of Locations).
中文补充: **POST** `https://api.seermartech.cn/v3/ai_optimization/gemini/llm_scraper/live/html`

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；you can specify up to 2000 characters in the keyword field；all %## will be decoded (plus character ‘+’ will be decoded to a space character)；if you need to use the “%” character for your keyword, please specify it as “%25”;；if you need to use the “+” character for your keyword, please specify it as “%2B”learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/gemini/llm_scraper/locations；example:；United States
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/gemini/llm_scraper/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude,radius" formatthe maximum number of decimal digits for "latitude" and "longitude": 7the minimum value for "radius": 199 (mm)the maximum value for "radius": 199999 (mm)example:53.476225,-2.243572,200
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/gemini/llm_scraper/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/gemini/llm_scraper/languages；example:enn
- `[].expand_citations` — boolean，可选。return expanded citation bar in HTML results；optional field；when enabled, the endpoint will return HTML data from the expanded citation bar;；default value: false
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/ai_optimization/gemini/llm_scraper/locations

ID: `GeminiLlmScraperLocations`
用途: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/ai_optimization/gemini/llm_scraper/task_get/advanced/{id}

ID: `GeminiLlmScraperTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；a universally unique identifier (UUID)；unique task identifier in our system；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/ai_optimization/gemini/llm_scraper/task_get/html/{id}

ID: `GeminiLlmScraperTaskGetHtml`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 7 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/gemini/llm_scraper/task_post

ID: `GeminiLlmScraperTaskPost`
用途: ‌‌ Gemini LLM Scraper API provides structured results from Gemini. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages), and keyword.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；you can specify up to 2000 characters in the keyword field；all %## will be decoded (plus character ‘+’ will be decoded to a space character)；if you need to use the “%” character for your keyword, please specify it as “%25”;；if you need to use the “+” character for your keyword, please specify it as “%2B”learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/gemini/llm_scraper/locations；example:；United States
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/gemini/llm_scraper/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude,radius" formatthe maximum number of decimal digits for "latitude" and "longitude": 7the minimum value for "radius": 199 (mm)the maximum value for "radius": 199999 (mm)example:53.476225,-2.243572,200
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code;；if you use this field, you don't need to specify language_code;；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/gemini/llm_scraper/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name;；if you use this field, you don't need to specify language_name;；you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/gemini/llm_scraper/languages；example:；en
- `[].expand_citations` — boolean，可选。return expanded citation bar in HTML results；optional field；when enabled, the HTML endpoint will return data from the expanded citation bar;；default value: false
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatype；required field if you specify postback_url；corresponds to the function you used for setting a task；possible values:；advanced, html
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/ai_optimization/gemini/llm_scraper/tasks_ready

ID: `GeminiLlmScraperTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/ai_optimization/llm_mentions/available_filters

ID: `LlmMentionsAvailableFilters`
用途: ‌‌ Here you will find all the necessary information about filters that can be used with AI Optimization LLM Mentions API endpoints.
中文补充: 本文介绍 AI 优化 LLM Mentions 接口可使用的过滤器。过滤器针对 `result` 数组中的对象设置，并且只能筛选对应结果对象中的字段。

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/llm_mentions/historical/live

ID: `LlmMentionsHistoricalLive`
用途: ‌‌ Live LLM Mentions Historical endpoint provides month-by-month historical metrics for mentions of the keywords or domains specified in the target array of the request. For each month, the response returns the total mentions count and ai_search_volume rate. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages).
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].target` — array<object>，可选。array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a domain entity
- `[].date_from` — string，可选。start date of the time range；optional field；minimal value 2025-08-01；date format "yyyy-mm-dd"
- `[].date_to` — string，可选。end date of the time range；optional field；Note value specified in date_from cannot exceed the value in date_to；date format "yyyy-mm-dd"
- `[].location_name` — string，可选。full name of search location；optional field；if you use this field, you don't need to specify location_code；if you don't specify this field, the location_code with 2840 value will be used by default;；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for United States only
- `[].location_code` — integer，可选。search location code；optional field；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: 2840；Note: chat_gpt data is available for 2840 only
- `[].language_name` — string，可选。full name of search language；optional field；if you use this field, you don't need to specify language_code;；if you don't specify this field, the language_code with en value will be used by default;；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for English only
- `[].language_code` — string，可选。search language code；optional field；if you use this field, you don't need to specify language_name;；you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: en；Note: chat_gpt data is available for en only
- `[].platform` — string，可选。target platform；optional field；possible values:；chat_gpt, google；Note: if the platform is not specified, the data is returned for both platforms；Note #2:chat_gpt data is available for the United States and English only
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "es",
    "location_code": "2840",
    "platform": "google",
    "target": [
      {
        "domain": "en.wikipedia.org",
        "search_filter": "exclude"
      },
      {
        "keyword": "bmw",
        "search_scope": [
          "answer"
        ]
      }
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/ai_optimization/llm_mentions/locations_and_languages

ID: `LlmMentionsLocationsAndLanguages`
用途: ‌ Using this endpoint you can get the full list of locations and languages supported in AI Optimization LLM Mentions API.
中文补充: 本接口使用 **POST** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/llm_mentions/multi_target_metrics/live

ID: `LlmMentionsMultiTargetMetricsLive`
用途: ‌‌ Live LLM Mentions Multi-Target Metrics endpoint provides aggregated metrics grouped by custom keys for mentions of the keywords or domains specified in the target array of the request. Each item in the results array corresponds to the specified target. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages).
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].targets` — array<object>，可选
- `[].location_name` — string，可选。full name of search location；optional field；if you use this field, you don't need to specify location_code；if you don't specify this field, the location_code with 2840 value will be used by default;；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for United States only
- `[].location_code` — integer，可选。search location code；optional field；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: 2840；Note: chat_gpt data is available for 2840 only
- `[].language_name` — string，可选。full name of search language；optional field；if you use this field, you don't need to specify language_code;；if you don't specify this field, the language_code with en value will be used by default;；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for English only
- `[].language_code` — string，可选。search language code；optional field；if you use this field, you don't need to specify language_name;；you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: en；Note: chat_gpt data is available for en only
- `[].platform` — string，可选。target platform；optional field；possible values:；chat_gpt, google；default value: google；Note: if the platform is not specified, the data is returned for both platforms；Note #2:chat_gpt data is available for the United States and English only
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；=, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["ai_search_volume","&gt;",1000]The full list of possible filters is available here.
- `[].initial_dataset_filters` — array<object>，可选。array of filter expressions applied before aggregation；optional field；you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；=, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["ai_search_volume","&gt;",1000]the full list of possible filters is available here.；learn more about the initial dataset filters in this help center article.
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["ai_search_volume,desc"]；Note: you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules
- `[].limit` — integer，可选。the maximum number of returned objects；optional fielddefault value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of the returned mentions data；optional fielddefault value: 0；example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;；Note: the maximum value is 1000000, use the search_after_token if you would like to offset more results
- `[].internal_list_limit` — integer，可选。maximum number of elements within internal arrays；optional field；you can use this field to limit the number of elements within the following arrays:；sources_domain；search_results_domain；minimum value: 1；maximum value: 10；default value: 5
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "platform": "google",
    "targets": [
      {
        "key": "chat_gpt",
        "target": [
          {
            "keyword": "chat gpt"
          }
        ]
      },
      {
        "key": "claude",
        "target": [
          {
            "keyword": "claude"
          }
        ]
      },
      {
        "key": "gemini",
        "target": [
          {
            "keyword": "gemini"
          }
        ]
      },
      {
        "key": "perplexity",
        "target": [
          {
            "keyword": "perplexity",
            "search_filter": "include"
          }
        ]
      }
    ],
    "initial_dataset_filters": [
      [
        "ai_search_volume",
        ">",
        "10"
      ]
    ],
    "internal_list_limit": "5"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/llm_mentions/search_mentions/live

ID: `LlmMentionsSearchMentionsLive`
用途: ‌‌ Live LLM Mentions Search endpoint provides mention data and related metrics from AI searches. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), as well as location and language parameters (see the List of Locations & Languages).
中文补充: 本接口用于实时获取 AI 搜索中的品牌、域名或提及数据，以及搜索结果和指标。结果会根据目标平台、搜索位置和语言返回：

请求体: `application/json`

请求字段:
- `[].target` — array<object>，可选。array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a domain entity
- `[].location_name` — string，可选。full name of search location；optional field；if you use this field, you don't need to specify location_code；if you don't specify this field, the location_code with 2840 value will be used by default;；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for United States only
- `[].location_code` — integer，可选。search location code；optional field；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: 2840；Note: chat_gpt data is available for 2840 only
- `[].language_name` — string，可选。full name of search language；optional field；if you use this field, you don't need to specify language_code;；if you don't specify this field, the language_code with en value will be used by default;；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for English only
- `[].language_code` — string，可选。search language code；optional field；if you use this field, you don't need to specify language_name;；you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: en；Note: chat_gpt data is available for en only
- `[].platform` — string，可选。target platform；optional field；possible values:；chat_gpt, google；Note: if the platform is not specified, the data is returned for both platforms；Note #2:chat_gpt data is available for the United States and English only
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；=, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["ai_search_volume","&gt;",1000]The full list of possible filters is available here.
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["ai_search_volume,desc"]；Note: you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules
- `[].offset` — integer，可选。offset in the results array of the returned mentions data；optional fielddefault value: 0；example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;；Note: the maximum value is 1000000, use the search_after_token if you would like to offset more results
- `[].search_after_token` — string，可选。token for subsequent requests；optional field；provided in the identical filed of the response to each request;；use this parameter to avoid timeouts while trying to obtain over 1000 results in a single request;；by specifying the unique search_after_token value from the response array, you will get the subsequent results of the initial task;；search_after_token values are unique for each subsequent task ;；Note: if the search_after_token is specified in the request, all other parameters should be identical to the previous request
- `[].limit` — integer，可选。the maximum number of returned objects；optional fielddefault value: 100；maximum value: 1000
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_name": "English",
    "location_code": "2840",
    "target": [
      {
        "domain": "dataforseo.com",
        "search_filter": "exclude"
      },
      {
        "keyword": "bmw",
        "search_scope": [
          "answer"
        ]
      }
    ],
    "platform": "google",
    "filters": [
      [
        "ai_search_volume",
        ">",
        "1000"
      ]
    ],
    "order_by": [
      "ai_search_volume,desc"
    ],
    "offset": "0",
    "limit": "3"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/llm_mentions/target_metrics/live

ID: `LlmMentionsTargetMetricsLive`
用途: ‌‌ Live LLM Mentions Target Metrics endpoint provides aggregated metrics for mentions of the keywords or domains specified in the target array of the request. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages).
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].target` — array<object>，可选。array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a domain entity
- `[].location_name` — string，可选。full name of search location；optional field；if you use this field, you don't need to specify location_code；if you don't specify this field, the location_code with 2840 value will be used by default;；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for United States only
- `[].location_code` — integer，可选。search location code；optional field；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: 2840；Note: chat_gpt data is available for 2840 only
- `[].language_name` — string，可选。full name of search language；optional field；if you use this field, you don't need to specify language_code;；if you don't specify this field, the language_code with en value will be used by default;；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for English only
- `[].language_code` — string，可选。search language code；optional field；if you use this field, you don't need to specify language_name;；you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: en；Note: chat_gpt data is available for en only
- `[].platform` — string，可选。target platform；optional field；possible values:；chat_gpt, google；Note: if the platform is not specified, the data is returned for both platforms；Note #2:chat_gpt data is available for the United States and English only
- `[].initial_dataset_filters` — array<object>，可选。array of filter expressions applied before aggregation；optional field；you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；=, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["ai_search_volume","&gt;",1000]the full list of possible filters is available here.；learn more about the initial dataset filters in this help center article.
- `[].internal_list_limit` — integer，可选。maximum number of elements within internal arrays；optional field；you can use this field to limit the number of elements within the following arrays:；sources_domain；search_results_domain；minimum value: 1；maximum value: 10；default value: 10
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "platform": "chat_gpt",
    "target": [
      {
        "domain": "en.wikipedia.org",
        "search_filter": "exclude"
      },
      {
        "keyword": "bmw",
        "search_scope": [
          "answer"
        ]
      }
    ],
    "initial_dataset_filters": [
      [
        "ai_search_volume",
        ">",
        "10"
      ]
    ],
    "internal_list_limit": "10"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/llm_mentions/target_metrics_lite/live

ID: `LlmMentionsTargetMetricsLiteLive`
用途: Live LLM Mentions Target Metrics Lite endpoint is the simplified version of the Target Metrics endpoint and provides a simplified view of aggregated LLM mentions for keywords and domains specified in the target array of the request. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages).
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].target` — array<object>，可选。array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a domain entity
- `[].location_name` — string，可选。full name of search location；optional field；if you use this field, you don't need to specify location_code；if you don't specify this field, the location_code with 2840 value will be used by default;；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for United States only
- `[].location_code` — integer，可选。search location code；optional field；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: 2840；Note: chat_gpt data is available for 2840 only
- `[].language_name` — string，可选。full name of search language；optional field；if you use this field, you don't need to specify language_code;；if you don't specify this field, the language_code with en value will be used by default;；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for English only
- `[].language_code` — string，可选。search language code；optional field；if you use this field, you don't need to specify language_name;；you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: en；Note: chat_gpt data is available for en only
- `[].platform` — string，可选。target platform；optional field；possible values:；chat_gpt, google；Note: if the platform is not specified, the data is returned for both platforms；Note #2:chat_gpt data is available for the United States and English only
- `[].initial_dataset_filters` — array<object>，可选。array of filter expressions applied before aggregation；optional field；you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；=, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["ai_search_volume","&gt;",1000]the full list of possible filters is available here.；learn more about the initial dataset filters in this help center article.
- `[].limit` — integer，可选。maximum number of results in the items array；optional field；you can use this parameter to limit the number of data objects you receive in the items array；minimum value: 1；maximum value: 1000；default value: 100
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["ai_search_volume,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules
- `[].offset` — integer，可选。offset in the results array of the returned mentions data；optional fielddefault value: 0；example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;；Note: the maximum value is 1000000
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "es",
    "location_code": "2840",
    "platform": "google",
    "target": [
      {
        "domain": "en.wikipedia.org",
        "search_filter": "exclude"
      },
      {
        "keyword": "bmw",
        "search_scope": [
          "answer"
        ]
      }
    ],
    "initial_dataset_filters": [
      [
        "ai_search_volume",
        ">",
        "10"
      ]
    ],
    "limit": "6"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/llm_mentions/timeseries_delta/live

ID: `LlmMentionsTimeseriesDeltaLive`
用途: ‌‌ The Live LLM Mentions Timeseries Delta endpoint provides the difference in historical mentions and AI search volume data between two specified dates. The results are specific to the specified target (keyword or domain), selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), as well as location and language parameters (see the List of Locations & Languages).
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].target` — array<object>，可选。array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a domain entity
- `[].date_from` — string，可选。start date of the time range；required field；minimal value: 2025-08-01；date format: "yyyy-mm-dd"
- `[].date_to` — string，可选。end date of the time range；required field；Note:the value specified in date_from cannot exceed the value in date_to；date format: "yyyy-mm-dd"
- `[].group_range` — string，可选。timeseries delta range；required field；possible values:；day, week, month, year
- `[].location_name` — string，可选。full name of search location；optional field；if you use this field, you don't need to specify location_code；if you don't specify this field, the location_code with 2840 value will be used by default;；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for United States only
- `[].location_code` — integer，可选。search location code；optional field；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: 2840；Note: chat_gpt data is available for 2840 only
- `[].language_name` — string，可选。full name of search language；optional field；if you use this field, you don't need to specify language_code;；if you don't specify this field, the language_code with en value will be used by default;；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for English only
- `[].language_code` — string，可选。search language code；optional field；if you use this field, you don't need to specify language_name;；you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: en；Note: chat_gpt data is available for en only
- `[].platform` — string，可选。target platform；optional field；possible values:；chat_gpt, google；default value: google；Note: if the platform is not specified, the data is returned for both platforms；Note #2:chat_gpt data is available for the United States and English only
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_name": "English",
    "location_code": "2840",
    "target": [
      {
        "domain": "dataforseo.com",
        "search_filter": "exclude"
      },
      {
        "keyword": "bmw",
        "search_scope": [
          "answer"
        ]
      }
    ],
    "platform": "google",
    "date_from": "2025-08-01",
    "date_to": "2025-12-01",
    "group_range": "month"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/llm_mentions/timeseries_new_lost/live

ID: `LlmMentionsTimeseriesNewLostLive`
用途: ‌‌ This endpoint will provide you with the number of new and lost LLM mentions, as well as ai_search_volume for the domain or keyword specified in the target field.
中文补充: **请求方法：** `POST` **接口路径：** `https://api.seermartech.cn/v3/ai_optimization/llm_mentions/timeseries_new_lost/live`

请求体: `application/json`

请求字段:
- `[].target` — array<object>，可选。array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a domain entity
- `[].date_from` — string，可选。start date of the time range；required field；minimal value: 2025-08-01；date format: "yyyy-mm-dd"
- `[].date_to` — string，可选。end date of the time range；required field；Note:the value specified in date_from cannot exceed the value in date_to；date format: "yyyy-mm-dd"
- `[].group_range` — string，可选。timeseries range；required field；possible values:；day, week, month, year
- `[].location_name` — string，可选。full name of search location；optional field；if you use this field, you don't need to specify location_code；if you don't specify this field, the location_code with 2840 value will be used by default;；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for United States only
- `[].location_code` — integer，可选。search location code；optional field；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: 2840；Note: chat_gpt data is available for 2840 only
- `[].language_name` — string，可选。full name of search language；optional field；if you use this field, you don't need to specify language_code;；if you don't specify this field, the language_code with en value will be used by default;；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for English only
- `[].language_code` — string，可选。search language code；optional field；if you use this field, you don't need to specify language_name;；you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: en；Note: chat_gpt data is available for en only
- `[].platform` — string，可选。target platform；optional field；possible values:；chat_gpt, google；default value: google；Note: if the platform is not specified, the data is returned for both platforms；Note #2:chat_gpt data is available for the United States and English only
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_name": "English",
    "location_code": "2840",
    "target": [
      {
        "domain": "dataforseo.com",
        "search_filter": "exclude"
      },
      {
        "keyword": "serp",
        "search_scope": [
          "answer"
        ]
      }
    ],
    "platform": "google",
    "date_from": "2025-08-01",
    "date_to": "2025-12-01",
    "group_range": "month"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/llm_mentions/top_mentioned_brand_categories/live

ID: `LlmMentionsTopMentionedBrandCategoriesLive`
用途: ‌‌ Live LLM Mentions Top Mentioned Brand Categories endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned brand categories for the specified target. The results are specific to the selected platform, location and language parameters (see the List of Locations & Languages).
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].target` — array<object>，可选。array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a domain entity
- `[].location_name` — string，可选。full name of search location；optional field；if you use this field, you don't need to specify location_code；if you don't specify this field, the location_code with 2840 value will be used by default;；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for United States only
- `[].location_code` — integer，可选。search location code；optional field；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: 2840；Note: chat_gpt data is available for 2840 only
- `[].language_name` — string，可选。full name of search language；optional field；if you use this field, you don't need to specify language_code;；if you don't specify this field, the language_code with en value will be used by default;；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for English only
- `[].language_code` — string，可选。search language code；optional field；if you use this field, you don't need to specify language_name;；you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: en；Note: chat_gpt data is available for en only
- `[].platform` — string，可选。target platform；optional field；possible values:；chat_gpt, google；Note: data specific to brand entities is available for chat_gpt only;；Note #2:chat_gpt data is available for the United States and English only
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；=, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["ai_search_volume","&gt;",1000]The full list of possible filters is available here.
- `[].initial_dataset_filters` — array<object>，可选。array of filter expressions applied before aggregation；optional field；you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；=, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["ai_search_volume","&gt;",1000]the full list of possible filters is available here.；learn more about the initial dataset filters in this help center article.
- `[].limit` — integer，可选。maximum number of results in the items array；optional field；you can use this parameter to limit the number of data objects you receive in the items array；minimum value: 1；maximum value: 1000；default value: 100
- `[].internal_list_limit` — integer，可选。maximum number of elements within internal arrays；optional field；you can use this field to limit the number of elements within the following arrays:；sources_domain, search_results_domain, brand_entities_title, brand_entities_category；minimum value: 1；maximum value: 10；default value: 5
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["ai_search_volume,desc"]；Note: you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules
- `[].offset` — integer，可选。offset in the results array of the returned mentions data；optional fielddefault value: 0；example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;；Note: the maximum value is 1000000
- `[].include_brand_categories` — array<string>，可选。array of brand_categories to include in the response；optional field；if specified, only the listed brand categories will be returned in the items array；example:；"include_brand_categories": ["business"]
- `[].exclude_brand_categories` — array<string>，可选。array of brand categories to exclude from the response；optional field；if specified, the listed brand categories will be omitted from the items array；example:；"exclude_brand_categories": ["business"]
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "platform": "chat_gpt",
    "target": [
      {
        "keyword": "bmw",
        "search_scope": [
          "answer"
        ]
      },
      {
        "keyword": "auto",
        "search_scope": [
          "question"
        ],
        "match_type": "partial_match"
      }
    ],
    "initial_dataset_filters": [
      [
        "ai_search_volume",
        ">",
        "10"
      ]
    ],
    "limit": "3",
    "internal_list_limit": "2"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/llm_mentions/top_mentioned_brand_categories_lite/live

ID: `LlmMentionsTopMentionedBrandCategoriesLiteLive`
用途: ‌‌ Live LLM Mentions Top Mentioned Brand Categories Lite endpoint is the simplified version of the Top Mentioned Brand Categories endpoint and provides a simplified view of aggregated LLM mentions metrics grouped by the most frequently mentioned brand categories for the specified target. The results are specific to the selected platform, location and language parameters (see the List of Locations & Languages).
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].target` — array<object>，可选。array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a domain entity
- `[].location_name` — string，可选。full name of search location；optional field；if you use this field, you don't need to specify location_code；if you don't specify this field, the location_code with 2840 value will be used by default;；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for United States only
- `[].location_code` — integer，可选。search location code；optional field；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: 2840；Note: chat_gpt data is available for 2840 only
- `[].language_name` — string，可选。full name of search language；optional field；if you use this field, you don't need to specify language_code;；if you don't specify this field, the language_code with en value will be used by default;；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for English only
- `[].language_code` — string，可选。search language code；optional field；if you use this field, you don't need to specify language_name;；you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: en；Note: chat_gpt data is available for en only
- `[].platform` — string，可选。target platform；optional field；possible values:；chat_gpt, google；default value: google；Note: data specific to brand entities is available for chat_gpt only;；Note #2:chat_gpt data is available for the United States and English only
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；=, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["ai_search_volume","&gt;",1000]The full list of possible filters is available here.
- `[].initial_dataset_filters` — array<object>，可选。array of filter expressions applied before aggregation；optional field；you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；=, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["ai_search_volume","&gt;",1000]the full list of possible filters is available here.；learn more about the initial dataset filters in this help center article.
- `[].limit` — integer，可选。maximum number of results in the items array；optional field；you can use this parameter to limit the number of data objects you receive in the items array；minimum value: 1；maximum value: 1000；default value: 100
- `[].internal_list_limit` — integer，可选。maximum number of elements within internal arrays；optional field；you can use this field to limit the number of elements within the following arrays:；sources_domain, search_results_domain, brand_entities_title, brand_entities_category；minimum value: 1；maximum value: 10；default value: 5
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["ai_search_volume,desc"]；Note: you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules
- `[].offset` — integer，可选。offset in the results array of the returned mentions data；optional fielddefault value: 0；example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;；Note: the maximum value is 1000000
- `[].include_brand_categories` — array<string>，可选。array of brand categories to include in the response；optional field；if specified, only the listed brand categories will be returned in the items array；example:；["company","insurance"]
- `[].exclude_brand_categories` — array<string>，可选。array of brand categories to exclude from the response；optional field；if specified, the listed brand categories will be omitted from the items array；example:；["company","insurance"]
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "platform": "chat_gpt",
    "target": [
      {
        "keyword": "bmw",
        "search_scope": [
          "answer"
        ]
      },
      {
        "keyword": "auto",
        "search_scope": [
          "question"
        ],
        "match_type": "partial_match"
      }
    ],
    "initial_dataset_filters": [
      [
        "ai_search_volume",
        ">",
        "10"
      ]
    ],
    "limit": "3",
    "internal_list_limit": "2"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/llm_mentions/top_mentioned_brands/live

ID: `LlmMentionsTopMentionedBrandsLive`
用途: ‌‌ Live LLM Mentions Top Mentioned Brands endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned brands for the specified target. The results are specific to the selected platform, location and language parameters (see the List of Locations & Languages).
中文补充: 本接口通过大语言模型（LLM）提及数据，按指定目标的品牌提及频次聚合并返回品牌排行。结果受平台、地区和语言参数影响。

请求体: `application/json`

请求字段:
- `[].target` — array<object>，可选。array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a domain entity
- `[].location_name` — string，可选。full name of search location；optional field；if you use this field, you don't need to specify location_code；if you don't specify this field, the location_code with 2840 value will be used by default;；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for United States only
- `[].location_code` — integer，可选。search location code；optional field；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: 2840；Note: chat_gpt data is available for 2840 only
- `[].language_name` — string，可选。full name of search language；optional field；if you use this field, you don't need to specify language_code;；if you don't specify this field, the language_code with en value will be used by default;；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for English only
- `[].language_code` — string，可选。search language code；optional field；if you use this field, you don't need to specify language_name;；you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: en；Note: chat_gpt data is available for en only
- `[].platform` — string，可选。target platform；optional field；possible values:；chat_gpt, google；Note: data specific to brand entities is available for chat_gpt only;；Note #2:chat_gpt data is available for the United States and English only
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；=, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["ai_search_volume","&gt;",1000]The full list of possible filters is available here.
- `[].initial_dataset_filters` — array<object>，可选。array of filter expressions applied before aggregation；optional field；you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；=, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["ai_search_volume","&gt;",1000]the full list of possible filters is available here.；learn more about the initial dataset filters in this help center article.
- `[].limit` — integer，可选。maximum number of results in the items array；optional field；you can use this parameter to limit the number of data objects you receive in the items array；minimum value: 1；maximum value: 1000；default value: 100
- `[].internal_list_limit` — integer，可选。maximum number of elements within internal arrays；optional field；you can use this field to limit the number of elements within the following arrays:；sources_domain, search_results_domain, brand_entities_title, brand_entities_category；minimum value: 1；maximum value: 10；default value: 5
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["ai_search_volume,desc"]；Note: you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules
- `[].offset` — integer，可选。offset in the results array of the returned mentions data；optional fielddefault value: 0；example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;；Note: the maximum value is 1000000
- `[].include_brands` — array<string>，可选。array of brands to include in the response；optional field；if specified, only the listed brands will be returned in the items array；example:；"include_brands": ["Audi"]
- `[].exclude_brands` — array<string>，可选。array of brands to exclude from the response；optional field；if specified, the listed brands will be omitted from the items array；example:；"exclude_brands": ["Audi"]
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "platform": "chat_gpt",
    "target": [
      {
        "keyword": "bmw",
        "search_scope": [
          "answer"
        ]
      },
      {
        "keyword": "auto",
        "search_scope": [
          "question"
        ],
        "match_type": "partial_match"
      }
    ],
    "initial_dataset_filters": [
      [
        "ai_search_volume",
        ">",
        "10"
      ]
    ],
    "limit": "3",
    "internal_list_limit": "2"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/llm_mentions/top_mentioned_brands_lite/live

ID: `LlmMentionsTopMentionedBrandsLiteLive`
用途: ‌‌ Live LLM Mentions Top Mentioned Brands Lite endpoint is the simplified version of the Top Mentioned Brands endpoint and provides a simplified view of aggregated LLM mentions metrics grouped by the most frequently mentioned brands for the specified target. The results are specific to the selected platform, location and language parameters (see the List of Locations & Languages).
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].target` — array<object>，可选。array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a domain entity
- `[].location_name` — string，可选。full name of search location；optional field；if you use this field, you don't need to specify location_code；if you don't specify this field, the location_code with 2840 value will be used by default;；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for United States only
- `[].location_code` — integer，可选。search location code；optional field；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: 2840；Note: chat_gpt data is available for 2840 only
- `[].language_name` — string，可选。full name of search language；optional field；if you use this field, you don't need to specify language_code;；if you don't specify this field, the language_code with en value will be used by default;；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for English only
- `[].language_code` — string，可选。search language code；optional field；if you use this field, you don't need to specify language_name;；you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: en；Note: chat_gpt data is available for en only
- `[].platform` — string，可选。target platform；optional field；possible values:；chat_gpt, google；default value: google；Note: data specific to brand entities is available for chat_gpt only;；Note #2:chat_gpt data is available for the United States and English only
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；=, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["ai_search_volume","&gt;", 1000]The full list of possible filters is available here.
- `[].initial_dataset_filters` — array<object>，可选。array of filter expressions applied before aggregation；optional field；you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；=, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["ai_search_volume","&gt;",1000]the full list of possible filters is available here.；learn more about the initial dataset filters in this help center article.
- `[].limit` — integer，可选。maximum number of results in the items array；optional field；you can use this parameter to limit the number of data objects you receive in the items array；minimum value: 1；maximum value: 1000；default value: 100
- `[].internal_list_limit` — integer，可选。maximum number of elements within internal arrays；optional field；you can use this field to limit the number of elements within the following arrays:；sources_domain, search_results_domain, brand_entities_title, brand_entities_category；minimum value: 1；maximum value: 10；default value: 5
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["ai_search_volume,desc"]；Note: you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules
- `[].offset` — integer，可选。offset in the results array of the returned mentions data；optional fielddefault value: 0；example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;；Note: the maximum value is 1000000
- `[].include_brands` — array<string>，可选。array of brands to include in the response；optional field；if specified, only the listed brands will be returned in the items array；example:；["BMW","Audi"]
- `[].exclude_brands` — array<string>，可选。array of brands to exclude from the response；optional field；if specified, the listed brands will be omitted from the items array；example:；["BMW","Audi"]
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "platform": "chat_gpt",
    "target": [
      {
        "keyword": "bmw",
        "search_scope": [
          "answer"
        ]
      },
      {
        "keyword": "auto",
        "search_scope": [
          "question"
        ],
        "match_type": "partial_match"
      }
    ],
    "initial_dataset_filters": [
      [
        "ai_search_volume",
        ">",
        "10"
      ]
    ],
    "limit": "3",
    "internal_list_limit": "2"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/llm_mentions/top_mentioned_domains/live

ID: `LlmMentionsTopMentionedDomainsLive`
用途: ‌‌ Live LLM Mentions Top Mentioned Domains endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned domains for the specified target. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages).
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].target` — array<object>，可选。array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a domain entity
- `[].location_name` — string，可选。full name of search location；optional field；if you use this field, you don't need to specify location_code；if you don't specify this field, the location_code with 2840 value will be used by default;；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for United States only
- `[].location_code` — integer，可选。search location code；optional field；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: 2840；Note: chat_gpt data is available for 2840 only
- `[].language_name` — string，可选。full name of search language；optional field；if you use this field, you don't need to specify language_code;；if you don't specify this field, the language_code with en value will be used by default;；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for English only
- `[].language_code` — string，可选。search language code；optional field；if you use this field, you don't need to specify language_name;；you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: en；Note: chat_gpt data is available for en only
- `[].platform` — string，可选。target platform；optional field；possible values:；chat_gpt, google；Note: if the platform is not specified, the data is returned for both platforms；Note #2:chat_gpt data is available for the United States and English only
- `[].links_scope` — string，可选。links source scope；optional field；this parameter specifies which links will be used to extract domains and aggregation data；possible values: sources, search_results；default value: sources；Note:if you specify search_results, the data will be available for chat_gpt only
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；=, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["ai_search_volume","&gt;",1000]The full list of possible filters is available here.
- `[].initial_dataset_filters` — array<object>，可选。array of filter expressions applied before aggregation；optional field；you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；=, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["ai_search_volume","&gt;",1000]the full list of possible filters is available here.；learn more about the initial dataset filters in this help center article.
- `[].limit` — integer，可选。maximum number of results in the items array；optional field；you can use this parameter to limit the number of data objects you receive in the items array；minimum value: 1；maximum value: 1000；default value: 100
- `[].internal_list_limit` — integer，可选。maximum number of elements within internal arrays；optional field；you can use this field to limit the number of elements within the following arrays:；sources_domain, search_results_domain, brand_entities_title, brand_entities_category；minimum value: 1；maximum value: 10；default value: 5
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["ai_search_volume,desc"]；Note: you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules
- `[].offset` — integer，可选。offset in the results array of the returned mentions data；optional fielddefault value: 0；example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;；Note: the maximum value is 1000000
- `[].include_domains` — array<string>，可选。array of domains to include in the response；optional field；if specified, only the listed domains will be returned in the items array；example:；"include_domains": ["en.wikipedia.org"]
- `[].exclude_domains` — array<string>，可选。array of domains to exclude from the response；optional field；if specified, the listed domains will be omitted from the items array；example:；"exclude_domains": ["en.wikipedia.org"]
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "platform": "chat_gpt",
    "target": [
      {
        "keyword": "bmw",
        "search_scope": [
          "answer"
        ]
      },
      {
        "keyword": "auto",
        "search_scope": [
          "question"
        ],
        "match_type": "partial_match"
      }
    ],
    "links_scope": "sources",
    "initial_dataset_filters": [
      [
        "ai_search_volume",
        ">",
        "10"
      ]
    ],
    "limit": "3",
    "internal_list_limit": "2"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/llm_mentions/top_mentioned_domains_lite/live

ID: `LlmMentionsTopMentionedDomainsLiteLive`
用途: ‌‌ Live LLM Mentions Top Mentioned Domains Lite endpoint is the simplified version of the Top Mentioned Domains endpoint and provides a simplified view of aggregated LLM mentions metrics grouped by the most frequently mentioned domains for the specified target. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages).
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].target` — array<object>，可选。array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a domain entity
- `[].location_name` — string，可选。full name of search location；optional field；if you use this field, you don't need to specify location_code；if you don't specify this field, the location_code with 2840 value will be used by default;；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for United States only
- `[].location_code` — integer，可选。search location code；optional field；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: 2840；Note: chat_gpt data is available for 2840 only
- `[].language_name` — string，可选。full name of search language；optional field；if you use this field, you don't need to specify language_code;；if you don't specify this field, the language_code with en value will be used by default;；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for English only
- `[].language_code` — string，可选。search language code；optional field；if you use this field, you don't need to specify language_name;；you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: en；Note: chat_gpt data is available for en onlyn
- `[].platform` — string，可选。target platform；optional field；possible values:；chat_gpt, google；default value: google；Note: if the platform is not specified, the data is returned for both platforms；Note #2:chat_gpt data is available for the United States and English only
- `[].links_scope` — string，可选。links source scope；optional field；this parameter specifies which links will be used to extract domains and aggregation data；possible values: sources, search_results；default value: sources;；Note: if you specify search_results, the data will be available for chat_gpt only
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；=, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["ai_search_volume","&gt;",1000]The full list of possible filters is available here.
- `[].initial_dataset_filters` — array<object>，可选。array of filter expressions applied before aggregation；optional field；you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；=, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["ai_search_volume","&gt;",1000]the full list of possible filters is available here.；learn more about the initial dataset filters in this help center article.
- `[].limit` — integer，可选。maximum number of results in the items array；optional field；you can use this parameter to limit the number of data objects you receive in the items array；minimum value: 1；maximum value: 1000；default value: 100
- `[].internal_list_limit` — integer，可选。maximum number of elements within internal arrays；optional field；you can use this field to limit the number of elements within the following arrays:；sources_domain, search_results_domain, brand_entities_title, brand_entities_category；minimum value: 1；maximum value: 10；default value: 5
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["ai_search_volume,desc"]；Note: you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules
- `[].offset` — integer，可选。offset in the results array of the returned mentions data；optional fielddefault value: 0；example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;；Note: the maximum value is 1000000
- `[].include_domains` — array<string>，可选。array of domains to include in the response；optional field；if specified, only the listed domains will be returned in the items array；example:；["dataforseo.com","seoinsider.com"]
- `[].exclude_domains` — array<string>，可选。array of domains to exclude from the response；optional field；if specified, the listed domains will be omitted from the items array；example:；["google.com","bing.com"]
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "platform": "chat_gpt",
    "target": [
      {
        "keyword": "bmw",
        "search_scope": [
          "answer"
        ]
      },
      {
        "keyword": "auto",
        "search_scope": [
          "question"
        ],
        "match_type": "partial_match"
      }
    ],
    "links_scope": "sources",
    "initial_dataset_filters": [
      [
        "ai_search_volume",
        ">",
        "10"
      ]
    ],
    "limit": "3",
    "internal_list_limit": "2"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/llm_mentions/top_mentioned_pages/live

ID: `LlmMentionsTopMentionedPagesLive`
用途: ‌‌ Live LLM Mentions Top Mentioned Pages endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned pages for the specified target. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages).
中文补充: 本接口通过大语言模型（LLM）提及数据，按指定 `target` 统计被提及次数最高的页面，并返回页面级及多维度聚合指标。数据结果受平台、地区和语言参数影响。

请求体: `application/json`

请求字段:
- `[].target` — array<object>，可选。array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a domain entity
- `[].location_name` — string，可选。full name of search location；optional field；if you use this field, you don't need to specify location_code；if you don't specify this field, the location_code with 2840 value will be used by default;；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for United States only
- `[].location_code` — integer，可选。search location code；optional field；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: 2840；Note: chat_gpt data is available for 2840 only
- `[].language_name` — string，可选。full name of search language；optional field；if you use this field, you don't need to specify language_code;；if you don't specify this field, the language_code with en value will be used by default;；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for English only
- `[].language_code` — string，可选。search language code；optional field；if you use this field, you don't need to specify language_name;；you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: en；Note: chat_gpt data is available for en only
- `[].platform` — string，可选。target platform；optional field；possible values:；chat_gpt, google；Note: if the platform is not specified, the data is returned for both platforms；Note #2:chat_gpt data is available for the United States and English only
- `[].links_scope` — string，可选。links source scope；optional field；this parameter specifies which links will be used to extract domains and aggregation data；possible values: sources, search_results；default value: sources;；Note:if you specify search_results, the data will be available for chat_gpt only
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；=, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["ai_search_volume","&gt;",1000]The full list of possible filters is available here.
- `[].initial_dataset_filters` — array<object>，可选。array of filter expressions applied before aggregation；optional field；you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；=, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["ai_search_volume","&gt;",1000]the full list of possible filters is available here.；learn more about the initial dataset filters in this help center article.
- `[].limit` — integer，可选。maximum number of results in the items array；optional field；you can use this parameter to limit the number of data objects you receive in the items array；minimum value: 1；maximum value: 1000；default value: 100
- `[].internal_list_limit` — integer，可选。maximum number of elements within internal arrays；optional field；you can use this field to limit the number of elements within the following arrays:；sources_domain, search_results_domain, brand_entities_title, brand_entities_category；minimum value: 1；maximum value: 10；default value: 5
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["ai_search_volume,desc"]；Note: you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules
- `[].offset` — integer，可选。offset in the results array of the returned mentions data；optional fielddefault value: 0；example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;；Note: the maximum value is 1000000
- `[].include_pages` — array<string>，可选。array of pages to include in the response；optional field；if specified, only the listed pages will be returned in the items array；example:；"include_pages": ["https://example.page/"]
- `[].exclude_pages` — array<string>，可选。array of pages to exclude from the response；optional field；if specified, the listed pages will be omitted from the items array；example:；"exclude_pages": ["https://example.page/"]
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "platform": "chat_gpt",
    "target": [
      {
        "keyword": "bmw",
        "search_scope": [
          "answer"
        ]
      },
      {
        "keyword": "auto",
        "search_scope": [
          "question"
        ],
        "match_type": "partial_match"
      }
    ],
    "links_scope": "sources",
    "initial_dataset_filters": [
      [
        "ai_search_volume",
        ">",
        "10"
      ]
    ],
    "limit": "3",
    "internal_list_limit": "2"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/llm_mentions/top_mentioned_pages_lite/live

ID: `LlmMentionsTopMentionedPagesLiteLive`
用途: ‌‌ Live LLM Mentions Top Mentioned Pages Lite endpoint is a simplified version of the Top Mentioned Pages that provides a simplified view of aggregated LLM mentions metrics grouped by the most frequently mentioned pages for the specified target. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages).
中文补充: 本接口通过 `POST /v3/ai_optimization/llm_mentions/top_mentioned_pages_lite/live` 实时查询指定目标在大语言模型回答中被提及次数最高的页面，并按页面聚合返回 LLM 提及指标。

请求体: `application/json`

请求字段:
- `[].target` — array<object>，可选。array of objects containing target entities required field you can specify up to 10 entities (objects) in the target field one target entity can contain either one domain or one keyword and related parameters examples: target array with a domain entity
- `[].location_name` — string，可选。full name of search location；optional field；if you use this field, you don't need to specify location_code；if you don't specify this field, the location_code with 2840 value will be used by default;；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for United States only
- `[].location_code` — integer，可选。search location code；optional field；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engine with their location_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: 2840；Note: chat_gpt data is available for 2840 only
- `[].language_name` — string，可选。full name of search language；optional field；if you use this field, you don't need to specify language_code;；if you don't specify this field, the language_code with en value will be used by default;；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；Note: chat_gpt data is available for English only
- `[].language_code` — string，可选。search language code；optional field；if you use this field, you don't need to specify language_name;；you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.seermartech.cn/v3/ai_optimization/llm_mentions/locations_and_languages；default value: en；Note: chat_gpt data is available for en only
- `[].platform` — string，可选。target platform；optional field；possible values:；chat_gpt, google；default value: google；Note: if the platform is not specified, the data is returned for both platforms；Note #2:chat_gpt data is available for the United States and English only
- `[].links_scope` — string，可选。links source scope；optional field；this parameter specifies which links will be used to extract domains and aggregation data；possible values: sources, search_results；default value: sources; ;；Note: if you specify search_results, the data will be available for chat_gpt only
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；=, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["ai_search_volume","&gt;",1000]The full list of possible filters is available here.
- `[].initial_dataset_filters` — array<object>，可选。array of filter expressions applied before aggregation；optional field；you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；=, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["ai_search_volume","&gt;",1000]the full list of possible filters is available here.；learn more about the initial dataset filters in this help center article.
- `[].limit` — integer，可选。maximum number of results in the items array；optional field；you can use this parameter to limit the number of data objects you receive in the items array；minimum value: 1；maximum value: 1000；default value: 100
- `[].internal_list_limit` — integer，可选。maximum number of elements within internal arrays；optional field；you can use this field to limit the number of elements within the following arrays:；sources_domain, search_results_domain, brand_entities_title, brand_entities_category；minimum value: 1；maximum value: 10；default value: 5
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["ai_search_volume,desc"]；Note: you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules
- `[].offset` — integer，可选。offset in the results array of the returned mentions data；optional fielddefault value: 0；example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be provided for the successive objects;；Note: the maximum value is 1000000
- `[].include_pages` — array<string>，可选。array of page URLs to include in the response；optional field；if specified, only the listed pages will be returned in the items array；example:；`["https://dataforseo.com/apis/ai-optimization-api/llm-mentions-api", "https://dataforseo.com/apis/ai-optimization-api"]`
- `[].exclude_pages` — array<string>，可选。array of page URLs to exclude from the response；optional field；if specified, the listed pages will be omitted from the items array；example:；`["https://dataforseo.com/apis/ai-optimization-api/llm-mentions-api", "https://dataforseo.com/apis/ai-optimization-api"]`
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "platform": "chat_gpt",
    "target": [
      {
        "keyword": "bmw",
        "search_scope": [
          "answer"
        ]
      },
      {
        "keyword": "auto",
        "search_scope": [
          "question"
        ],
        "match_type": "partial_match"
      }
    ],
    "links_scope": "sources",
    "initial_dataset_filters": [
      [
        "ai_search_volume",
        ">",
        "10"
      ]
    ],
    "limit": "3",
    "internal_list_limit": "2"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/ai_optimization/perplexity/llm_responses/live

ID: `PerplexityLlmResponsesLive`
用途: ‌‌ Live Perplexity LLM Responses endpoint allows you to retrieve structured responses from a specific Perplexity AI model, based on the input parameters.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].user_prompt` — string，可选。prompt for the AI model；required field；the question or task you want to send to the AI model;；you can specify up to 500 characters in the user_prompt field
- `[].model_name` — string，可选。name of the AI model；required field；model_nameconsists of the actual model name and version name;；if the basic model name is specified, its latest version will be set by default;；you can receive the list of available LLM models by making a separate request to the following endpoint: https://api.seermartech.cn/v3/ai_optimization/perplexity/llm_responses/models
- `[].max_output_tokens` — integer，可选。maximum number of tokens in the AI response；optional field；minimum value: 1；maximum value: 4096;；default value: 2048;；Note: if the reasoning model is specified in the request, the output token count may exceed the specified max_output_tokens limit
- `[].temperature` — number，可选。randomness of the AI response；optional field；higher values make output more diverse ；lower values make output more focused；minimum value: 0；maximum value: 1.9；default value: 0.77
- `[].top_p` — number，可选。diversity of the AI response；optional field ；controls diversity of the response by limiting token selection；minimum value: 0；maximum value: 1 ；default value: 0.9
- `[].web_search_country_iso_code` — string，可选。country code for web search localization；optional field；specify the country ISO code to get localized web search results；Note: available only for Perplexity Sonar models；example: US
- `[].system_message` — string，可选。instructions for the AI behavior；optional field；defines the AI's role, tone, or specific behavior ；you can specify up to 500 characters in the system_message field
- `[].message_chain` — array<object>，可选。conversation history optional field array of message objects representing previous conversation turns; each object must contain: role string with either user or ai role; message string with message content (max 500 characters); you can specify maximum of 10 message objects in the array; Note: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai); example: "message_chain": [{"role":"user","message":"Hello, what’s up?"},{"role":"ai","message":"Hello! I’m doing well, thank you. How can I assist you today?"}]
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "system_message": "communicate as if we are in a business meeting",
    "message_chain": [
      {
        "role": "user",
        "message": "Hello, what’s up?"
      },
      {
        "role": "ai",
        "message": "Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?"
      }
    ],
    "max_output_tokens": "200",
    "temperature": "0.3",
    "top_p": "0.5",
    "web_search_country_iso_code": "FR",
    "model_name": "sonar",
    "user_prompt": "provide information on how relevant the amusement park business is in France now"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/ai_optimization/perplexity/llm_responses/models

ID: `PerplexityLlmResponsesModels`
用途: You will receive the list of available Perplexity AI models by calling this API. As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
中文补充: 本接口使用 **GET** 方法，路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/apple/app_info/task_get/advanced/{id}

ID: `AppleAppInfoTaskGetAdvanced`
用途: This endpoint will provide you with information about the mobile application specified in a POST request. You will receive its ID, icon, description, reviews count, rating, images, and other data. The results are specific to the app_id parameter specified in the POST request.

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/app_data/apple/app_info/task_post

ID: `AppleAppInfoTaskPost`
用途: ‌‌ This endpoint will provide you with information about the App Store application specified in the app_id field of the POST request.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].app_id` — string，可选。id of the app；required field；ID of the mobile application on App Store;；you can find the ID in the URL of every app listed on App Store;；example:；in the URL `https://apps.apple.com/us/app/id835599320`；the id is `835599320`
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code；if you use this field, you don't need to specify location_code；you can receive the list of available locations of the search engine with their location_name by making a separate request to `https://api.seermartech.cn/v3/app_data/apple/locations`；example:；West Los Angeles,California,United States
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engine with their location_code by making a separate request to `https://api.seermartech.cn/v3/app_data/apple/locations`；example:；9061121
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages with language_name by making a separate request to `https://api.seermartech.cn/v3/app_data/apple/languages`；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code_by making a separate request to `https://api.seermartech.cn/v3/app_data/apple/languages`；example:；en
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priority You will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；`http://your-server.com/postbackscript?id=$id`；`http://your-server.com/postbackscript?id=$id&amp;tag=$tag`；Note: special characters in postback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatype；required field if you specify postback_url；corresponds to the datatype that will be sent to your server；possible values:；advanced
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；`http://your-server.com/pingscript?id=$id`；`http://your-server.com/pingscript?id=$id&amp;tag=$tag`；Note: special characters in pingback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "app_id": "835599320",
    "location_code": "2840",
    "language_code": "en"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/apple/app_info/tasks_ready

ID: `AppleAppInfoTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/apple/app_list/task_get/advanced/{id}

ID: `AppleAppListTaskGetAdvanced`
用途: This endpoint will provide you with a list of applications published in the top app charts on the App Store platform, including app IDs, ratings, prices, titles, and more. The results are specific to the app_collection as well as the location and language parameters specified in the POST request.
中文补充: 本接口使用 **GET** 方法，通过任务 ID 获取 Apple App Store 榜单中的应用列表结果。

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/app_data/apple/app_list/task_post

ID: `AppleAppListTaskPost`
用途: ‌‌ This endpoint will provide you with a list of mobile applications published in the top app charts on the App Store platform. The returned results are specific to the app collection as well as the language and location parameters.
中文补充: **POST** `https://api.seermartech.cn/v3/app_data/apple/app_list/task_post`

请求体: `application/json`

请求字段:
- `[].app_collection` — string，可选。app collection；required field；app collection on App Store from which apps will be collected;；you can specify the following values:；top_free_ios, top_paid_ios, top_grossing_ios, new_ios, new_free_ios, new_paid_ios
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code；if you use this field, you don't need to specify location_code；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/app_data/apple/locations；example:；West Los Angeles,California,United States
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.seermartech.cn/v3/app_data/apple/locations；example:；9061121
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages with language_name by making a separate request to https://api.seermartech.cn/v3/app_data/apple/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code_by making a separate request to https://api.seermartech.cn/v3/app_data/apple/languages；example:；enn
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].depth` — integer，可选。parsing depth；optional field；number of apps to be returned from the App Store SERP;；we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;；default value: 100；maximum value: 1000；Your account will be billed per each SERP containing up to 100 results; ；Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;；The cost can be calculated on the Pricing page.
- `[].app_category` — string，可选。application category on the App Store；optional field；you can filter the results by app category;；example:；lifestyle;；you can review the full list of available categories here or by making a separate request to https://api.seermartech.cn/v3/app_data/apple/categories
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatype；required field if you specify postback_url；corresponds to the datatype that will be sent to your server；possible values:；advanced
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "app_collection": "top_free_ios",
    "location_code": "2840",
    "language_code": "en",
    "depth": "200",
    "app_category": "games"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/apple/app_list/tasks_ready

ID: `AppleAppListTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/apple/app_listings/categories

ID: `AppleAppListingsCategories`
用途: This endpoint will provide you with a full list of app categories available on Apple App Store.
中文补充: 本接口使用 **GET** 方法，通过以下路径获取 Apple App Store 中可用于应用数据分析的完整分类列表：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/app_data/apple/app_listings/search/live

ID: `AppleAppListingsSearchLive`
用途: This endpoint will provide you with a list of apps published on App Store along with additional information: its ID, icon, reviews count, rating, price, and other data. The results are specific to the title, description, and categories parameters specified in the API request.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].categories` — array<string>，可选。app categories；optional field；the categories you specify are used to search for app listings;；you can get the full list of available app listing categories by this link；you can specify up to 10 categories
- `[].description` — string，可选。keyword in the app's description；optional field；keywords that occur in the description of the app;；can contain up to 200 characters
- `[].title` — string，可选。keyword in the app's title；optional field；keywords that occur in the title of the app;；can contain up to 200 characters
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, like, not_like；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["rating.value",">",3]you can receive the list of available filters_by making a separate request to https://api.seermartech.cn/v3/app_data/apple/app_listings/available_filtersn
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting parameter；example:；["item.rating.value,desc"]note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["item.rating.value,desc","item.rating.value,desc"]
- `[].limit` — integer，可选。the maximum number of returned apps；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned apps；optional field；default value: 0；if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities；Note: we recommend using this parameter only when retrieving up to 10,000 results；for retrieving over 10,000 results, use the offset_token instead.
- `[].offset_token` — string，可选。token for subsequent requests；optional field；provided in the identical filed of the response to each request;；use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;；by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;；offset_token values are unique for each subsequent task ；Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request；learn more about this parameter on our Help Center
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "title": "vpn",
    "description": "vpn",
    "categories": [
      "Utilities"
    ],
    "order_by": [
      "item.rating.value,desc"
    ],
    "filters": [
      [
        "item.rating.value",
        ">",
        "4.5"
      ]
    ],
    "limit": "10"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/apple/app_reviews/task_get/advanced/{id}

ID: `AppleAppReviewsTaskGetAdvanced`
用途: This endpoint will provide you with feedback data on applications listed on the App Store platform, including review ratings, review content, user profile info of each reviewer, review publication dates, and more. The results are specific to the app_id as well as the location and language parameters specified in the POST request.

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/app_data/apple/app_reviews/task_post

ID: `AppleAppReviewsTaskPost`
用途: ‌‌ This endpoint will provide you with reviews published on the App Store platform for the app specified in the app_id field. The returned results are specific to the indicated language and location parameters.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].app_id` — string，可选。id of the app；required field；ID of the mobile application on App Store;；you can find the ID in the URL of every app listed on App Store;；example:；in the URL https://apps.apple.com/us/app/id835599320；the id is 835599320
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code；if you use this field, you don't need to specify location_code；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/app_data/apple/locations；example:；West Los Angeles,California,United States
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.seermartech.cn/v3/app_data/apple/locations；example:；9061121
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages with language_name by making a separate request to https://api.seermartech.cn/v3/app_data/apple/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code_by making a separate request to https://api.seermartech.cn/v3/app_data/apple/languages；example:；enn
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].depth` — integer，可选。parsing depth；optional field；number of reviews to be returned in the API response;；we strongly recommend setting the parsing depth in the multiples of 25, because our system processes 25 reviews in a row;；default value: 25;；maximum value: 500;Your account will be billed per each SERP containing up to 25 results; ；Setting depth above 25 may result in additional charges if the search engine returns more than 25 results;；The cost can be calculated on the Pricing page.
- `[].sort_by` — string，可选。results sorting parameters；optional field；you can use this field to sort the results;；possible types of sorting:；most_recent — sort by the most recent reviews;；most_helpful — sort by the most relevant reviews;；default rule: most_helpful
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatype；required field if you specify postback_url；corresponds to the datatype that will be sent to your server；possible values:；advanced
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "app_id": "835599320",
    "location_code": "2840",
    "language_code": "en",
    "depth": "200"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/apple/app_reviews/tasks_ready

ID: `AppleAppReviewsTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/apple/app_searches/task_get/advanced/{id}

ID: `AppleAppSearchesTaskGetAdvanced`
用途: This endpoint will provide you with a list of apps ranking on the App Store for the keyword specified in a POST request. You will also receive additional information about each application: its ID, icon, reviews count, rating, price, and other data. The results are specific to the keyword as well as location and language parameters specified in the POST request.
中文补充: 本接口使用 **GET** 方法，通过任务 ID 获取 Apple App Store 中指定的应用搜索排名结果。

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/app_data/apple/app_searches/task_post

ID: `AppleAppSearchesTaskPost`
用途: ‌‌ This endpoint will provide you with a list of apps ranking on the App Store for the specified keyword. The returned results are specific to the indicated keyword, as well as the location and language parameters.
中文补充: 本接口使用 **POST** 方法，通过 `/v3/app_data/apple/app_searches/task_post` 创建 Apple App Store 搜索任务。接口将返回指定、地区和语言下的 App Store 排名应用列表任务信息。

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；you can specify up to 700 characters in the keyword field;；all %## will be decoded (plus character ‘+’ will be decoded to a space character);；if you need to use the “%” character for your keyword, please specify it as “%25”;；if you need to use the “+” character for your keyword, please specify it as “%2B”learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code；if you use this field, you don't need to specify location_code；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/app_data/apple/locations；example:；West Los Angeles,California,United States
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.seermartech.cn/v3/app_data/apple/locations；example:；9061121
- `[].language_name` — string，可选。full name of search engine language；required field if language_code is not specified；if you use this field, you don't need to specify language_code；you can receive the list of available languages with language_name by making a separate request to https://api.seermartech.cn/v3/app_data/apple/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if language_name is not specified；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code_by making a separate request to https://api.seermartech.cn/v3/app_data/apple/languages；example:；enn
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].depth` — integer，可选。parsing depth；optional field；number of results to be returned from the App Store SERP;；we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;；default value: 100；maximum value: 700；Your account will be billed per each SERP containing up to 100 results; ；Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;；The cost can be calculated on the Pricing page.
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatype；required field if you specify postback_url；corresponds to the datatype that will be sent to your server；possible values:；advanced
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "keyword": "vpn",
    "location_code": "2840",
    "language_code": "en",
    "depth": "200"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/apple/app_searches/tasks_ready

ID: `AppleAppSearchesTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/apple/categories

ID: `AppleCategories`
用途: This endpoint will provide you with a full list of app categories available on App Store.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/apple/languages

ID: `AppleLanguages`
用途: By calling this endpoint you will receive the list of Apple languages supported in App Data API.
中文补充: 本接口用于获取 App Data API 支持的 Apple 语言列表。

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/apple/locations

ID: `AppleLocations`
用途: By calling this endpoint you will receive the list of Apple locations supported in App Data API. for more info please visit 'https://docs.dataforseo.com/v3/app_data/apple/locations/?bash'
中文补充: 本接口使用 **GET** 方法获取 Apple App Data API 支持的地点列表。

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/app_data/errors

ID: `AppDataErrors`
用途: By calling this endpoint you will receive information about the App Data API tasks that returned an error within the past 7 days.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].limit` — integer，可选。the maximum number of returned tasks that responded with an error；optional field；default value: 1000；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned tasks；optional field；default value: 0；if you specify the 10 value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks
- `[].filtered_function` — string，可选。return tasks with a certain function；use this field to obtain a list of tasks that returned an error filtered by a certain function；you can filter the results by the values you receive in the function fields of the API response；i.e., once you receive unfiltered results, you can call this API again to filter them by function ；example: app_data/task_get/advanced, postback_url, pingback_url
- `[].datetime_from` — string，可选。start time for filtering results；optional field；allows filtering results by the datetime parameter within the range of the last 7 days;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2021-11-15 12:57:46 +00:00
- `[].datetime_to` — string，可选。finish time for filtering results；optional field；allows filtering results by the datetime parameter within the range of the last 7 days;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2021-11-15 13:57:46 +00:00

最小请求示例:

```json
[
  {
    "limit": "10"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/google/app_info/task_get/advanced/{id}

ID: `GoogleAppInfoTaskGetAdvanced`
用途: This endpoint will provide you with information about the mobile application specified in a POST request. You will receive its ID, icon, description, reviews count, rating, number of installs, images, and other data. The results are specific to the app_id parameter specified in the POST request.
中文补充: **GET `/v3/app_data/google/app_info/task_get/advanced/$id`**

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/google/app_info/task_get/html/{id}

ID: `GoogleAppInfoTaskGetHtml`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 7 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/app_data/google/app_info/task_post

ID: `GoogleAppInfoTaskPost`
用途: ‌‌ This endpoint will provide you with information about the Google Play application specified in the app_id field of the POST request.
中文补充: 本接口使用 **POST `/v3/app_data/google/app_info/task_post`**，用于创建 Google Play 应用信息查询任务。提交 Google Play 应用的 `app_id` 后，本平台将返回对应任务 ID，任务完成后可通过任务结果接口查询应用信息。

请求体: `application/json`

请求字段:
- `[].app_id` — string，可选。id of the app；required field；ID of the mobile application on Google Play;；you can find the ID in the URL of every app listed on Google Play;；example:；in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger；the id is org.telegram.messenger
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code；if you use this field, you don't need to specify location_code；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/app_data/google/locations；example:；West Los Angeles,California,United States
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.seermartech.cn/v3/app_data/google/locations；example:；9061121
- `[].language_name` — string，可选。full name of search engine language；required field if language_code is not specified；if you use this field, you don't need to specify language_code；you can receive the list of available languages with language_name by making a separate request to https://api.seermartech.cn/v3/app_data/google/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if language_name is not specified；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code_by making a separate request to https://api.seermartech.cn/v3/app_data/google/languages；example:；en
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded; ；i.a., the # character will be encoded into %23
- `[].postback_data` — string，可选。postback_url datatype；required field if you specify postback_url；corresponds to the datatype that will be sent to your server；possible values:；advanced, html
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded; ；i.a., the # character will be encoded into %23

最小请求示例:

```json
[
  {
    "app_id": "org.telegram.messenger",
    "location_code": "2840",
    "language_code": "en"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/google/app_info/tasks_ready

ID: `GoogleAppInfoTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/google/app_list/task_get/advanced/{id}

ID: `GoogleAppListTaskGetAdvanced`
用途: This endpoint will provide you with a list of applications published in the top charts on the Google Play platform, including app IDs, ratings, prices, titles, and more. The results are specific to the app_collection as well as the location and language parameters specified in the POST request.

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/google/app_list/task_get/html/{id}

ID: `GoogleAppListTaskGetHtml`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 7 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/app_data/google/app_list/task_post

ID: `GoogleAppListTaskPost`
用途: ‌‌ This endpoint will provide you with a list of mobile applications published in the top charts on the Google Play platform. The returned results are specific to the app collection as well as the the language and location parameters.
中文补充: 本接口使用 **POST** 方法，路径为 **`/v3/app_data/google/app_list/task_post`**。用于创建 Google Play 应用列表采集任务，获取各类热门榜单中的移动应用。返回结果受应用榜单类型、语言和地区参数影响。

请求体: `application/json`

请求字段:
- `[].app_collection` — string，可选。app collection；required field；app collection on Google Play from which apps will be collected;；you can specify the following values:；featured, topselling_paid, topselling_free, topselling_new_free, topselling_new_paid, topgrossing, movers_shakers；Note: if featured is selected, the app_category parameter cannot be used
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code；if you use this field, you don't need to specify location_code；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/app_data/google/locations；example:；West Los Angeles,California,United States
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.seermartech.cn/v3/app_data/google/locations；example:；9061121
- `[].language_name` — string，可选。full name of search engine language；required field if language_code is not specified；if you use this field, you don't need to specify language_code；you can receive the list of available languages with language_name by making a separate request to https://api.seermartech.cn/v3/app_data/google/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if language_name is not specified；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code_by making a separate request to https://api.seermartech.cn/v3/app_data/google/languages；example:；en
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].depth` — integer，可选。parsing depth；optional field；number of apps to be returned in the API response;；we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row;；default value: 100;；maximum value: 200;；Your account will be billed per each SERP containing up to 100 results; ；Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;；The cost can be calculated on the Pricing page.
- `[].app_category` — string，可选。application category on Google Play；optional field；you can filter the results by app category;；example:；family;；you can receive the full list of available categories by making a separate request to https://api.seermartech.cn/v3/app_data/google/categories；Note: app_category cannot be used if app_collection parameter is set to featured
- `[].age_rating` — string，可选。filter results by age rating；optional field；you can use this field to filter the results by age rating;；possible types of filtering:；ages_up_to_5 — return apps approved for children up to 5 years old;；ages_6_8 — return apps approved for children from 6 to 8 years old;；ages_9_12 — return apps approved for children from 9 to 12 years old;；by default, the API returns apps for all ages;；Note: this filter works only in conjunction with the "category": "family" parameter
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded; ；i.a., the # character will be encoded into %23
- `[].postback_data` — string，可选。postback_url datatype；required field if you specify postback_url；corresponds to the datatype that will be sent to your server；possible values:；advanced, html
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded; ；i.a., the # character will be encoded into %23

最小请求示例:

```json
[
  {
    "app_collection": "topselling_free",
    "location_code": "2840",
    "language_code": "en",
    "depth": "100"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/google/app_list/tasks_ready

ID: `GoogleAppListTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/google/app_listings/categories

ID: `GoogleAppListingsCategories`
用途: This endpoint will provide you with a full list of app categories available on Google Play.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/app_data/google/app_listings/search/live

ID: `GoogleAppListingsSearchLive`
用途: This endpoint will provide you with a list of apps published on Google Play along with additional information: its ID, icon, reviews count, rating, price, and other data. The results are specific to the title, description, and categories parameters specified in the API request.
中文补充: 本接口使用 **POST `/v3/app_data/google/app_listings/search/live`**，用于实时搜索 Google Play 已发布的应用，并返回应用 ID、图标、描述、评论数、评分、价格、开发信息及应用等数据。

请求体: `application/json`

请求字段:
- `[].categories` — array<string>，可选。app categories；optional field；the categories you specify are used to search for app listings;；you can get the full list of available app listing categories by this link；you can specify up to 10 categories
- `[].description` — string，可选。keyword in the app's description；optional field；keywords that occur in the description of the app;；can contain up to 200 characters
- `[].title` — string，可选。keyword in the app's title；optional field；keywords that occur in the title of the app;；can contain up to 200 characters
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, like, not_like；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["item.rating.value",">",3]you can receive the list of available filters_by making a separate request to https://api.seermartech.cn/v3/app_data/google/app_listings/available_filters
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting parameter；example:；["item.installs_count,asc"]note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["item.rating.value,desc","item.installs_count,asc"]
- `[].limit` — integer，可选。the maximum number of returned apps；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned apps；optional field；default value: 0；if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities；Note: we recommend using this parameter only when retrieving up to 10,000 results；for retrieving over 10,000 results, use the offset_token instead.
- `[].offset_token` — string，可选。token for subsequent requests；optional field；provided in the identical filed of the response to each request;；use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;；by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;；offset_token values are unique for each subsequent task ；Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request；learn more about this parameter on our Help Center
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "title": "vpn",
    "description": "vpn",
    "categories": [
      "Tools"
    ],
    "order_by": [
      "item.installs_count,asc"
    ],
    "filters": [
      [
        "item.rating.value",
        ">",
        "4.5"
      ]
    ],
    "limit": "10"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/google/app_reviews/task_get/advanced/{id}

ID: `GoogleAppReviewsTaskGetAdvanced`
用途: This endpoint will provide you with feedback data on applications listed on the Google Play platform, including review ratings, review content, user profile info of each reviewer, review publication dates, and more. The results are specific to the app_id as well as the location and language parameters specified in the POST request.

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/google/app_reviews/task_get/html/{id}

ID: `GoogleAppReviewsTaskGetHtml`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 7 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/app_data/google/app_reviews/task_post

ID: `GoogleAppReviewsTaskPost`
用途: ‌‌ This endpoint will provide you with reviews published on the Google Play platform for the app specified in the app_id field. The returned results are specific to the indicated language and location parameters.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].app_id` — string，可选。id of the app；required field；ID of the mobile application on Google Play;；you can find the ID in the URL of every app listed on Google Play;；example:；https://play.google.com/store/apps/details?id=org.telegram.messenger
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code；if you use this field, you don't need to specify location_code；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/app_data/google/locations；example:；West Los Angeles,California,United States
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.seermartech.cn/v3/app_data/google/locations；example:；9061121
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages with language_name by making a separate request to https://api.seermartech.cn/v3/app_data/google/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code by making a separate request to https://api.seermartech.cn/v3/app_data/google/languages；example:；en
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].depth` — integer，可选。parsing depth；optional field；number of reviews to be returned in the API response;；we strongly recommend setting the parsing depth in the multiples of 150, because our system processes 150 reviews in a row;；default value: 150;；maximum value: 100000;；Your account will be billed per each SERP containing up to 150 results; ；Setting depth above 150 may result in additional charges if the search engine returns more than 150 results;；The cost can be calculated on the Pricing page.
- `[].rating` — integer，可选。filter reviews by rating；optional field；you can use this field to filter the results;；possible types of filtering:；5 — return reviews with five-star rating only;；4 — return reviews with four-star rating only;；3 — return reviews with three-star rating only;；2 — return reviews with two-star rating only;；1 — return reviews with one-star rating only;；by default, the API returns all reviews regardless of the number of stars
- `[].sort_by` — string，可选。results sorting parameters；optional field；you can use this field to sort the results;；possible types of sorting:；newest — sort by the most recent reviews;；most_relevant — sort by the most relevant reviews;；default rule: most_relevant
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded; ；i.a., the # character will be encoded into %23
- `[].postback_data` — string，可选。postback_url datatype；required field if you specify postback_url；corresponds to the datatype that will be sent to your server；possible values:；advanced, html
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded; ；i.a., the # character will be encoded into %23

最小请求示例:

```json
[
  {
    "app_id": "org.telegram.messenger",
    "location_code": "2840",
    "language_code": "en",
    "depth": "150"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/google/app_reviews/tasks_ready

ID: `GoogleAppReviewsTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/google/app_searches/task_get/advanced/{id}

ID: `GoogleAppSearchesTaskGetAdvanced`
用途: This endpoint will provide you with a list of apps ranking on Google Play for the keyword specified in a POST request. You will also receive additional information about each application: its ID, icon, reviews count, rating, price, and other data. The results are specific to the keyword as well as location and language parameters specified in the POST request.

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/google/app_searches/task_get/html/{id}

ID: `GoogleAppSearchesTaskGetHtml`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 7 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/app_data/google/app_searches/task_post

ID: `GoogleAppSearchesTaskPost`
用途: ‌‌ This endpoint will provide you with a list of apps ranking on Google Play for the specified keyword. The returned results are specific to the indicated keyword, as well as the language and location parameters.
中文补充: 本接口用于获取 Google Play 平台上架移动应用的数据。本文涵盖以下 API 路径：`/v3/app_data/google/app_searches/task_get/advanced`、`/v3/app_data/google/app_list/task_get/advanced`、`/v3/app_data/google/app_info/task_get/advanced`、`/v3/app_data/google/app_reviews/task_get/advanced` 和 `/v3/app_data/google/app_listings/search/live/`。

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；you can specify up to 700 characters in the keyword field;；all %## will be decoded (plus character ‘+’ will be decoded to a space character);；if you need to use the “%” character for your keyword, please specify it as “%25”;；if you need to use the “+” character for your keyword, please specify it as “%2B”learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code；if you use this field, you don't need to specify location_code；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/app_data/google/locations；example:；West Los Angeles,California,United States
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.seermartech.cn/v3/app_data/google/locations；example:；9061121
- `[].language_name` — string，可选。full name of search engine language；optional field；if you use this field, you don't need to specify language_code；you can receive the list of available languages with language_name by making a separate request to https://api.seermartech.cn/v3/app_data/google/languages；example:；English
- `[].language_code` — string，可选。search engine language code；optional field；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code by making a separate request to https://api.seermartech.cn/v3/app_data/google/languages；example:；en
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].depth` — integer，可选。parsing depth；optional field；number of results to be returned to be returned from the Google Play SERP;；we strongly recommend setting the parsing depth in the multiples of 30, because our system processes 30 results in a row;；default value: 30;；maximum value: 200;；Your account will be billed per each SERP containing up to 30 results; ；Setting depth above 30 may result in additional charges if the search engine returns more than 30 results;；The cost can be calculated on the Pricing page.
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded; ；i.a., the # character will be encoded into %23
- `[].postback_data` — string，可选。postback_url datatype；required field if you specify postback_url；corresponds to the datatype that will be sent to your server；possible values:；advanced, html
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded; ；i.a., the # character will be encoded into %23

最小请求示例:

```json
[
  {
    "keyword": "vpn",
    "location_code": "2840",
    "language_code": "en",
    "depth": "30"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/google/app_searches/tasks_ready

ID: `GoogleAppSearchesTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/google/categories

ID: `GoogleCategories`
用途: This endpoint will provide you with a full list of app categories available on Google Play.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/google/languages

ID: `AppDataGoogleLanguages`
用途: By calling this endpoint you will receive the list of Google languages supported in App Data API.
中文补充: 通过 `GET /v3/app_data/google/languages` 获取应用数据 API 支持的 Google 语言列表。本接口无需请求体，返回 JSON 格式的语言信息。

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/google/locations

ID: `AppDataGoogleLocations`
用途: By calling this endpoint you will receive the list of Google locations supported in App Data API.
中文补充: 本接口用于获取 Google 应用数据 API 支持的地区列表。支持按国家筛选地区，并返回地区名称、上级地区、国家 ISO 代码及地区类型等信息。

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/google/locations/{country}

ID: `AppDataGoogleLocationsCountry`
用途: By calling this endpoint you will receive the list of Google locations supported in App Data API.

路径与查询参数:
- `country` — path，string，必填。country ISO code optional field specify the ISO code if you want to filter the list of locations by country example: us

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/app_data/id_list

ID: `AppDataIdList`
用途: This endpoint is designed to provide you with a list of IDs and metadata for all App Data tasks created within the specified time period, including both successful and uncompleted tasks.
中文补充: 本接口使用 **POST** 方法，路径为 **`/v3/app_data/id_list`**，用于按指定时间范围查询本平台已创建的 App Data 任务 ID 及数据，结果已完成和未完成的任务。

请求体: `application/json`

请求字段:
- `[].datetime_from` — string，可选。start time for filtering results；required field；if include_metadata is set to true, maximum value: a month from current datetime;；if include_metadata is set to false, maximum value: six months from current datetime;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2023-01-15 12:57:46 +00:00
- `[].datetime_to` — string，可选。finish time for filtering results；required field；maximum value: current datetime;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2023-01-31 13:57:46 +00:00
- `[].limit` — integer，可选。the maximum number of returned task IDs；optional field；default value: 1000；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned task IDs；optional field；default value: 0；if you specify the 10 value, the first ten tasks in the results array will be omitted
- `[].sort` — string，可选。sorting by task execution time；optional field；possible values: "asc", "desc"；default value: "asc"
- `[].include_metadata` — boolean，可选。include task metadata in the respond；optional field；default value: false

最小请求示例:

```json
[
  {
    "datetime_from": "2026-08-01 17:42:44",
    "datetime_to": "2026-08-11 17:42:44",
    "limit": "10",
    "include_metadata": "true"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/app_data/tasks_ready

ID: `AppDataTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/appendix/errors

ID: `Errors`
用途: This endpoint returns a list of possible DataForSEO API errors and general status codes. Below you will find a list of HTTP response codes and internal messages. We recommend storing the data connected to error codes in your application log and designing a necessary system for handling related exceptional or error conditions.
中文补充: 本接口使用 **POST** 方法，路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/appendix/status

ID: `AppendixStatus`
用途: By calling this API you will receive detailed information about the current status of all our APIs and endpoints. You will also get a full issue description if a problem occurs.
中文补充: 本接口使用 **GET** 方法，通过路径 **`/v3/appendix/status`** 查询本平台 API 及端点的当前运行状态，并在发生异常时返回详细的问题说明。

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/appendix/user_data

ID: `UserData`
用途: You will receive detailed information about your API usage, prices, spending and other account details by calling this API.
中文补充: Business Data API 用于获取企业实体可用的数据企业评价、企业信息及商业列表数据。

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/appendix/webhook_resend

ID: `WebhookResend`
用途: Using this endpoint you can resend webhooks (pingbacks and postbacks) for up to 100 specified tasks. Note: Your account will not be double-charged for resending a webhook.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].id` — string，可选。task identifier；unique task identifier in our system in the UUID format；you can specify up to 100 identifiers;；each identifier in the task array must be specified as a separate object

最小请求示例:

```json
[
  {
    "id": "08161139-0001-0066-1000-06491d097ed5"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；the value of this array is always null;；you can get the results by the preferred method of results delivery (pingback or postback) you specified when setting a task

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/backlinks/anchors/live

ID: `AnchorsLive`
用途: ‌‌ This endpoint will provide you with a detailed overview of anchors used when linking to the specified website with relevant backlink data for each of them.
中文补充: **POST `/v3/backlinks/anchors/live`**

请求体: `application/json`

请求字段:
- `[].target` — string，可选。domain, subdomain or webpage to get anchors for；required field；a domain or a subdomain should be specified without https:// and www.；a page should be specified with absolute URL (including http:// or https://)
- `[].limit` — integer，可选。the maximum number of returned anchors；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned anchors；optional field；default value: 0；if you specify the 10 value, the first ten anchors in the results array will be omitted and the data will be provided for the successive anchors
- `[].internal_list_limit` — integer，可选。maximum number of elements within internal arrays；optional field；you can use this field to limit the number of elements within the following arrays:；referring_links_tld；referring_links_types；referring_links_attributes；referring_links_platform_types；referring_links_semantic_locationsdefault value: 10；maximum value: 1000
- `[].backlinks_status_type` — string，可选。set what backlinks to return and count；optional field；you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target;；possible values: ；all - all backlinks will be returned and counted;；live - backlinks found during the last check will be returned and counted;；lost - lost backlinks will be returned and counted;default value: live
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, =, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["referring_links_types.anchors","&gt;","1"][["broken_pages","&gt;","2"],；"and",；["backlinks","&gt;","10"]][["first_seen",">","2017-10-23 11:31:45 +00:00"],；"and",；[["anchor","like","%seo%"],"or",["referring_domains","&gt;","10"]]]The full list of possible filters is available here.
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["backlinks,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["backlinks,desc","rank,asc"]
- `[].backlinks_filters` — array<object>，可选。filter the backlinks of your target；optional field；you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target；you can filter the backlinks by all fields available in the response of this endpoint；using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for；example:；"backlinks_filters": [["dofollow", "=", true]]
- `[].include_subdomains` — boolean，可选。indicates if the subdomains of the target will be included in the search；optional field；if set to false, the subdomains will be ignored；default value: true
- `[].include_indirect_links` — boolean，可选。indicates if indirect links to the target will be included in the results；optional field；if set to true, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page；if set to false, indirect links will be ignored；default value: true
- `[].exclude_internal_backlinks` — boolean，可选。indicates whether the backlinks from subdomains of the target are excluded；optional field；if set to false, the backlinks from subdomains of the target will be ommited and you won't receive the same domain in the response;；default value: true
- `[].rank_scale` — string，可选。defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values；optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values:；one_hundred — rank values are displayed on a 0–100 scale；one_thousand — rank values are displayed on a 0–1000 scaledefault value: one_thousandlearn more about how this parameter works and how ranking metrics are calculated in this Help Center article
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "target": "forbes.com",
    "limit": "4",
    "order_by": [
      "backlinks,desc"
    ],
    "filters": [
      "anchor",
      "like",
      "%news%"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/backlinks/available_filters

ID: `BacklinksAvailableFilters`
用途: Backlinks API features plenty of parameters that support custom filtration. By applying filters to your POST requests, you will be able to effortlessly extract data that matches your requirements. Note that we do not charge any fees for using data filtering or sorting rules. ‌‌ Here you will find all the necessary information about filters that can be used with DataForSEO Backlinks API endpoints.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/backlinks/backlinks/live

ID: `BacklinksLive`
用途: ‌ This endpoint will provide you with a list of backlinks and relevant data for the specified domain, subdomain, or webpage.
中文补充: **POST** `https://api.seermartech.cn/v3/backlinks/backlinks/live`

请求体: `application/json`

请求字段:
- `[].target` — string，可选。domain, subdomain or webpage to get backlinks for；required field；a domain or a subdomain should be specified without https:// and www.；a page should be specified with absolute URL (including http:// or https://)
- `[].mode` — string，可选。results grouping type；optional field；possible grouping types:；as_is - returns all backlinks；one_per_domain - returns one backlink per domain；one_per_anchor - returns one backlink per anchordefault value: as_is
- `[].custom_mode` — object，可选。detailed results grouping type；optional field；use this object to get a specific number of backlinks per field；if you use custom_mode, then mode will be ignored；example:；"custom_mode": {"field": "domain", "value": 100}
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；=, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, regex, not_regex, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["rank","&gt;","80"][["page_from_rank","&gt;","55"],；"and",；["dofollow","=",true]][["first_seen",">","2017-10-23 11:31:45 +00:00"],；"and",；[["anchor","like","%seo%"],"or",["text_pre","like","%seo%"]]]The full list of possible filters is available here.
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["rank,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["domain_from_rank,desc","page_from_rank,asc"]
- `[].offset` — integer，可选。offset in the results array of the returned backlinks；optional fielddefault value: 0；if you specify the 10 value, the first ten backlinks in the results array will be omitted and the data will be provided for the successive backlinks;；Note: the maximum value is 20,000, use the search_after_token if you would like to offset more results
- `[].search_after_token` — string，可选。token for subsequent requests；optional field；provided in the identical filed of the response to each request;；use this parameter to avoid timeouts while trying to obtain over 20,000 results in a single request;；by specifying the unique search_after_token value from the response array, you will get the subsequent results of the initial task;；search_after_token values are unique for each subsequent task ;；Note: if the search_after_token is specified in the request, all other parameters should be identical to the previous request
- `[].limit` — integer，可选。the maximum number of returned backlinks；optional fielddefault value: 100；maximum value: 1000
- `[].backlinks_status_type` — string，可选。set what backlinks to return and count；optional field；you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target;；possible values: ；all - all backlinks will be returned and counted;；live - backlinks found during the last check will be returned and counted;；lost - lost backlinks will be returned and counted;default value: live
- `[].include_subdomains` — boolean，可选。indicates if the subdomains of the target will be included in the search；optional field；if set to false, the subdomains will be ignored；default value: true
- `[].exclude_internal_backlinks` — boolean，可选。indicates if internal backlinks from subdomains to the target will be excluded from the results；optional field；if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target；if set to false, internal links will be included in the results；default value: true
- `[].rank_scale` — string，可选。defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values；optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values:；one_hundred — rank values are displayed on a 0–100 scale；one_thousand — rank values are displayed on a 0–1000 scaledefault value: one_thousandlearn more about how this parameter works and how ranking metrics are calculated in this Help Center article
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "target": "forbes.com",
    "mode": "as_is",
    "filters": [
      "dofollow",
      "=",
      "true"
    ],
    "limit": "5"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/backlinks/bulk_backlinks/live

ID: `BulkBacklinksLive`
用途: ‌ This endpoint will provide you with the number of backlinks pointing to domains, subdomains, and pages specified in the targets array. The returned numbers correspond to all live backlinks, that is, total number of referring links with all attributes (e.g., nofollow, noreferrer, ugc, sponsored etc) that were found during the latest check.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].targets` — array<string>，可选。domains, subdomains or webpages to get the number of backlinks for；required field；you can set up to 1000 domains, subdomains or webpages；the domain or subdomain should be specified without https:// and www.；the page should be specified with absolute URL (including http:// or https://)；example:；`"targets": [； "forbes.com",； "cnn.com",； "bbc.com",； "yelp.com",； "https://www.apple.com/iphone/",； "https://ahrefs.com/blog/",； "ibm.com",； "https://variety.com/",； "https://stackoverflow.com/",； "www.trustpilot.com"；]`
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "targets": [
      "forbes.com",
      "cnn.com",
      "bbc.com",
      "yelp.com",
      "https://www.apple.com/iphone/",
      "https://ahrefs.com/blog/",
      "ibm.com",
      "https://variety.com/",
      "https://stackoverflow.com/",
      "www.trustpilot.com"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/backlinks/bulk_new_lost_backlinks/live

ID: `BulkNewLostBacklinksLive`
用途: ‌ This endpoint will provide you with the number of new and lost backlinks for the domains, subdomains, and pages specified in the targets array.
中文补充: **POST** `https://api.seermartech.cn/v3/backlinks/bulk_new_lost_backlinks/live`

请求体: `application/json`

请求字段:
- `[].targets` — array<string>，可选。domains, subdomains or webpages to get new & lost backlinks for；required field；you can set up to 1000 domains, subdomains or webpages；the domain or subdomain should be specified without `https://` and `www.` the page should be specified with absolute URL (including http:// or https://)；example:； `"targets": [； "forbes.com",； "cnn.com",； "bbc.com",； "yelp.com",； "https://www.apple.com/iphone/",； "https://ahrefs.com/blog/",； "ibm.com",； "https://variety.com/",； "https://stackoverflow.com/",； "www.trustpilot.com"；]`
- `[].date_from` — string，可选。starting date of the time range；optional field；this field indicates the date which will be used as a threshold for new and lost backlinks;；the backlinks that appeared in our index after the specified date will be considered as new;；the backlinks that weren't found after the specified date, but were present before, will be considered as lost;default value: today's date -(minus) one month;；e.g. if today is 2021-10-13, default date_from will be 2021-09-13.；minimum value equals today's date -(minus) one year;；e.g. if today is 2021-10-13, minimum date_from will be 2020-10-13.date format: "yyyy-mm-dd"；example:；"2021-01-01"
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "targets": [
      "forbes.com",
      "cnn.com",
      "bbc.com",
      "yelp.com",
      "https://www.apple.com/iphone/",
      "https://ahrefs.com/blog/",
      "ibm.com",
      "https://variety.com/",
      "https://stackoverflow.com/",
      "www.trustpilot.com"
    ],
    "date_from": "2026-07-22 17:42:44"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/backlinks/bulk_new_lost_referring_domains/live

ID: `BulkNewLostReferringDomainsLive`
用途: ‌ This endpoint will provide you with the number of referring domains pointing to the domains, subdomains and pages specified in the targets array.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].targets` — array<string>，可选。domains, subdomains or webpages to get new & lost referring domains for；required field；you can set up to 1000 domains, subdomains or webpages；the domain or subdomain should be specified without https:// and www.；the page should be specified with absolute URL (including http:// or https://)；example:；`"targets": [； "forbes.com",； "cnn.com",； "bbc.com",； "yelp.com",； "https://www.apple.com/iphone/",； "https://ahrefs.com/blog/",； "ibm.com",； "https://variety.com/",； "https://stackoverflow.com/",； "www.trustpilot.com"；]`
- `[].date_from` — string，可选。starting date of the time range；optional field；this field indicates the date which will be used as a threshold for new and lost referring domains;；the referring domains that appeared in our index after the specified date will be considered as new;；the referring domains that weren't found after the specified date, but were present before, will be considered as lost;default value: today's date -(minus) one month;；e.g. if today is 2021-10-13, default date_from will be 2021-09-13.；minimum value equals today's date -(minus) one year;；e.g. if today is 2021-10-13, minimum date_from will be 2020-10-13.date format: "yyyy-mm-dd"；example:；"2021-01-01"
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "targets": [
      "forbes.com",
      "cnn.com",
      "bbc.com",
      "yelp.com",
      "https://www.apple.com/iphone/",
      "https://ahrefs.com/blog/",
      "ibm.com",
      "https://variety.com/",
      "https://stackoverflow.com/",
      "www.trustpilot.com"
    ],
    "datetime_from": "2026-42-22"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/backlinks/bulk_pages_summary/live

ID: `BulkPagesSummaryLive`
用途: This endpoint will provide you with a comprehensive overview of backlinks and related data for a bulk of up to 1000 pages, domains, or subdomains. If you indicate a single page as a target, you will get comprehensive summary data on all backlinks for that page.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].targets` — array<string>，可选。domains, subdomains or webpages to get summary data for；required field；a domain or a subdomain should be specified without https:// and www.；a page should be specified with absolute URL (including http:// or https://)；you can specify up to 1000 pages, domains, or subdomains in each request.；note that the URLs you set in a single request cannot belong to more than 100 different domains.
- `[].include_subdomains` — boolean，可选。indicates if the subdomains of the target will be included in the search；optional field；if set to false, the subdomains will be ignored；default value: true
- `[].rank_scale` — string，可选。defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values；optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values:；one_hundred — rank values are displayed on a 0–100 scale；one_thousand — rank values are displayed on a 0–1000 scaledefault value: one_thousandlearn more about how this parameter works and how ranking metrics are calculated in this Help Center article
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "targets": [
      "https://dataforseo.com/solutions",
      "https://dataforseo.com/about-us"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/backlinks/bulk_ranks/live

ID: `BulkRanksLive`
用途: ‌ This endpoint will provide you with rank scores of the domains, subdomains, and pages specified in the targets array. The score is based on the number of referring domains pointing to the specified domains, subdomains, or pages. The rank values represent real-time data for the date of the request and range from 0 (no backlinks detected) to 1,000 (highest rank). A similar scoring system is used in Google’s Page Rank algorithm. You can learn more about rank scores in this help center article
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].targets` — array<string>，可选。domains, subdomains or webpages to get rank for；required field；you can set up to 1000 domains, subdomains or webpages；the domain or subdomain should be specified without https:// and www.；the page should be specified with absolute URL (including http:// or https://)；example:；`"targets": [； "forbes.com",； "cnn.com",； "bbc.com",； "yelp.com",； "https://www.apple.com/iphone/",； "https://ahrefs.com/blog/",； "ibm.com",； "https://variety.com/",； "https://stackoverflow.com/",； "www.trustpilot.com"；]`
- `[].rank_scale` — string，可选。defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values；optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values:；one_hundred — rank values are displayed on a 0–100 scale；one_thousand — rank values are displayed on a 0–1000 scaledefault value: one_thousandlearn more about how this parameter works and how ranking metrics are calculated in this Help Center article
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "targets": [
      "forbes.com",
      "cnn.com",
      "bbc.com",
      "yelp.com",
      "https://www.apple.com/iphone/",
      "https://ahrefs.com/blog/",
      "ibm.com",
      "https://variety.com/",
      "https://stackoverflow.com/",
      "www.trustpilot.com"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/backlinks/bulk_referring_domains/live

ID: `BulkReferringDomainsLive`
用途: ‌ This endpoint will provide you with the number of referring domains pointing to domains, subdomains, and pages specified in the targets array. The returned numbers are based on all live referring domains, that is, total number of domains pointing to the target with any type of backlinks (e.g., nofollow, noreferrer, ugc, sponsored etc) that were found during the latest check.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].targets` — array<string>，可选。domains, subdomains or webpages to get the number of referring domains for；required field；you can set up to 1000 domains, subdomains or webpages；the domain or subdomain should be specified without https:// and www.；the page should be specified with absolute URL (including http:// or https://)；example:；`"targets": [； "forbes.com",； "cnn.com",； "bbc.com",； "yelp.com",； "https://www.apple.com/iphone/",； "https://ahrefs.com/blog/",； "ibm.com",； "https://variety.com/",； "https://stackoverflow.com/",； "www.trustpilot.com"；]`
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "targets": [
      "forbes.com",
      "cnn.com",
      "bbc.com",
      "yelp.com",
      "https://www.apple.com/iphone/",
      "https://ahrefs.com/blog/",
      "ibm.com",
      "https://variety.com/",
      "https://stackoverflow.com/",
      "www.trustpilot.com"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/backlinks/bulk_spam_score/live

ID: `BulkSpamScoreLive`
用途: ‌ This endpoint will provide you with spam scores of the domains, subdomains, and pages you specified in the targets array. Spam Score is DataForSEO’s proprietary metric that indicates how “spammy” your target is on a scale from 0 to 100. You can learn more about Spam Score, how it is calculated, and signals it takes into account in this help center article
中文补充: **POST `/v3/backlinks/bulk_spam_score/live`**

请求体: `application/json`

请求字段:
- `[].targets` — array<string>，可选。domains, subdomains or webpages to get rank for；required field；you can set up to 1000 domains, subdomains or webpages；the domain or subdomain should be specified without https:// and www.；the page should be specified with absolute URL (including http:// or https://)；example:；`"targets": [； "forbes.com",； "cnn.com",； "bbc.com",； "yelp.com",； "https://www.apple.com/iphone/",； "https://ahrefs.com/blog/",； "ibm.com",； "https://variety.com/",； "https://stackoverflow.com/",； "www.trustpilot.com"；]`
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "targets": [
      "forbes.com",
      "cnn.com",
      "bbc.com",
      "yelp.com",
      "https://www.apple.com/iphone/",
      "https://ahrefs.com/blog/",
      "ibm.com",
      "https://variety.com/",
      "https://stackoverflow.com/",
      "www.trustpilot.com"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/backlinks/competitors/live

ID: `CompetitorsLive`
用途: ‌‌ This endpoint will provide you with a list of competitors that share some part of the backlink profile with a target website, along with a number of backlink intersections and the rank of every competing website.
中文补充: 本接口通过分析目标网站的反向链接画像，返回与部分反向链接来源的竞争对手域名、反向链接交集数量及竞争对手排名。

请求体: `application/json`

请求字段:
- `[].target` — string，可选。domain, subdomain or webpage to get competitor domains for；required field；a domain or a subdomain should be specified without https:// and www.；a page should be specified with absolute URL (including http:// or https://)
- `[].limit` — integer，可选。the maximum number of returned domains；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned domains；optional field；default value: 0；if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive pages
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, =, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["rank","&gt;","100"][["target","like","%forbes%"],；"and",；[["rank","&gt;","100"],"or",["intersections","&gt;","5"]]]The full list of possible filters is available here.
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["rank,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["intersections,desc","rank,asc"]
- `[].main_domain` — boolean，可选。indicates if only main domain of the target will be included in the search；optional field；if set to true, only the main domain will be included in search;；default value: true
- `[].exclude_large_domains` — boolean，可选。indicates whether large domain will appear in results；optional field；if set to true, the results from the large domain (google.com, amazon.com, etc.) will be omitted;；default value: true
- `[].exclude_internal_backlinks` — boolean，可选。indicates if internal backlinks from subdomains to the target will be excluded from the results；optional field；if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target；if set to false, internal links will be included in the results；default value: true
- `[].rank_scale` — string，可选。defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values；optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values:；one_hundred — rank values are displayed on a 0–100 scale；one_thousand — rank values are displayed on a 0–1000 scaledefault value: one_thousandlearn more about how this parameter works and how ranking metrics are calculated in this Help Center article
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "target": "dataforseo.com",
    "filters": [
      "rank",
      ">",
      "100"
    ],
    "order_by": [
      "rank,desc"
    ],
    "limit": "5"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/backlinks/domain_intersection/live

ID: `DomainIntersectionLive`
用途: ‌ This endpoint will provide you with the list of domains pointing to the specified websites. This endpoint is especially useful for creating a Link Gap feature that shows what domains link to your competitors but do not link out to your website.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].targets` — object，可选。domains, subdomains or webpages to get links for；required field；you can set up to 20 domains, subdomains or webpages；a domain or a subdomain should be specified without https:// and www.；a page should be specified with absolute URL (including http:// or https://)；example:；`"targets": {；"1": "http://planet.postgresql.org/",；"2": "http://gborg.postgresql.org/"；}`
- `[].exclude_targets` — array<string>，可选。domains, subdomains or webpages you want to exclude；optional field；you can specify up to 10 domains, subdomains or webpages；if you use this array, results will contain the referring domains that link to targets but don't link to exclude_targets；example:；`"exclude_targets": [；"bbc.com",；"https://www.apple.com/iphone/*",；"https://dataforseo.com/apis/*"]`
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, =, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["1.internal_links_count","&gt;","1"][["2.referring_pages","&gt;","2"],；"and",；["1.backlinks","&gt;","10"]][["1.first_seen",">","2017-10-23 11:31:45 +00:00"],；"and",；[["2.target","like","%dataforseo.com%"],"or",["1.referring_domains","&gt;","10"]]]The full list of possible filters is available here.
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["backlinks,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["backlinks,desc","rank,asc"]
- `[].offset` — integer，可选。offset in the array of returned results；optional field；default value: 0；if you specify the 10 value, the first ten backlinks in the results array will be omitted and the data will be provided for the successive backlinks
- `[].limit` — integer，可选。the maximum number of returned results；optional field；default value: 100；maximum value: 1000
- `[].internal_list_limit` — integer，可选。maximum number of elements within internal arrays；optional field；you can use this field to limit the number of elements within the following arrays:；referring_links_tld；referring_links_types；referring_links_attributes；referring_links_platform_types；referring_links_semantic_locationsdefault value: 10；maximum value: 1000
- `[].backlinks_status_type` — string，可选。set what backlinks to return and count；optional field；you can use this field to choose what backlinks will be returned and used for aggregated metrics for your targets;；possible values: ；all - all backlinks will be returned and counted;；live - backlinks found during the last check will be returned and counted;；lost - lost backlinks will be returned and counted;default value: live
- `[].backlinks_filters` — array<object>，可选。filter the backlinks of your target；optional field；you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target；you can filter the backlinks by all fields available in the response of this endpoint；using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for；example:；"backlinks_filters": [["dofollow", "=", true]]
- `[].include_subdomains` — boolean，可选。indicates if the subdomains of the target will be included in the search；optional field；if set to false, the subdomains will be ignored；default value: true
- `[].include_indirect_links` — boolean，可选。indicates if indirect links to the targets will be included in the results；optional field；if set to true, the results will include data on indirect links pointing to a page that either redirects to a target, or points to a canonical page；if set to false, indirect links will be ignored；default value: true
- `[].exclude_internal_backlinks` — boolean，可选。indicates whether the backlinks from subdomains of the target are excluded；optional field；if set to false, the backlinks from subdomains of the target will be omitted and you won't receive the same domain in the response;；default value: true
- `[].intersection_mode` — string，可选。indicates whether to intersect backlinks；optional field；use this field to intersect or merge results for the specified domains；possible values: all, partial；all - results are based on all backlinks;；partial - results are based on the intersecting backlinks only;；default value: all
- `[].rank_scale` — string，可选。defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values；optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values:；one_hundred — rank values are displayed on a 0–100 scale；one_thousand — rank values are displayed on a 0–1000 scaledefault value: one_thousandlearn more about how this parameter works and how ranking metrics are calculated in this Help Center article
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "targets": {
      "1": "moz.com",
      "2": "ahrefs.com"
    },
    "include_subdomains": "false",
    "exclude_targets": [
      "semrush.com"
    ],
    "limit": "5",
    "order_by": [
      "1.backlinks,desc"
    ],
    "exclude_internal_backlinks": "true"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/backlinks/domain_pages/live

ID: `DomainPagesLive`
用途: ‌‌ This endpoint will provide you with a detailed overview of domain pages with backlink data for each page.
中文补充: **POST `/v3/backlinks/domain_pages/live`**

请求体: `application/json`

请求字段:
- `[].target` — string，可选。domain or subdomain；required field；a domain or a subdomain should be specified without https:// and www.；example:；forbes.com
- `[].limit` — integer，可选。the maximum number of returned pages；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned pages；optional field；default value: 0；if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages
- `[].internal_list_limit` — integer，可选。maximum number of elements within internal arrays；optional field；you can use this field to limit the number of elements within the following arrays:；referring_links_tld；referring_links_types；referring_links_attributes；referring_links_platform_types；referring_links_semantic_locationsdefault value: 10；maximum value: 1000
- `[].backlinks_status_type` — string，可选。set what backlinks to return and count；optional field；you can use this field to choose what backlinks will be returned and used for aggregated metrics;；possible values: ；all - all backlinks will be returned and counted;；live - backlinks found during the last check will be returned and counted;；lost - lost backlinks will be returned and counted;default value: live
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, =, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["meta.internal_links_count","&gt;","1"][["meta.external_links_count","&gt;","2"],；"and",；["backlinks","&gt;","10"]][["first_visited",">","2017-10-23 11:31:45 +00:00"],；"and",；[["title","like","%seo%"],"or",["referring_domains","&gt;","10"]]]The full list of possible filters is available here.
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["page_summary.backlinks,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["page_summary.backlinks,desc","page_summary.rank,asc"]
- `[].backlinks_filters` — array<object>，可选。filter the backlinks of your target；optional field；you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target；you can filter the backlinks by all fields available in the response of this endpoint；using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for；example:；"backlinks_filters": ["dofollow", "=", true]
- `[].include_subdomains` — boolean，可选。indicates if the subdomains of the target will be included in the search；optional field；if set to false, the subdomains will be ignored；default value: true
- `[].exclude_internal_backlinks` — boolean，可选。indicates if internal backlinks from subdomains to the target will be excluded from the results；optional field；if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target；if set to false, internal links will be included in the results；default value: true
- `[].rank_scale` — string，可选。defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values；optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values:；one_hundred — rank values are displayed on a 0–100 scale；one_thousand — rank values are displayed on a 0–1000 scaledefault value: one_thousandlearn more about how this parameter works and how ranking metrics are calculated in this Help Center article
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "target": "forbes.com",
    "limit": "5",
    "filters": [
      [
        "page_summary.backlinks",
        ">",
        "5"
      ],
      "and",
      [
        "page",
        "like",
        "%sites%"
      ]
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/backlinks/domain_pages_summary/live

ID: `DomainPagesSummaryLive`
用途: This endpoint will provide you with detailed summary data on all backlinks and related metrics for each page of the target domain or subdomain you specify. If you indicate a single page as a target, you will get comprehensive summary data on all backlinks for that page.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].target` — string，可选。domain, subdomain or webpage to get summary data for；required field；a domain or a subdomain should be specified without https:// and www.；a page should be specified with absolute URL (including http:// or https://)
- `[].limit` — integer，可选。the maximum number of returned anchors；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned anchors；optional field；default value: 0；if you specify the 10 value, the first ten anchors in the results array will be omitted and the data will be provided for the successive anchors
- `[].internal_list_limit` — integer，可选。maximum number of elements within internal arrays；optional field；you can use this field to limit the number of elements within the following arrays:；referring_links_tld；referring_links_types；referring_links_attributes；referring_links_platform_types；referring_links_semantic_locationsdefault value: 10；maximum value: 1000
- `[].backlinks_status_type` — string，可选。set what backlinks to return and count；optional field；you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target;；possible values: ；all - all backlinks will be returned and counted;；live - backlinks found during the last check will be returned and counted;；lost - lost backlinks will be returned and counted;default value: live
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, =, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["referring_links_types.anchors","&gt;","1"][["broken_pages","&gt;","2"],；"and",；["backlinks","&gt;","10"]][["first_seen",">","2017-10-23 11:31:45 +00:00"],；"and",；[["anchor","like","%seo%"],"or",["referring_domains","&gt;","10"]]]The full list of possible filters is available here.
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["backlinks,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["backlinks,desc","rank,asc"]
- `[].backlinks_filters` — array<object>，可选。filter the backlinks of your target；optional field；you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target；you can filter the backlinks by all fields available in the response of this endpoint；using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for；example:；"backlinks_filters": [["dofollow", "=", true]]
- `[].include_subdomains` — boolean，可选。indicates if the subdomains of the target domain will be included in the search；optional field；if set to false, the subdomains will be ignored；default value: true
- `[].include_indirect_links` — boolean，可选。indicates if indirect links to the target will be included in the results；optional field；if set to true, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page；if set to false, indirect links will be ignored；default value: true
- `[].exclude_internal_backlinks` — boolean，可选。indicates whether the backlinks from subdomains of the target are excluded；optional field；if set to false, backlinks from the subdomains of the target domain will be ommited and you won't receive the same domain in the response;；default value: true
- `[].rank_scale` — string，可选。defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values；optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values:；one_hundred — rank values are displayed on a 0–100 scale；one_thousand — rank values are displayed on a 0–1000 scaledefault value: one_thousandlearn more about how this parameter works and how ranking metrics are calculated in this Help Center article
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "target": "forbes.com",
    "limit": "4",
    "order_by": [
      "backlinks,desc"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/backlinks/errors

ID: `BacklinksErrors`
用途: By calling this endpoint you will receive information about the Backlinks API tasks that returned an error within the past 7 days.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].limit` — integer，可选。the maximum number of returned tasks that responded with an error；optional field；default value: 1000；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned tasks；optional field；default value: 0；if you specify the 10 value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks
- `[].filtered_function` — string，可选。return tasks with a certain function；use this field to obtain a list of tasks that returned an error filtered by a certain function；you can filter the results by the values you receive in the function fields of the API response；i.e., once you receive unfiltered results, you can call this API again to filter them by function ；example: backlinks/live
- `[].datetime_from` — string，可选。start time for filtering results；optional field；allows filtering results by the datetime parameter within the range of the last 7 days;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2021-11-15 12:57:46 +00:00
- `[].datetime_to` — string，可选。finish time for filtering results；optional field；allows filtering results by the datetime parameter within the range of the last 7 days;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2021-11-15 13:57:46 +00:00

最小请求示例:

```json
[
  {
    "limit": "10"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/backlinks/history/live

ID: `HistoryLive`
用途: ‌ This endpoint will provide you with historical backlinks data back to the beginning of 2019. You can receive the number of backlinks a given domain had in a specific time period, the number of new & lost backlinks, referring domains, and more.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].target` — string，可选。domain；required field；a domain should be specified without https:// and www.
- `[].date_from` — string，可选。starting date of the time range；optional field；minimum value 2019-01-01；if you don't specify this field, the minimum value will be used by default；date format: "yyyy-mm-dd"；example:；"2019-01-15"
- `[].date_to` — string，可选。ending date of the time range；optional field；if you don't specify this field, the today's date will be used by default；date format: "yyyy-mm-dd"；example:；"2019-01-15"
- `[].rank_scale` — string，可选。defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values；optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values:；one_hundred — rank values are displayed on a 0–100 scale；one_thousand — rank values are displayed on a 0–1000 scaledefault value: one_thousandlearn more about how this parameter works and how ranking metrics are calculated in this Help Center article
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "target": "cnn.com",
    "date_from": "2020-01-01",
    "date_to": "2021-01-01"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/backlinks/id_list

ID: `BacklinksIdList`
用途: This endpoint is designed to provide you with a list of IDs and metadata for all Backlinks tasks created within the specified time period, including both successful and uncompleted tasks.
中文补充: 本接口使用 **POST** 方法，路径为 **`/v3/backlinks/id_list`**，用于查询指定时间范围创建的所有 Backlinks 任务，并返回任务 ID 及数据。结果已完成、执行中以及未完成的任务。

请求体: `application/json`

请求字段:
- `[].datetime_from` — string，可选。start time for filtering results；required field；if include_metadata is set to true, maximum value: a month from current datetime;；if include_metadata is set to false, maximum value: six months from current datetime;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2023-01-15 12:57:46 +00:00
- `[].datetime_to` — string，可选。finish time for filtering results；required field；maximum value: current datetime;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2023-01-31 13:57:46 +00:00
- `[].limit` — integer，可选。the maximum number of returned task IDs；optional field；default value: 1000；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned task IDs；optional field；default value: 0；if you specify the 10 value, the first ten tasks in the results array will be omitted
- `[].sort` — string，可选。sorting by task execution time；optional field；possible values: "asc", "desc"；default value: "asc"
- `[].include_metadata` — boolean，可选。include task metadata in the respond；optional field；default value: false

最小请求示例:

```json
[
  {
    "datetime_from": "2026-08-01 17:42:44",
    "datetime_to": "2026-08-11 17:42:44",
    "limit": "10",
    "include_metadata": "true"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/backlinks/index

ID: `Index`
用途: ‌ This endpoint will provide you with the total number of backlinks, domains, and pages our database contains for the moment when you make a request. You will also get stats for the last 12 months.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/backlinks/page_intersection/live

ID: `PageIntersectionLive`
用途: ‌ This endpoint will provide you with the list of referring pages pointing to the specified targets. It is especially useful for finding the backlinks that point to your competitors but don’t point to your website.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].targets` — object，可选。domains, subdomains or webpages to get links for；required field；you can set up to 20 domains, subdomains or webpages；a domain or a subdomain should be specified without https:// and www.；a page should be specified with absolute URL (including http:// or https://)；example:；`"targets": {；"1": "http://planet.postgresql.org/",；"2": "http://gborg.postgresql.org/"；}`
- `[].exclude_targets` — array<string>，可选。domains, subdomains or webpages you want to exclude；optional field；you can set up to 10 domains, subdomains or webpages；if you use this array, results will contain the referring pages that link to targets but don't link to exclude_targets；example:；`"exclude_targets": [；"bbc.com",；"https://www.apple.com/iphone/*",；"https://dataforseo.com/apis/*"]`
- `[].backlinks_status_type` — string，可选。set what backlinks to return and count；optional field；you can use this field to choose what backlinks will be returned and used for aggregated metrics for your targets;；possible values: ；all - all backlinks will be returned and counted;；live - backlinks found during the last check will be returned and counted;；lost - lost backlinks will be returned and counted;default value: live
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, =, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["1.rank","&gt;","80"][["2.page_from_rank","&gt;","55"],；"and",；["1.original","=","true"]][["1.first_seen",">","2017-10-23 11:31:45 +00:00"],；"and",；[["1.acnhor","like","%seo%"],"or",["1.text_pre","not_like","%seo%"]]]The full list of possible filters is available here.
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["rank,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["domain_from_rank,desc","page_from_rank,asc"]
- `[].offset` — integer，可选。offset in the results array of the returned backlinks；optional fielddefault value: 0；if you specify the 10 value, the first ten backlinks in the results array will be omitted and the data will be provided for the successive backlinks
- `[].limit` — integer，可选。the maximum number of returned backlinks；optional fielddefault value: 100；maximum value: 1000
- `[].internal_list_limit` — integer，可选。maximum number of elements within internal arrays；optional field；you can use this field to limit the number of elements within the following arrays:；attributes；domain_from_platform_typedefault value: 10；maximum value: 1000
- `[].include_subdomains` — boolean，可选。indicates if the subdomains of the targets will be included in the search；optional field；if set to false, the subdomains will be ignored；default value: true
- `[].include_indirect_links` — boolean，可选。indicates if indirect links to the targets will be included in the results；optional field；if set to true, the results will include data on indirect links pointing to a page that either redirects to a target, or points to a canonical page；if set to false, indirect links will be ignored；default value: true
- `[].exclude_internal_backlinks` — boolean，可选。indicates if internal backlinks from subdomains to the target will be excluded from the results；optional field；if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target；if set to false, internal links will be included in the result；default value: true
- `[].intersection_mode` — string，可选。indicates whether to intersect backlinks；optional field；use this field to intersect or merge results for the specified URLs；possible values: all, partial；all - results are based on all backlinks;；partial - results are based on the intersecting backlinks only;；default value: all
- `[].rank_scale` — string，可选。defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values；optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values:；one_hundred — rank values are displayed on a 0–100 scale；one_thousand — rank values are displayed on a 0–1000 scaledefault value: one_thousandlearn more about how this parameter works and how ranking metrics are calculated in this Help Center article
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "targets": {
      "1": "football.com",
      "2": "fifa.com"
    },
    "exclude_targets": [
      "skysports.com"
    ],
    "limit": "5",
    "order_by": [
      "1.rank,desc"
    ],
    "filters": [
      [
        "2.domain_from_rank",
        ">",
        "400"
      ],
      "and",
      [
        "1.dofollow",
        "=",
        "true"
      ]
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/backlinks/referring_domains/live

ID: `ReferringDomainsLive`
用途: ‌‌ This endpoint will provide you with a detailed overview of referring domains pointing to the target you specify.
中文补充: **POST `/v3/backlinks/referring_domains/live`**

请求体: `application/json`

请求字段:
- `[].target` — string，可选。domain, subdomain or webpage to get referring domains for；required field；a domain or a subdomain should be specified without https:// and www.；a page should be specified with absolute URL (including http:// or https://)
- `[].limit` — integer，可选。the maximum number of returned domains；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned domains；optional field；default value: 0；if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive pages
- `[].internal_list_limit` — integer，可选。maximum number of elements within internal arrays；optional field；you can use this field to limit the number of elements within the following arrays:；referring_links_tld；referring_links_types；referring_links_attributes；referring_links_platform_types；referring_links_semantic_locationsdefault value: 10；maximum value: 1000
- `[].backlinks_status_type` — string，可选。set what backlinks to return and count；optional field；you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target;；possible values: ；all - all backlinks will be returned and counted;；live - backlinks found during the last check will be returned and counted;；lost - lost backlinks will be returned and counted;default value: live
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, =, &lt;&gt;, in, not_in, like, not_like, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["referring_pages","&gt;","1"][["referring_pages","&gt;","2"],；"and",；["backlinks","&gt;","10"]][["first_seen",">","2017-10-23 11:31:45 +00:00"],；"and",；[["domain","like","%dataforseo.com%"],"or",["referring_domains","&gt;","10"]]]The full list of possible filters is available here.
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["backlinks,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["backlinks,desc","rank,asc"]
- `[].backlinks_filters` — array<object>，可选。filter the backlinks of your target；optional field；you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target；you can filter the backlinks by all fields available in the response of this endpoint；using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for；example:；"backlinks_filters": ["dofollow", "=", true]
- `[].include_subdomains` — boolean，可选。indicates if the subdomains of the target will be included in the search；optional field；if set to false, the subdomains will be ignored；default value: true
- `[].include_indirect_links` — boolean，可选。indicates if indirect links to the target will be included in the results；optional field；if set to true, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page；if set to false, indirect links will be ignored；default value: true
- `[].exclude_internal_backlinks` — boolean，可选。indicates whether the backlinks from subdomains of the target are excluded；optional field；if set to false, the backlinks from subdomains of the target will be ommited and you won't receive the same domain in the response;；default value: true
- `[].rank_scale` — string，可选。defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values；optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values:；one_hundred — rank values are displayed on a 0–100 scale；one_thousand — rank values are displayed on a 0–1000 scaledefault value: one_thousandlearn more about how this parameter works and how ranking metrics are calculated in this Help Center article
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "target": "backlinko.com",
    "limit": "5",
    "order_by": [
      "rank,desc"
    ],
    "exclude_internal_backlinks": "true",
    "backlinks_filters": [
      "dofollow",
      "=",
      "true"
    ],
    "filters": [
      "backlinks",
      ">",
      "100"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/backlinks/referring_networks/live

ID: `ReferringNetworksLive`
用途: ‌‌ This endpoint will provide you with a detailed overview of referring IPs and subnets pointing to the target you specify.
中文补充: **POST** `https://api.seermartech.cn/v3/backlinks/referring_networks/live`

请求体: `application/json`

请求字段:
- `[].target` — string，可选。domain, subdomain or webpage to get referring networks for；required field；a domain or a subdomain should be specified without https:// and www.；a page should be specified with absolute URL (including http:// or https://)
- `[].network_address_type` — string，可选。indicates the type of network to get data for；optional field；possible values: ip, subnet；default value: ip
- `[].limit` — integer，可选。the maximum number of returned networks；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned networks；optional field；default value: 0；if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive pages
- `[].internal_list_limit` — integer，可选。maximum number of elements within internal arrays；optional field；you can use this field to limit the number of elements within the following arrays:；referring_links_tld；referring_links_types；referring_links_attributes；referring_links_platform_types；referring_links_semantic_locationsdefault value: 10；maximum value: 1000
- `[].backlinks_status_type` — string，可选。set what backlinks to return and count；optional field；you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target;；possible values: ；all - all backlinks will be returned and counted;；live - backlinks found during the last check will be returned and counted;；lost - lost backlinks will be returned and counted;default value: live
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, =, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["referring_pages","&gt;","1"][["referring_pages","&gt;","2"],；"and",；["backlinks","&gt;","10"]][["first_seen",">","2017-10-23 11:31:45 +00:00"],；"and",；[["network_address","like","194.1.%"],"or",["referring_ips","&gt;","10"]]]The full list of possible filters is available here.
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["backlinks,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["backlinks,desc","rank,asc"]
- `[].backlinks_filters` — array<object>，可选。filter the backlinks of your target；optional field；you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target；you can filter the backlinks by all fields available in the response of this endpoint；using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for；example:；"backlinks_filters": [["dofollow", "=", true]]
- `[].include_subdomains` — boolean，可选。indicates if the subdomains of the target will be included in the search；optional field；if set to false, the subdomains will be ignored；default value: true
- `[].include_indirect_links` — boolean，可选。indicates if indirect links to the target will be included in the results；optional field；if set to true, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page；if set to false, indirect links will be ignored；default value: true
- `[].exclude_internal_backlinks` — boolean，可选。indicates whether the backlinks from subdomains of the target are excluded；optional field；if set to false, the backlinks from subdomains of the target will be ommited and you won't receive the same domain in the response;；default value: true
- `[].rank_scale` — string，可选。defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values；optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values:；one_hundred — rank values are displayed on a 0–100 scale；one_thousand — rank values are displayed on a 0–1000 scaledefault value: one_thousandlearn more about how this parameter works and how ranking metrics are calculated in this Help Center article
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "target": "backlinko.com",
    "network_address_type": "subnet",
    "limit": "5",
    "order_by": [
      "rank,desc"
    ],
    "exclude_internal_backlinks": "true",
    "backlinks_filters": [
      "dofollow",
      "=",
      "true"
    ],
    "filters": [
      "backlinks",
      ">",
      "100"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/backlinks/summary/live

ID: `SummaryLive`
用途: ‌ This endpoint will provide you with an overview of backlinks data available for a given domain, subdomain, or webpage.
中文补充: 本接口用于获取指定域名、子域名或网页的反向链接概览数据反向链接数量、引用域名、链接类型、链接属性、垃圾链接评分及已抓取页面等聚合指标。

请求体: `application/json`

请求字段:
- `[].target` — string，可选。domain, subdomain or webpage to get data for；required field；a domain or a subdomain should be specified without https:// and www.；a page should be specified with absolute URL (including http:// or https://)
- `[].include_subdomains` — boolean，可选。indicates if the subdomains of the target will be included in the search；optional field；if set to false, the subdomains will be ignored；default value: true
- `[].include_indirect_links` — boolean，可选。indicates if indirect links to the target will be included in the results；optional field；if set to true, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page；if set to false, indirect links will be ignored；default value: true
- `[].exclude_internal_backlinks` — boolean，可选。indicates if internal backlinks from subdomains to the target will be excluded from the results；optional field；if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target；if set to false, internal links will be included in the results；default value: true
- `[].internal_list_limit` — integer，可选。maximum number of elements within internal arrays；optional field；you can use this field to limit the number of elements within the following arrays:；referring_links_tld；referring_links_types；referring_links_attributes；referring_links_platform_types；referring_links_semantic_locationsdefault value: 10；maximum value: 1000
- `[].backlinks_status_type` — string，可选。set what backlinks to return and count；optional field；you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target;；possible values: ；all - all backlinks will be returned and counted;；live - backlinks found during the last check will be returned and counted;；lost - lost backlinks will be returned and counted;default value: live
- `[].backlinks_filters` — array<object>，可选。filter the backlinks of your target；optional field；you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target；you can filter the backlinks by all fields available in the response of this endpoint；using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for；example:；"backlinks_filters": ["dofollow", "=", true]
- `[].rank_scale` — string，可选。defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values；optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values:；one_hundred — rank values are displayed on a 0–100 scale；one_thousand — rank values are displayed on a 0–1000 scaledefault value: one_thousandlearn more about how this parameter works and how ranking metrics are calculated in this Help Center article
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "target": "explodingtopics.com",
    "internal_list_limit": "10",
    "include_subdomains": "true",
    "backlinks_filters": [
      "dofollow",
      "=",
      "true"
    ],
    "backlinks_status_type": "all"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/backlinks/timeseries_new_lost_summary/live

ID: `TimeseriesNewLostSummaryLive`
用途: ‌ This endpoint will provide you with the number of new and lost backlinks and referring domains for the domain specified in the target field.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].target` — string，可选。domain to get data for；required field；a domain should be specified without https:// and www.；example:；"forbes.com"
- `[].date_from` — string，可选。starting date of the time range；optional field；this field indicates the date which will be used as a threshold for new and lost backlinks and referring domains;；the backlinks and referring domains that appeared in our index after the specified date will be considered as new;；the backlinks and referring domains that weren't found after the specified date, but were present before, will be considered as lost;minimum value: 2019-01-30；maximum value shouldn't exceed the date specified in the date_to；date format: "yyyy-mm-dd"；example:；"2021-01-01"
- `[].date_to` — string，可选。ending date of the time range；optional field；if you don't specify this field, the today's date will be used by default；minimum value shouldn't preceed the date specified in the date_from；maximum value: today's date；date format: "yyyy-mm-dd"；example:；"2021-01-15"
- `[].group_range` — string，可选。time range which will be used to group the results；optional field；default value: month；possible values: day, week, month, yearnote: for day, we will return items corresponding to all dates between and including date_from and date_to;；for week/month/year, we will return items corresponding to full weeks/months/years, where each item will indicate the last day of the week/month/yearfor example, if you specify: ；"group_range": "month",；"date_from": "2022-03-23",；"date_to": "2022-05-13"；we will return items falling between 2022-03-01 and 2022-05-31, namely, three items corresponding to the following dates: 2022-03-31, 2022-04-30, 2022-05-31if there is no data for a certain day/week/month/year, we will return 0
- `[].include_subdomains` — boolean，可选。indicates if the subdomains of the target will be included in the search；optional field；if set to false, the subdomains will be ignored；default value: true
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "target": "dataforseo.com",
    "date_from": "2021-12-01",
    "date_to": "2022-02-01",
    "group_range": "month"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/backlinks/timeseries_summary/live

ID: `TimeseriesSummaryLive`
用途: ‌ This endpoint will provide you with an overview of backlink data for the target domain available during a period between the two indicated dates. Backlink metrics will be grouped by the time range that you define: day, week, month, or year.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].target` — string，可选。domain to get data for；required field；a domain should be specified without https:// and www.；example:；"forbes.com"
- `[].date_from` — string，可选。starting date of the time range；optional field；this field indicates the date which will be used as a threshold for summary data;minimum value: 2019-01-30；maximum value shouldn't exceed the date specified in the date_to；date format: "yyyy-mm-dd"；example:；"2021-01-01"
- `[].date_to` — string，可选。ending date of the time range；optional field；if you don't specify this field, the today's date will be used by default；minimum value shouldn't preceed the date specified in the date_from；maximum value: today's date；date format: "yyyy-mm-dd"；example:；"2021-01-15"
- `[].group_range` — string，可选。time range which will be used to group the results；optional field；default value: month；possible values: day, week, month, yearnote: for day, we will return items corresponding to all dates between and including date_from and date_to;；for week/month/year, we will return items corresponding to full weeks/months/years, where each item will indicate the last day of the week/month/yearfor example, if you specify: ；"group_range": "month",；"date_from": "2022-03-23",；"date_to": "2022-05-13"；we will return items falling between 2022-03-01 and 2022-05-31, namely, three items corresponding to the following dates: 2022-03-31, 2022-04-30, 2022-05-31if there is no data for a certain day/week/month/year, we will return 0
- `[].include_subdomains` — boolean，可选。indicates if the subdomains of the target will be included in the search；optional field；if set to false, the subdomains will be ignored；default value: true
- `[].rank_scale` — string，可选。defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values；optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values:；one_hundred — rank values are displayed on a 0–100 scale；one_thousand — rank values are displayed on a 0–1000 scaledefault value: one_thousandlearn more about how this parameter works and how ranking metrics are calculated in this Help Center article
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "target": "dataforseo.com",
    "date_from": "2021-12-01",
    "date_to": "2022-02-01",
    "group_range": "month"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/business_listings/available_filters

ID: `BusinessListingsAvailableFilters`
用途: ‌‌ Here you will find all the necessary information about filters that can be used with Business Listings API.
中文补充: 本页介绍 Business Listings API 可使用的过滤器。主接口契约为：`GET /v3/business_data/business_listings/available_filters`。调用该接口可获取 Business Listings 端点支持的完整过滤参数列表。

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results；contains the full list of available parameters that can be used for data filtration；the parameters are grouped by the endpoint they can be used with

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/business_listings/categories

ID: `BusinessListingsCategories`
用途: This endpoint will provide you with the list of top categories by business count.
中文补充: **GET** `/v3/business_data/business_listings/categories`

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/business_data/business_listings/categories_aggregation/live

ID: `BusinessListingsCategoriesAggregationLive`
用途: ‌‌ Business Listings Categories Aggregation endpoint provides results containing information about groups of related categories along with the number of entities in each category. The provided results are specific to the specified parameters.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].categories` — array<string>，可选。business categories；optional field；the categories you specify are used to search for business listings;；if you don't use this field, we will return business listings found in the specified location;；you can specify up to 10 categories
- `[].description` — string，可选。description of the element in SERP；optional field；the description of the business entity for which the results are collected;；can contain up to 200 characters
- `[].title` — string，可选。title of the element in SERP；optional field；the name of the business entity for which the results are collected;；can contain up to 200 characters
- `[].is_claimed` — boolean，可选。indicates whether the business is verified by its owner on Google Maps；optional field
- `[].location_coordinate` — string，可选。GPS coordinates of a location；optional field；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 1；the maximum value for "radius": 100000；example:；53.476225,-2.243572,200；learn more about how to set location parameters in this API on our Help Center
- `[].initial_dataset_filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, like, not_like, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["rating.value",">",3]you can receive the list of available filters_by making a separate request to https://api.seermartech.cn/v3/business_data/business_listings/available_filters；the full list of possible filters is available here.；learn more about the initial dataset filters in this help center article.n
- `[].internal_list_limit` — integer，可选。maximum number of elements within internal arrays；optional field；you can use this field to limit the number of elements within the aggregated categories；default value: 10
- `[].limit` — integer，可选。the maximum number of returned businesses；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。the maximum number of returned businesses；optional field
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "categories": [
      "pizza_restaurant"
    ],
    "description": "pizza",
    "title": "pizza",
    "is_claimed": "true",
    "location_coordinate": "53.476225,-2.243572,10",
    "initial_dataset_filters": [
      [
        "rating.value",
        ">",
        "3"
      ]
    ],
    "limit": "3"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/business_listings/locations

ID: `BusinessListingsLocations`
用途: You will receive the list of locations by this API call. You can also download the full list of supported locations in the CSV format (last updated 2026-08-06).
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/business_data/business_listings/search/live

ID: `BusinessListingsSearchLive`
用途: ‌‌ Business Listings Search API provides results containing information about business entities listed on Google Maps in the specified categories. You will receive the address, contacts, rating, working hours, and other relevant data. The provided results are specific to the selected location (see the List of Locations) settings.
中文补充: **POST `/v3/business_data/business_listings/search/live`**

请求体: `application/json`

请求字段:
- `[].categories` — array<string>，可选。business categories；optional field；the categories you specify are used to search for business listings;；if you don't use this field, we will return business listings found in the specified location;；you can specify up to 10 categories
- `[].description` — string，可选。description of the element in SERP；optional field；the description of the business entity for which the results are collected;；can contain up to 200 characters
- `[].title` — string，可选。title of the element in SERP；optional field；the name of the business entity for which the results are collected;；can contain up to 200 characters
- `[].is_claimed` — boolean，可选。indicates whether the business is verified by its owner on Google Maps；optional field
- `[].location_coordinate` — string，可选。GPS coordinates of a location；optional field；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the value of "radius" is specified in kilometres (km)；the minimum value for "radius": 1；the maximum value for "radius": 100000；example:；53.476225,-2.243572,200；learn more about how to set location parameters in this API on our Help Center
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, like, not_like, ilike, not_ilike, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["rating.value","&gt;",3]；you can receive the list of available filters_by making a separate request to https://api.seermartech.cn/v3/business_data/business_listings/available_filters；The full list of possible filters is available here.n
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting parameter；example:；["rating.value,desc"]note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["rating.value,desc","rating.votes_count,desc"]
- `[].limit` — integer，可选。the maximum number of returned businesses；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned businesses；optional field；default value: 0；if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities；Note: we recommend using this parameter only when retrieving up to 10,000 results；for retrieving over 10,000 results, use the offset_token instead
- `[].offset_token` — string，可选。token for subsequent requests；optional field；provided in the identical filed of the response to each request;；use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;；by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;；offset_token values are unique for each subsequent task；Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request；learn more about this parameter on our Help Center
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "categories": [
      "pizza_restaurant"
    ],
    "description": "pizza",
    "title": "pizza",
    "is_claimed": "true",
    "location_coordinate": "53.476225,-2.243572,10",
    "order_by": [
      "rating.value,desc"
    ],
    "filters": [
      [
        "rating.value",
        ">",
        "3"
      ]
    ],
    "limit": "3"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/business_data/errors

ID: `BusinessDataErrors`
用途: By calling this endpoint you will receive information about the Business Data API tasks that returned an error within the past 7 days.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].limit` — integer，可选。the maximum number of returned tasks that responded with an error；optional field；default value: 1000；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned tasks；optional field；default value: 0；if you specify the 10 value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks
- `[].filtered_function` — string，可选。return tasks with a certain function；use this field to obtain a list of tasks that returned an error filtered by a certain function；you can filter the results by the values you receive in the function fields of the API response；i.e., once you receive unfiltered results, you can call this API again to filter them by function ；example: hotel_searches/task_post, postback_url, pingback_url
- `[].datetime_from` — string，可选。start time for filtering results；optional field；allows filtering results by the datetime parameter within the range of the last 7 days;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2021-11-15 12:57:46 +00:00
- `[].datetime_to` — string，可选。finish time for filtering results；optional field；allows filtering results by the datetime parameter within the range of the last 7 days;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2021-11-15 13:57:46 +00:00

最小请求示例:

```json
[
  {
    "limit": "10"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/google/extended_reviews/task_get/{id}

ID: `GoogleExtendedReviewsTaskGet`
用途: The returned results are specific to the indicated local establishment name, search engine, location and language parameters. We emulate set location and search engine with the highest accuracy so that the results you receive will match the actual search results for the specified parameters at the time of task setting. You can always check the returned results accessing the check_url in the Incognito mode to make sure the received data is entirely relevant. Note that user preferences, search history, and other personalized search factors are ignored by our system and thus would not be reflected in the returned results.

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/business_data/google/extended_reviews/task_post

ID: `GoogleExtendedReviewsTaskPost`
用途: ‌‌ This endpoint provides results from the “Reviews” element of Google SERPs, including not only Google user reviews but also reviews from other reputable sources (e.g., TripAdvisor, Yelp, Trustpilot). The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) parameters.
中文补充: 本接口使用 **POST** 方法，通过以下路径创建 Google 扩展评价采集任务：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field if you don't specify cid or place_id；the keyword you specify should indicate the name of the local establishment;；you can specify up to 700 characters in the keyword filed;；all %## will be decoded (plus character ‘+’ will be decoded to a space character)；if you need to use the “%” character for your keyword, please specify it as “%25”;； ；if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, the charge per task will be multiplied by 5；Note: queries containing the ‘cache:’ parameter are not supported and will return a validation errorlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center articleNote: if you use this field, your account will be charged three times the standard rate for tasks involving the Google Reviews API
- `[].cid` — string，可选。<i>unique, google-defined id of the business entity</i>；required field if you don't specify keyword or place_id；example:；194604053573767737；learn more about the identifier in this help center articleNote: if you use this field, your account will be charged two times the standard rate for tasks involving the Google Reviews API
- `[].place_id` — string，可选。<i>identifier of the business entity in Google Maps</i>；required field if you don't specify keyword or cid；example:；GhIJQWDl0CIeQUARxks3icF8U8A；learn more about the identifier in this help center articleNote: if you use this field, your account will be charged two times the standard rate for tasks involving the Google Reviews API
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations with location_name by making a separate request to the https://api.seermartech.cn/v3/business_data/google/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name_or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations with location_code by making a separate request to the https://api.seermartech.cn/v3/business_data/google/locations；example:；2840n
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name_or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 199.9；example:；53.476225,-2.243572,200n
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages with language_name by making a separate request to the https://api.seermartech.cn/v3/business_data/google/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code_by making a separate request to the https://api.seermartech.cn/v3/business_data/google/languages；example:；enn
- `[].depth` — integer，可选。parsing depth；optional field；number of reviews in SERP；we strongly recommend setting the parsing depth in the multiples of twenty, because our systems processes twenty reviews in a row；default value: 20；maximum value: 1000Your account will be billed per each SERP containing up to 20 results; ；Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;；The cost can be calculated on the Pricing page.
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "location_name": "London,England,United Kingdom",
    "language_name": "english",
    "cid": "17626775537598922320"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/google/extended_reviews/tasks_ready

ID: `GoogleExtendedReviewsTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/business_data/google/hotel_info/live/advanced

ID: `GoogleHotelInfoLiveAdvanced`
用途: ‌‌ Google Hotel Info will provide you with structured data available for a specific hotel entity on the Google Hotels platform: such as service description, location details, rating, amenities, reviews, images, prices, and more.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].hotel_identifier` — string，可选。unique hotel identifier；required field；unique identifier of a hotel entity in Google search;；you can obtain the value by making a request to Advanced Google SERP API (enclosed in the hotels element of the response), or the Hotel Searches endpoint of Business Data API；example:；ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations with location_name by making a separate request to https://api.seermartech.cn/v3/business_data/google/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name_or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations with location_code by making a separate request to the https://api.seermartech.cn/v3/business_data/google/locations；example:；2840n
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name_or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude, longitude" format；the maximum number of decimal digits for "latitude" and "longitude": 7；Note: if the coordinates are used to set a location, the search will occur in the nearest settlement;；example:；53.476225,-2.243572n
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages with language_name by making a separate request to https://api.seermartech.cn/v3/business_data/google/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code_by making a separate request to https://api.seermartech.cn/v3/business_data/google/languages；example:；enn
- `[].check_in` — string，可选。check-in date；optional field；if you don't specify this field, tomorrow's date will be used by default;；the value must not be earlier than today's date；date format: "yyyy-mm-dd"；example:；"2019-01-15"
- `[].check_out` — string，可选。check-out date；optional field；if you don't specify this field, our system will apply the date of two days from now by default;；Note: the value cannot be less than or equal to check_in;；the range between check_in and check_out values cannot exceed 30 days；date format: "yyyy-mm-dd"；example:；"2019-01-15"
- `[].currency` — string，可选。currency；optional field；example:；"USD"
- `[].adults` — integer，可选。number of adults；optional field；if you don't specify this field, two adults will be used by default；example:；1
- `[].children` — array<string>，可选。number and age of children；optional field；if you don't specify this field, no children will be included in the search;set the following value if you want to include one 14-years-old child:；[14]；set the following value if you want to include one 13-years-old child and one 8-years-old child:；[13,8]
- `[].load_prices_by_dates` — boolean，可选。load hotel stay prices by dates；optional field；if you specify this parameter with true, the response will include the prices_by_dates array with hotel stay prices divided by dates；if you use this parameter, you will be charged double the base price for a request
- `[].prices_start_date` — string，可选。start date to load prices by dates；optional field；to use this parameter, you must specify load_prices_by_dates with true；if this parameter is not specified, the start date is set to check_in date；date format: yyyy-mm-dd；example:；2025-05-20
- `[].prices_end_date` — string，可选。end date to load prices by dates；optional field；to use this parameter, you must specify load_prices_by_dates with true；if this parameter is not specified, you will get prices by date for the month ；date format: yyyy-mm-dd；example:；2025-05-21
- `[].prices_date_range` — string，可选。predefined period for retrieving daily price data；optional field；to use this parameter, you must specify load_prices_by_dates with true；if the prices_start_date is not specified, the start date is set to check_in date；possible values: month, three_months, six_months, year；default value: month
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_name": "New York,New York,United States",
    "hotel_identifier": "CgoI-KWyzenM_MV3EAE"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/business_data/google/hotel_info/live/html

ID: `GoogleHotelInfoLiveHtml`
用途: ‌‌ Google Hotel Info will provide you with unstructured HTML data available for a specific hotel entity on the Google Hotels platform: such as service description, location details, rating, amenities, reviews, images, prices, and more.
中文补充: **POST** `/v3/business_data/google/hotel_info/live/html`

请求体: `application/json`

请求字段:
- `[].hotel_identifier` — string，可选。unique hotel identifier；required field；unique identifier of a hotel entity in Google search;；you can obtain the value by making a request to Advanced Google SERP API (enclosed in the hotels element of the response), or the Hotel Searches endpoint of Business Data API；example:；ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations with location_name by making a separate request to https://api.seermartech.cn/v3/business_data/google/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name_or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations with location_code by making a separate request to the https://api.seermartech.cn/v3/business_data/google/locations；example:；2840n
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name_or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude" format；the maximum number of decimal digits for "latitude" and "longitude": 7；Note: if the coordinates are used to set a location, the search will occur in the nearest settlement;；example:；53.476225,-2.243572n
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages with language_name by making a separate request to https://api.seermartech.cn/v3/business_data/google/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code_by making a separate request to https://api.seermartech.cn/v3/business_data/google/languages；example:；enn
- `[].check_in` — string，可选。check-in date；optional field；if you don't specify this field, tomorrow's date will be used by default;；date format: "yyyy-mm-dd"；example:；"2019-01-15"
- `[].check_out` — string，可选。check-out date；optional field；if you don't specify this field, our system will apply the date of two days from now by default;；date format: "yyyy-mm-dd"；example:；"2019-01-15"
- `[].currency` — string，可选。currency；optional field；example:；"USD"
- `[].adults` — integer，可选。number of adults；optional field；if you don't specify this field, two adults will be used by default；example:；1
- `[].children` — array<string>，可选。number and age of children；optional field；if you don't specify this field, no children will be included in the search;set the following value if you want to include one 14-years-old child:；[14]；set the following value if you want to include one 13-years-old child and one 8-years-old child:；[13,8]
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data array of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_name": "New York,New York,United States",
    "hotel_identifier": "ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/google/hotel_info/task_get/advanced/{id}

ID: `GoogleHotelInfoTaskGetAdvanced`

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/google/hotel_info/task_get/html/{id}

ID: `GoogleHotelInfoTaskGetHtml`

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 7 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/business_data/google/hotel_info/task_post

ID: `GoogleHotelInfoTaskPost`
用途: ‌‌ Google Hotel Info will provide you with structured data available for a specific hotel entity on the Google Hotels platform: such as service description, location details, rating, amenities, reviews, images, prices, and more.
中文补充: **POST** `https://api.seermartech.cn/v3/business_data/google/hotel_info/task_post`

请求体: `application/json`

请求字段:
- `[].hotel_identifier` — string，可选。unique hotel identifier；required field if you don't specify keyword；if you use this field, you don't need to specify keyword；unique identifier of a hotel entity in Google search;；you can obtain the value by making a request to Advanced Google SERP API (enclosed in the hotels_pack element of the response), or the Hotel Searches endpoint of Business Data API；example:；ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE
- `[].keyword` — string，可选。keyword；required field if you don't specify hotel_identifier；if you use this field, you don't need to specify hotel_identifier；the keyword you specify should indicate the name of the hotel entity；you can specify up to 700 characters in the keyword filed；all %## will be decoded (plus character ‘+’ will be decoded to a space character)；if you need to use the “%” character for your keyword, please specify it as “%25”
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations with location_name by making a separate request to https://api.seermartech.cn/v3/business_data/google/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name_or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations with location_code by making a separate request to the https://api.seermartech.cn/v3/business_data/google/locations；example:；2840n
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name_or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude" format；the maximum number of decimal digits for "latitude" and "longitude": 7；Note: if the coordinates are used to set a location, the search will occur in the nearest settlement;；example:；53.476225,-2.243572n
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages with language_name by making a separate request to https://api.seermartech.cn/v3/business_data/google/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code_by making a separate request to https://api.seermartech.cn/v3/business_data/google/languages；example:；enn
- `[].check_in` — string，可选。check-in date；optional field；if you don't specify this field, tomorrow's date will be used by default;；the value must not be earlier than today's date；date format: "yyyy-mm-dd"；example:；"2019-01-15"
- `[].check_out` — string，可选。check-out date；optional field；if you don't specify this field, our system will apply the date of two days from now by default;；Note: the value cannot be less than or equal to check_in;；the range between check_in and check_out values cannot exceed 30 days；date format: "yyyy-mm-dd"；example:；"2019-01-15"
- `[].currency` — string，可选。currency；optional field；example:；"USD"
- `[].adults` — integer，可选。number of adults；optional field；if you don't specify this field, two adults will be used by default；example:；1
- `[].children` — array<string>，可选。number and age of children；optional field；if you don't specify this field, no children will be included in the search;set the following value if you want to include one 14-years-old child:；[14]；set the following value if you want to include one 13-years-old child and one 8-years-old child:；[13,8]
- `[].load_prices_by_dates` — boolean，可选。load hotel stay prices by dates；optional field；if you specify this parameter with true, the response will include the prices_by_dates array with hotel stay prices divided by dates；if you use this parameter, you will be charged double the base price for a request
- `[].prices_start_date` — string，可选。start date to load prices by dates；optional field；to use this parameter, you must specify load_prices_by_dates with true；if this parameter is not specified, the start date is set to check_in date；date format: yyyy-mm-dd；example:；2025-05-20
- `[].prices_end_date` — string，可选。end date to load prices by dates；optional field；to use this parameter, you must specify load_prices_by_dates with true；if this parameter is not specified, you will get prices by date for the month ；date format: yyyy-mm-dd；example:；2025-05-21
- `[].prices_date_range` — string，可选。predefined period for retrieving daily price data；optional field；to use this parameter, you must specify load_prices_by_dates with true；if the prices_start_date is not specified, the start date is set to check_in date；possible values: month, three_months, six_months, year；default value: month
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255;；you can use this parameter to identify the task and match it with the result;；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified;；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request;；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatype；required field if you specify postback_url；corresponds to the datatype that will be sent to your server；possible values:；advanced, html
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified;；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable;；we will set the necessary values before sending the request;；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_name": "New York,New York,United States",
    "hotel_identifier": "ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE",
    "tag": "some_string_123",
    "postback_url": "https://your-server.com/postbackscript.php",
    "postback_data": "advanced"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/google/hotel_info/tasks_ready

ID: `GoogleHotelInfoTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/business_data/google/hotel_searches/live

ID: `GoogleHotelSearchesLive`
用途: ‌‌ Hotel Searches API provides results containing information about different hotels listed on Google Hotels. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
中文补充: **POST** `https://api.seermartech.cn/v3/business_data/google/hotel_searches/live`

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；optional field；the keyword you specify is used to search for the list of hotels;；if you don't use this field, we will return the list of hotels found in a specified location;；you can specify up to 700 characters in the keyword filed；all %## will be decoded (plus character ‘+’ will be decoded to a space character)；if you need to use the “%” character for your keyword, please specify it as “%25”; ；Note: in order to obtain accurate search results, the location name is appended to the keyword automaticallylearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations with location_name by making a separate request to https://api.seermartech.cn/v3/business_data/google/locations；example:；London,England,United Kingdom；Note: in order to obtain accurate search results, the location_name you specify will be automatically appended to the keyword
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name_or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations with location_code by making a separate request to the https://api.seermartech.cn/v3/business_data/google/locations；example:；2840n
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name_or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude" format；the maximum number of decimal digits for "latitude" and "longitude": 7；Note: if the coordinates are used to set a location, the search will occur in the nearest settlement；example:；53.476225,-2.243572n
- `[].search_this_area` — boolean，可选。show hotels from the displayed area；optional field；can take the values: true, false；default value: true；if set to false the search_this_area mode will be turned off；Note: if the search_this_area mode is turned off, the location_name won't be appended to the keyword during search；learn more about this parameter on our Help Center
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages with language_name by making a separate request to https://api.seermartech.cn/v3/business_data/google/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code_by making a separate request to https://api.seermartech.cn/v3/business_data/google/languages；example:；enn
- `[].depth` — integer，可选。parsing depth；optional field；number of results in Google Hotels；default value: 18 organic results；max value: 140；Note: your account will be billed per each 18 organic results regardless of paid listings in the response;；thus, setting a depth above 18 may result in additional charges if Google Hotels return more than 18 results;；if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance
- `[].check_in` — string，可选。check-in date；optional field；if you don't specify this field, tomorrow's date will be used by default;；date format: "yyyy-mm-dd"；example:；"2019-01-15"；Note: the value cannot precede the today's date
- `[].check_out` — string，可选。check-out date；optional field；if you don't specify this field, our system will apply the date of two days from now by default;；date format: "yyyy-mm-dd"；example:；"2019-01-15"；Note: the value cannot be less than or equal to check_in;；the range between check_in and check_out values cannot exceed 30 days
- `[].currency` — string，可选。currency；optional field；example:；"USD"
- `[].adults` — integer，可选。number of adults；optional field；if you don't specify this field, the default value of 2 will be applied;；note that you can specify up to 6 persons including both adults and children；example:；1
- `[].children` — array<string>，可选。number and age of children；optional field；if you don't specify this field, no children will be included in the search;；age of child can be from 0 to 17;；note that you can specify up to 6 persons including both adults and children；set the following value if you want to include one 14-year-old child:；[14]；set the following value if you want to include one 13-year-old child and one 8-year-old child:；[13,8]
- `[].stars` — array<string>，可选。hotel stars；optional field；set this field to [5] if you want to get the list of 5-star hotels only；example:；[3,4,5]
- `[].min_rating` — number，可选。minimum rating；optional field；you can use this field to specify guest rating higher than a certain value；example:；2.5
- `[].sort_by` — string，可选。results sorting parameters；optional field；you can use this field to sort the results；possible types of sorting:；relevance – sort by most relevant；lowest_price – sort by the lowest price；highest_rating – sort by highest rating；most_reviewed – sort by most reviewed；default value: relevance
- `[].min_price` — integer，可选。minimum price per night；optional field；the currency of this value depends on the currency field；example:；100
- `[].max_price` — integer，可选。maximum price per night；optional field；the currency of this value depends on the currency field；example:；600
- `[].free_cancellation` — boolean，可选。hotels with a free cancellation；optional field；set this field to true if you want to get the list of hotels with free cancellation of reservations；default value: false
- `[].is_vacation_rentals` — boolean，可选。search for vacation rentals；optional field；set this field to true if you want to get the list of vacation rentals instead of hotels；default value: false
- `[].amenities` — array<string>，可选。hotel amenities；optional field；you can use this field to specify different hotel amenities；example:； [； "free_parking",； "pets_allowed"； ]；；possible values:；`"air_conditioning",；"all_inclusive_available",；"bar",；"free_breakfast",；"fitness_center",；"kid_friendly",；"free_parking",；"pets_allowed",；"pool",；"restaurant",；"room_service",；"spa",；"free_wifi",；"parking",；"indoor_pool",；"outdoor_pool",；"wheelchair_accessible",；"beach_access"`
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_name": "New York,New York,United States",
    "keyword": "cheap hotel",
    "check_in": "2023-06-01",
    "check_out": "2023-06-30",
    "currency": "USD",
    "adults": "2",
    "children": [
      "14"
    ],
    "sort_by": "highest_rating",
    "priority": "2",
    "tag": "example"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/google/hotel_searches/task_get/{id}

ID: `GoogleHotelSearchesTaskGet`

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/business_data/google/hotel_searches/task_post

ID: `GoogleHotelSearchesTaskPost`
用途: ‌‌ Hotel Searches API provides results containing information about different hotels listed on Google. The provided results are specific to the keyword, selected location (see the List of Locations) and language (see the List of Languages) settings.
中文补充: 本接口使用 **POST** 方法创建 Google店搜索任务：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；optional field；the keyword you specify is used to search for the list of hotels;；if you don't use this field, we will return the list of hotels found in a specified location;；you can specify up to 700 characters in the keyword filed；all %## will be decoded (plus character ‘+’ will be decoded to a space character)；if you need to use the “%” character for your keyword, please specify it as “%25”; ；Note: in order to obtain accurate search results, the location name is appended to the keyword automaticallylearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations with location_name by making a separate request to https://api.seermartech.cn/v3/business_data/google/locations；example:；London,England,United Kingdom；Note: in order to obtain accurate search results, the location_name you specify will be automatically appended to the keyword
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name_or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations with location_code by making a separate request to the https://api.seermartech.cn/v3/business_data/google/locations；example:；2840n
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name_or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude" format；the maximum number of decimal digits for "latitude" and "longitude": 7；Note: if the coordinates are used to set a location, the search will occur in the nearest settlement;；example:；53.476225,-2.243572
- `[].search_this_area` — boolean，可选。show hotels from the displayed area；optional field；can take the values: true, false；default value: true；if set to false the search_this_area mode will be turned off；Note: if the search_this_area mode is turned off, the location_name won't be appended to the keyword during search；learn more about this parameter on our Help Center
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages with language_name by making a separate request to https://api.seermartech.cn/v3/business_data/google/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code_by making a separate request to https://api.seermartech.cn/v3/business_data/google/languages；example:；en
- `[].depth` — integer，可选。parsing depth；optional field；number of results in Google Hotels；default value: 18 organic results；max value: 140；Note: your account will be billed per each 18 organic results regardless of paid listings in the response;；thus, setting a depth above 18 may result in additional charges if Google Hotels return more than 18 results;；if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance
- `[].check_in` — string，可选。check-in date；optional field；if you don't specify this field, tomorrow's date will be used by default;；date format: "yyyy-mm-dd"；example:；"2019-01-15"；Note: the value cannot precede the today's date
- `[].check_out` — string，可选。check-out date；optional field；if you don't specify this field, our system will apply the date of two days from now by default;；date format: "yyyy-mm-dd"；example:；"2019-01-15"；Note: the value cannot be less than or equal to check_in;；the range between check_in and check_out values cannot exceed 30 days
- `[].currency` — string，可选。currency；optional field；example:；"USD"
- `[].adults` — integer，可选。number of adults；optional field；if you don't specify this field, the default value of 2 will be applied;；note that you can specify up to 6 persons including both adults and children；example:；1
- `[].children` — array<string>，可选。number and age of children；optional field；if you don't specify this field, no children will be included in the search;；age of child can be from 0 to 17;；note that you can specify up to 6 persons including both adults and children；set the following value if you want to include one 14-year-old child:；[14]；set the following value if you want to include one 13-year-old child and one 8-year-old child:；[13,8]
- `[].stars` — array<string>，可选。hotel stars；optional field；set this field to [5] if you want to get the list of 5-star hotels only；example:；[3,4,5]
- `[].min_rating` — number，可选。minimum rating；optional field；you can use this field to specify guest rating higher than a certain value；example:；2.5
- `[].sort_by` — string，可选。results sorting parameters；optional field；you can use this field to sort the results；possible types of sorting:；relevance – sort by most relevant；lowest_price – sort by the lowest price；highest_rating – sort by highest rating；most_reviewed – sort by most reviewed；default value: relevance
- `[].min_price` — integer，可选。minimum price per night；optional field；the currency of this value depends on the currency field；example:；100
- `[].max_price` — integer，可选。maximum price per night；optional field；the currency of this value depends on the currency field；example:；600
- `[].free_cancellation` — boolean，可选。hotels with a free cancellation；optional field；set this field to true if you want to get the list of hotels with free cancellation of reservations；default value: false
- `[].is_vacation_rentals` — boolean，可选。search for vacation rentals；optional field；set this field to true if you want to get the list of vacation rentals instead of hotels；default value: false
- `[].amenities` — array<string>，可选。hotel amenities；optional field；you can use this field to specify different hotel amenities；example:； [； "free_parking",； "pets_allowed"； ]；；possible values:；"air_conditioning",；"all_inclusive_available",；"bar",；"free_breakfast",；"fitness_center",；"kid_friendly",；"free_parking",；"pets_allowed",；"pool",；"restaurant",；"room_service",；"spa",；"free_wifi",；"parking",；"indoor_pool",；"outdoor_pool",；"wheelchair_accessible",；"beach_access"
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_name": "New York,New York,United States",
    "keyword": "cheap hotel",
    "check_in": "2023-06-01",
    "check_out": "2023-06-30",
    "currency": "USD",
    "adults": "2",
    "children": [
      "14"
    ],
    "sort_by": "highest_rating",
    "priority": "2",
    "tag": "example"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/google/hotel_searches/tasks_ready

ID: `GoogleHotelSearchesTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
中文补充: 本接口使用 **GET** 方法，路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/google/languages

ID: `BusinessDataGoogleLanguages`
用途: You will receive the list of languages by calling this API.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/google/locations

ID: `BusinessDataGoogleLocations`
用途: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
中文补充: 本接口提供 Google 商业数据 API 支持的地点列表。

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/google/locations/{country}

ID: `BusinessDataGoogleLocationsCountry`
用途: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.

路径与查询参数:
- `country` — path，string，必填。country ISO code；optional field；specify the ISO code if you want to filter the list of locations by country；example:；us

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/business_data/google/my_business_info/live

ID: `GoogleMyBusinessInfoLive`
用途: ‌‌ Business Data API provides results containing information about specific business entity from Google. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；the keyword you specify should indicate the name of the local establishment；you can specify up to 700 characters in the keyword filed；all %## will be decoded (plus character ‘+’ will be decoded to a space character)；if you need to use the “%” character for your keyword, please specify it as “%25”; this field can also be used to pass the following parameters:；cid - a unique, google-defined id of the business entity;；place_id - an identifier of the business entity in Google Maps;example:；cid:194604053573767737；place_id:GhIJQWDl0CIeQUARxks3icF8U8Alearn more about the cid and place_id identifiers in this help center articlelearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations with location_name by making a separate request to https://api.seermartech.cn/v3/business_data/google/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name_or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations with location_code by making a separate request to the https://api.seermartech.cn/v3/business_data/google/locations；example:；2840n
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name_or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 199.9 (mm)；the maximum value for "radius": 199999 (mm)；example:；53.476225,-2.243572,200n
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages with language_name by making a separate request to https://api.seermartech.cn/v3/business_data/google/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code_by making a separate request to https://api.seermartech.cn/v3/business_data/google/languages；example:；enn
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_name": "New York,New York,United States",
    "keyword": "RustyBrick, Inc."
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/google/my_business_info/task_get/{id}

ID: `GoogleMyBusinessInfoTaskGet`

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/business_data/google/my_business_info/task_post

ID: `GoogleMyBusinessInfoTaskPost`
用途: ‌‌ Business Data API provides results containing information about specific business entity from Google. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
中文补充: 本接口用于提交 Google 商家信息查询任务，获取指定本地商家实体的详细信息。查询结果受所选地理位置和语言影响。

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；the keyword you specify should indicate the name of the local establishment；you can specify up to 700 characters in the keyword filed；all %## will be decoded (plus character ‘+’ will be decoded to a space character)；if you need to use the “%” character for your keyword, please specify it as “%25”; this field can also be used to pass the following parameters:；cid - a unique, google-defined id of the business entity;；place_id - an identifier of the business entity in Google Maps;example:；cid:194604053573767737；place_id:GhIJQWDl0CIeQUARxks3icF8U8Alearn more about the cid and place_id identifiers in this help center articlelearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations with location_name by making a separate request to https://api.seermartech.cn/v3/business_data/google/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name_or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations with location_code by making a separate request to the https://api.seermartech.cn/v3/business_data/google/locations；example:；2840n
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name_or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 199.9 (mm)；the maximum value for "radius": 199999 (mm)；example:；53.476225,-2.243572,200n
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages with language_name by making a separate request to https://api.seermartech.cn/v3/business_data/google/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code_by making a separate request to https://api.seermartech.cn/v3/business_data/google/languages；example:；enn
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_name": "New York,New York,United States",
    "keyword": "RustyBrick, Inc."
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/google/my_business_info/tasks_ready

ID: `GoogleMyBusinessInfoTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
中文补充: 本接口使用 **GET** 方法，路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/google/my_business_updates/task_get/{id}

ID: `GoogleMyBusinessUpdatesTaskGet`

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/business_data/google/my_business_updates/task_post

ID: `GoogleMyBusinessUpdatesTaskPost`
用途: ‌‌ This endpoints provides the latest updates of a specific business entity from Google SERP. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；the keyword you specify should indicate the name of the local establishment；you can specify up to 700 characters in the keyword filed；all %## will be decoded (plus character ‘+’ will be decoded to a space character)；if you need to use the “%” character for your keyword, please specify it as “%25”;this field can also be used to pass cid (unique, google-defined id of the business entity) or place_id (identifier of the business entity in Google Maps) parameters；example:；cid:194604053573767737；place_id:GhIJQWDl0CIeQUARxks3icF8U8Alearn more about the cid and place_id identifiers in this help center article
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations with location_name by making a separate request to the https://api.seermartech.cn/v3/business_data/google/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name_or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations with location_code by making a separate request to the https://api.seermartech.cn/v3/business_data/google/locations；example:；2840n
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name_or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 199.9；example:；53.476225,-2.243572,200n
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages with language_name by making a separate request to the https://api.seermartech.cn/v3/business_data/google/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code_by making a separate request to the https://api.seermartech.cn/v3/business_data/google/languages；example:；enn
- `[].depth` — integer，可选。parsing depth；optional field；number of updates in SERP；we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten updates in a row；please note that Google returns 4490 updates maximum；default value: 10
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_name": "New York,New York,United States",
    "keyword": "RustyBrick, Inc."
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/google/my_business_updates/tasks_ready

ID: `GoogleMyBusinessUpdatesTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/business_data/google/questions_and_answers/live

ID: `GoogleQuestionsAndAnswersLive`
用途: ‌‌ This endpoint will provide you with a detailed overview of questions and answers associated with a specific business entity listed on Google My Business. By submitting a request to this endpoint, you can access comprehensive data on the inquiries and responses related to a particular business, including the full text of the questions and answers, as well as metadata such as timestamps, user information. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. Your account will be billed for every 20 questions, the maximum number of answers returned for each question is 5.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；the keyword you specify should indicate the name of the local establishment；you can specify up to 700 characters in the keyword filed；all %## will be decoded (plus character ‘+’ will be decoded to a space character)；if you need to use the “%” character for your keyword, please specify it as “%25”; this field can also be used to pass the following parameters:；cid - a unique, google-defined id of the business entity;；place_id - an identifier of the business entity in Google Maps;example:；cid:194604053573767737；place_id:GhIJQWDl0CIeQUARxks3icF8U8Alearn more about the cid and place_id identifiers in this help center articlelearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations with location_name by making a separate request to https://api.seermartech.cn/v3/business_data/google/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name_or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations with location_code by making a separate request to the https://api.seermartech.cn/v3/business_data/google/locations；example:；2840n
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name_or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 199.9 (mm)；the maximum value for "radius": 199999 (mm)；example:；53.476225,-2.243572,200n
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages with language_name by making a separate request to https://api.seermartech.cn/v3/business_data/google/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code_by making a separate request to https://api.seermartech.cn/v3/business_data/google/languages；example:；enn
- `[].depth` — integer，可选。parsing depth；optional field；number of results in SERP；default value: 20；max value: 100；Your account will be billed per each SERP containing up to 20 results; ；Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;；If the specified depth is higher than the number of questions in the response, the difference will be refunded automatically to your account balance;；The cost can be calculated on the Pricing page.
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_name": "Los Angeles,California,United States",
    "keyword": "The Last Bookstore"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/google/questions_and_answers/task_get/{id}

ID: `GoogleQuestionsAndAnswersTaskGet`

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/business_data/google/questions_and_answers/task_post

ID: `GoogleQuestionsAndAnswersTaskPost`
用途: ‌‌ This endpoint will provide you with a detailed overview of questions and answers associated with a specific business entity listed on Google My Business. By submitting a request to this endpoint, you can access comprehensive data on the inquiries and responses related to a particular business, including the full text of the questions and answers, as well as metadata such as timestamps, user information. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. Your account will be billed for every 20 questions, the maximum number of answers returned for each question is 5.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；the keyword you specify should indicate the name of the local establishment；you can specify up to 700 characters in the keyword filed；all %## will be decoded (plus character ‘+’ will be decoded to a space character)；if you need to use the “%” character for your keyword, please specify it as “%25”; this field can also be used to pass the following parameters:；cid - a unique, google-defined id of the business entity;；place_id - an identifier of the business entity in Google Maps;example:；cid:194604053573767737；place_id:GhIJQWDl0CIeQUARxks3icF8U8Alearn more about the cid and place_id identifiers in this help center articlelearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations with location_name by making a separate request to https://api.seermartech.cn/v3/business_data/google/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name_or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations with location_code by making a separate request to the https://api.seermartech.cn/v3/business_data/google/locations；example:；2840n
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name_or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 199.9 (mm)；the maximum value for "radius": 199999 (mm)；example:；53.476225,-2.243572,200n
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages with language_name by making a separate request to https://api.seermartech.cn/v3/business_data/google/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code_by making a separate request to https://api.seermartech.cn/v3/business_data/google/languages；example:；enn
- `[].depth` — integer，可选。parsing depth；optional field；number of question rows in the result；default value: 20；max value: 700；Your account will be billed per each SERP containing up to 20 results; ；Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;；If the specified depth is higher than the number of questions in the response, the difference will be refunded automatically to your account balance;；The cost can be calculated on the Pricing page.
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded; ；i.a., the # character will be encoded into %23；learn more on our Help Center

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_name": "Los Angeles,California,United States",
    "keyword": "The Last Bookstore"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/google/questions_and_answers/tasks_ready

ID: `GoogleQuestionsAndAnswersTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
中文补充: 本接口用于获取尚未领取结果的 Google 商家问答已完成任务列表。

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/google/reviews/task_get/{id}

ID: `GoogleReviewsTaskGet`
用途: The returned results are specific to the indicated local establishment name, search engine, location and language parameters. We emulate set location and search engine with the highest accuracy so that the results you receive will match the actual search results for the specified parameters at the time of task setting. You can always check the returned results accessing the check_url in the Incognito mode to make sure the received data is entirely relevant. Note that user preferences, search history, and other personalized search factors are ignored by our system and thus would not be reflected in the returned results.

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/business_data/google/reviews/task_post

ID: `GoogleReviewsTaskPost`
用途: ‌‌ This endpoint provides results from the “Reviews” element of Google SERPs. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) parameters.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field if you don't specify cid or place_id；the keyword you specify should indicate the name of the local establishment;；you can specify up to 700 characters in the keyword filed;；all %## will be decoded (plus character ‘+’ will be decoded to a space character)；if you need to use the “%” character for your keyword, please specify it as “%25”;； ；if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, the charge per task will be multiplied by 5；Note: queries containing the ‘cache:’ parameter are not supported and will return a validation errorlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].cid` — string，可选。<i>unique, google-defined id of the business entity</i>；required field if you don't specify keyword or place_id；example:；194604053573767737；learn more about the identifier in this help center article
- `[].place_id` — string，可选。<i>identifier of the business entity in Google Maps</i>；required field if you don't specify keyword or cid；example:；GhIJQWDl0CIeQUARxks3icF8U8A；learn more about the identifier in this help center article
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations with location_name by making a separate request to the https://api.seermartech.cn/v3/business_data/google/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name_or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations with location_code by making a separate request to the https://api.seermartech.cn/v3/business_data/google/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name_or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 199.9；example:；53.476225,-2.243572,200
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages with language_name by making a separate request to the https://api.seermartech.cn/v3/business_data/google/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code_by making a separate request to the https://api.seermartech.cn/v3/business_data/google/languages；example:；en
- `[].depth` — integer，可选。parsing depth；optional field；number of reviews in SERP；we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row；default value: 10；maximum value: 4490；Your account will be billed per each SERP containing up to 10 results; ；Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;；The cost can be calculated on the Pricing page.
- `[].sort_by` — string，可选。results sorting parameters；optional field；you can use this field to sort the results；possible types of sorting:；newest – sort by newest first；highest_rating – sort by highest rating；lowest_rating – sort by lowest rating；relevant – sort by relevance；default value: relevant
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "location_name": "London,England,United Kingdom",
    "language_name": "English",
    "keyword": "hedonism wines",
    "depth": "50",
    "sort_by": "highest_rating"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/google/reviews/tasks_ready

ID: `GoogleReviewsTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
中文补充: 本接口使用 **GET** 方法和以下路径：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/business_data/id_list

ID: `BusinessDataIdList`
用途: This endpoint is designed to provide you with a list of IDs and metadata for all Business Data tasks created within the specified time period, including both successful and uncompleted tasks.
中文补充: 本接口通过 **POST** 方法调用：`/v3/business_data/id_list`。用于按指定时间范围获取本平台已创建的 Business Data 任务 ID 及数据，结果已完成和未完成的任务。

请求体: `application/json`

请求字段:
- `[].datetime_from` — string，可选。start time for filtering results；required field；if include_metadata is set to true, maximum value: a month from current datetime;；if include_metadata is set to false, maximum value: six months from current datetime;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2023-01-15 12:57:46 +00:00
- `[].datetime_to` — string，可选。finish time for filtering results；required field；maximum value: current datetime;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2023-01-31 13:57:46 +00:00
- `[].limit` — integer，可选。the maximum number of returned task IDs；optional field；default value: 1000；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned task IDs；optional field；default value: 0；if you specify the 10 value, the first ten tasks in the results array will be omitted
- `[].sort` — string，可选。sorting by task execution time；optional field；possible values: "asc", "desc"；default value: "asc"
- `[].include_metadata` — boolean，可选。include task metadata in the respond；optional field；default value: false

最小请求示例:

```json
[
  {
    "datetime_from": "2026-08-01 17:42:44",
    "datetime_to": "2026-08-11 17:42:44",
    "limit": "10",
    "include_metadata": "true"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/business_data/social_media/pinterest/live

ID: `SocialMediaPinterestLive`
用途: ‌‌ Social Media Pinterest API will provide you with data on pins made from the specified URLs. Pins on Pinterest correspond to content saves. For each specified page URL, you will get the number of content saves to Pinterest made using the Pinterest Save Button placed on that page.
中文补充: **POST** `/v3/business_data/social_media/pinterest/live`

请求体: `application/json`

请求字段:
- `[].targets` — array<string>，可选。target URLs；required field；target page should be specified with its absolute URL (including http:// or https://)；example:；https://dataforseo.com/Note: you can specify 10 targets maximum. You will be charged per earch URL you specify in this array
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "targets": [
      "https://www.simplyrecipes.com/recipes/grilled_salmon_with_cucumber_mango_salsa/",
      "https://tasty.co/recipe/classic-lasagna",
      "https://www.allrecipes.com/recipe/255263/sicilian-roasted-chicken/"
    ],
    "tag": "some_string_123"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/tasks_ready

ID: `BusinessDataTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/tripadvisor/languages

ID: `TripadvisorLanguages`
用途: You will receive the list of languages by calling this API.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/tripadvisor/locations

ID: `TripadvisorLocations`
用途: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task. Note that supported location types in Tripadvisor Business Data API are City and Region only.
中文补充: 本接口用于获取 Tripadvisor 商业数据支持的位置列表。支持按国家/地区 ISO 代码筛选位置。当前支持 `City`（城市）和 `Region`（地区）两种位置类型。

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/tripadvisor/locations/{country}

ID: `TripadvisorLocationsCountry`
用途: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task. Note that supported location types in Tripadvisor Business Data API are City and Region only.

路径与查询参数:
- `country` — path，string，必填。country ISO code；optional field；specify the ISO code if you want to filter the list of locations by country；example:；us

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/tripadvisor/reviews/task_get/{id}

ID: `TripadvisorReviewsTaskGet`
用途: This endpoint provides feedback data on businesses listed on the Tripadvisor platform, including their locations, ratings, review content and count. The results are specific to the URL path indicated in the POST request.

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/business_data/tripadvisor/reviews/task_post

ID: `TripadvisorReviewsTaskPost`
用途: ‌‌ This endpoint provides results from the “Reviews” element on the Tripadvisor platform. The results are specific to the URL path or keyword you indicate, and and the selected location (see the List of Locations).
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].url_path` — string，可选。URL path of the business entity；required field if you do not specify keyword；URL path to the Tripadvisor page of the business entity;；examples:；Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html；https://www.tripadvisor.com/Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html
- `[].keyword` — string，可选。keyword；required field if you do not specify url_path；the keyword you specify should indicate a name of an existing business or prominent place on Tripadvisor;；you can specify up to 700 characters in the keyword filed;；all %## will be decoded (plus character ‘+’ will be decoded to a space character);；if you need to use the “%” character for your keyword, please specify it as “%25”
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or url_path；you can receive the list of available locations with location_name by making a separate request to the https://api.seermartech.cn/v3/business_data/tripadvisor/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name or url_path；you can receive the list of available locations with location_code by making a separate request to the https://api.seermartech.cn/v3/business_data/tripadvisor/locations；example:；1003854
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].language_name` — string，可选。full name of search engine language；optional field；if you use this field, your account will be charged for one extra request；you can receive the list of available languages with language_name by making a separate request to the https://api.seermartech.cn/v3/business_data/tripadvisor/languages；example:；English；You will be additionally charged for setting a language parameter in this endpoint.；The cost can be calculated on the Pricing page.
- `[].language_code` — string，可选。search engine language code；optional field；if you use this field, your account will be charged for one extra request；you can receive the list of available languages with language_code by making a separate request to the https://api.seermartech.cn/v3/business_data/tripadvisor/languages；example:；en；You will be additionally charged for setting a language parameter in this endpoint.；The cost can be calculated on the Pricing page.
- `[].depth` — integer，可选。parsing depth；optional field；number of reviews in SERP;；we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row;；default value: 10;；max value: 4490；Your account will be billed per each SERP containing up to 10 results; ；Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;；The cost can be calculated on the Pricing page.
- `[].ratings` — array<string>，可选。Tripadvisor traveler rating for a place of interest；optional field；rating based on the written reviews by a traveler after they visited a place.；possible values: excellent, very_good, average, poor, terrible；you can specify several values at once
- `[].visit_type` — array<string>，可选。filter by type of travelers who left a review；optional field；possible values: families, couples, solo, business, friends；you can specify several values at once
- `[].months` — array<string>，可选。filter by months when a traveler made a visit；optional field；possible values: january, february, march, april, may, april, june, july, august, september, october, november, december；you can specify several values at once
- `[].sort_by` — string，可选。results sorting parameters；optional field；you can use this field to sort the results;；possible types of sorting:；most_recent；detailed_reviews
- `[].translate_reviews` — boolean，可选。translate reviews according to the URL path；optional field；if set to true, returned reviews will be translated to the language matching the specified url_path;；for example, if url_path contains tripadvisor.it and translate_reviews is true, reviews will be translated to the Italian language;；default value: true；you can learn more about how reviews are translated in this Help Center article
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "url_path": "Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html",
    "location_code": "1003854",
    "pingback_url": "https://your-server.com/pingback.php?id=$id&tag=$tag",
    "tag": "some_string_123"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/tripadvisor/reviews/tasks_ready

ID: `TripadvisorReviewsTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
中文补充: 本接口使用 **GET** 方法，路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/tripadvisor/search/task_get/{id}

ID: `TripadvisorSearchTaskGet`
用途: This endpoint will provide you with data on businesses listed on the Tripadvisor platform. The results obtained through this endpoint are specific to the location (see the List of Tripadvisor Locations) and keyword parameters used in the POST request.

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/business_data/tripadvisor/search/task_post

ID: `TripadvisorSearchTaskPost`
用途: ‌‌ This endpoint provides a list of business profiles listed on the Tripadvisor platform. The returned results are relevant to the specified keyword and the selected location (see the List of Locations).
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；the keyword you specify should indicate a business category, company name, or a prominent place;；you can specify up to 700 characters in the keyword filed;；all %## will be decoded (plus character ‘+’ will be decoded to a space character);；if you need to use the “%” character for your keyword, please specify it as “%25”learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code；you can receive the list of available locations with location_name by making a separate request to the https://api.seermartech.cn/v3/business_data/tripadvisor/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name；you can receive the list of available locations with location_code by making a separate request to the https://api.seermartech.cn/v3/business_data/tripadvisor/locations；example:；1003854
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].depth` — integer，可选。parsing depth；optional field；number of search results to be returned from the API response；we strongly recommend setting the parsing depth in the multiples of thirty because our systems processes thirty search results in a row;；default value: 30;；maximum value: 210Your account will be billed per each SERP containing up to 30 results; ；Setting depth above 30 may result in additional charges if the search engine returns more than 30 results;；The cost can be calculated on the Pricing page.
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "keyword": "pizza",
    "location_code": "1003854",
    "depth": "30"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/tripadvisor/search/tasks_ready

ID: `TripadvisorSearchTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
中文补充: 本接口使用 **GET** 方法，通过以下路径获取 Tripadvisor 搜索任务中已完成但尚未领取的任务：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/trustpilot/reviews/task_get/{id}

ID: `TrustpilotReviewsTaskGet`
用途: This endpoint provides reviews published on the Trustpilot platform The returned results are specific to the indicated business entity. We emulate set parameters with the highest accuracy so that the results you receive will match the actual search results for the specified parameters at the time of task setting. You can always check the returned results accessing the check_url in the Incognito mode to make sure the received data is entirely relevant. Note that user preferences, search history, and other personalized search factors are ignored by our system and thus would not be reflected in the returned results.

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/business_data/trustpilot/reviews/task_post

ID: `TrustpilotReviewsTaskPost`
用途: ‌‌ This endpoint provides reviews published on the Trustpilot platform for the local establishment specified in the domain field.
中文补充: 本接口用于创建 Trustpilot 商家评论采集任务，获取 `domain` 指定商家的评论数据。

请求体: `application/json`

请求字段:
- `[].domain` — string，可选。domain of the local establishment；required field；domain of the local establishment on Trustpilot;；you can find the domain in the URL of every business listed on Trustpilot；example:；www.thepearlsource.com；https://www.trustpilot.com/review/www.thepearlsource.com
- `[].sort_by` — string，可选。results sorting parameter；optional field；you can use this field to sort the results;；possible sorting parameters:；recency — most recent reviews first;；relevance — most relevant reviews first;；default value: relevance
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].depth` — integer，可选。parsing depth；optional field；number of reviews to be returned from the API response；we strongly recommend setting the parsing depth in the multiples of twenty, because our system processes twenty reviews in a row；default value: 20；maximum value: 200；Your account will be billed per each SERP containing up to 20 results; ；Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;；The cost can be calculated on the Pricing page.
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "domain": "www.thepearlsource.com",
    "depth": "40"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/trustpilot/reviews/tasks_ready

ID: `TrustpilotReviewsTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
中文补充: 本接口使用 **GET** 方法和以下路径：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/trustpilot/search/task_get/{id}

ID: `TrustpilotSearchTaskGet`
用途: This endpoint provides a list of business profiles listed on the Trustpilot platform. The returned results are relevant to the keyword specified in a POST request. We emulate set parameters with the highest accuracy so that the results you receive match the actual search results for the specified parameters at the time of task setting. You can always check the returned results accessing the check_url in the Incognito mode to make sure the received data is entirely relevant. Note that user preferences, search history, and other personalized search factors are ignored by our system and thus will not be reflected in the returned results.

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/business_data/trustpilot/search/task_post

ID: `TrustpilotSearchTaskPost`
用途: ‌‌ This endpoint provides a list of business profiles listed on the Trustpilot platform. The returned results are relevant to the specified keyword.
中文补充: 本接口使用 **POST** 方法提交 Trustpilot 商家搜索任务：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；the keyword you specify should indicate a business category or company name;；you can specify up to 700 characters in the keyword filed;；all %## will be decoded (plus character ‘+’ will be decoded to a space character);；if you need to use the “%” character for your keyword, please specify it as “%25”learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].depth` — integer，可选。parsing depth；optional field；number of search results to be returned from the API response；we strongly recommend setting the parsing depth in the multiples of twenty because our systems processes twenty search results in a row;；default value: 10;；maximum value: 140；Your account will be billed per each SERP containing up to 10 results; ；Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;；The cost can be calculated on the Pricing page.
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "keyword": "pizza restaurant",
    "depth": "20"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/business_data/trustpilot/search/tasks_ready

ID: `TrustpilotSearchTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
中文补充: **GET `/v3/business_data/trustpilot/search/tasks_ready`**

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/content_analysis/available_filters

ID: `ContentAnalysisAvailableFilters`
用途: ‌‌ Here you will find all the necessary information about filters that can be used with Content Analysis API endpoints.
中文补充: 本接口使用 **GET** 方法，路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/content_analysis/categories

ID: `ContentAnalysisCategories`
用途: We use Google product and service categories. This endpoint will provide you with the full list of available categories. You can also download the CSV file by this link.
中文补充: **GET `/v3/content_analysis/categories`**

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/content_analysis/category_trends/live

ID: `CategoryTrendsLive`
用途: ‌ This endpoint will provide you with data on all citations in the target category for the indicated date range.
中文补充: 本接口使用 **POST** 方法， API 路径为：

请求体: `application/json`

请求字段:
- `[].category_code` — integer，可选。target category code；required field；to obtain a full list of available categories, refer to the Categories endpoint
- `[].page_type` — array<string>，可选。target page types；optional field；use this parameter to filter the dataset by page types；possible values: ；"ecommerce", "news", "blogs", "message-boards", "organization"
- `[].search_mode` — string，可选。results grouping type；optional field；possible grouping types:；as_is - returns data on all citations for the target category_code；one_per_domain - returns data on one citation of the category_code per domain；default value: as_is
- `[].internal_list_limit` — integer，可选。maximum number of elements within internal arrays；optional field；you can use this field to limit the number of elements within the following arrays:；top_domains；text_categories；page_categories；countries；languages；default value: 1；maximum value: 20
- `[].date_from` — string，可选。starting date of the time range；required field；minimum value: 2022-10-31；date format: "yyyy-mm-dd"；example:；"2019-01-15"
- `[].date_to` — string，可选。ending date of the time range；optional field；if you don't specify this field, today's date will be used by default；date format: "yyyy-mm-dd"；example:；"2019-01-15"
- `[].date_group` — string，可选。time range which will be used to group the results；optional field；default value: month；possible values: day, week, month
- `[].initial_dataset_filters` — array<object>，可选。initial dataset filtering parameters；optional field；initial filtering parameters that apply to fields in the Search endpoint;；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, like,not_like, has, has_not, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["domain","&lt;&gt;", "logitech.com"][["domain","&lt;&gt;","logitech.com"],"and",["content_info.connotation_types.negative","&gt;",1000]][["domain","&lt;&gt","logitech.com"]],；"and",；[["content_info.connotation_types.negative","&gt;",1000],；"or",["content_info.text_category","has",10994]]]；for more information about filters, please refer to Content Analysis API - Filters；learn more about the initial dataset filters in this help center article.
- `[].rank_scale` — string，可选。defines the scale used for calculating and displaying the rank values；optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values:；one_hundred — rank values are displayed on a 0–100 scale；one_thousand — rank values are displayed on a 0–1000 scaledefault value: one_thousandlearn more about how this parameter works in this Help Center article
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "category_code": "10994",
    "search_mode": "as_is",
    "date_from": "2022-09-01",
    "date_group": "month"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/content_analysis/id_list

ID: `ContentAnalysisIdList`
用途: This endpoint is designed to provide you with a list of IDs and metadata for all Content Analysis tasks created within the specified time period, including both successful and uncompleted tasks.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].datetime_from` — string，可选。start time for filtering results；required field；if include_metadata is set to true, maximum value: a month from current datetime;；if include_metadata is set to false, maximum value: six months from current datetime;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2023-01-15 12:57:46 +00:00
- `[].datetime_to` — string，可选。finish time for filtering results；required field；maximum value: current datetime;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2023-01-31 13:57:46 +00:00
- `[].limit` — integer，可选。the maximum number of returned task IDs；optional field；default value: 1000；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned task IDs；optional field；default value: 0；if you specify the 10 value, the first ten tasks in the results array will be omitted
- `[].sort` — string，可选。sorting by task execution time；optional field；possible values: "asc", "desc"；default value: "asc"
- `[].include_metadata` — boolean，可选。include task metadata in the respond；optional field；default value: false

最小请求示例:

```json
[
  {
    "datetime_from": "2026-08-01 17:42:44",
    "datetime_to": "2026-08-11 17:42:44",
    "limit": "10",
    "include_metadata": "true"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/content_analysis/languages

ID: `Languages`
用途: You will receive the list of languages by calling this API. As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
中文补充: **GET `/v3/content_analysis/languages`**

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/content_analysis/locations

ID: `Locations`
用途: You will receive the list of locations by this API call.
中文补充: **GET `/v3/content_analysis/locations`**

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/content_analysis/phrase_trends/live

ID: `PhraseTrendsLive`
用途: ‌ This endpoint will provide you with data on all citations of the target keyword for the indicated date range.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。target keyword；required field；UTF-8 encoding；the keywords will be converted to a lowercase format;；Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; ；example: ；"keyword": "\"tesla palo alto\""learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].keyword_fields` — object，可选。target keyword fields and target keywords；optional field；use this parameter to filter the dataset by keywords that certain fields should contain;；fields you can specify: title, main_title, previous_title, snippet；you can indicate several fields;；Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; ；example:；`"keyword_fields": {；"snippet": "\"logitech mouse\"",；"main_title": "sale"；}`
- `[].page_type` — array<string>，可选。target page types；optional field；use this parameter to filter the dataset by page types；possible values: ；"ecommerce", "news", "blogs", "message-boards", "organization"
- `[].search_mode` — string，可选。results grouping type；optional field；possible grouping types:；as_is - returns data on all citations for the target keyword；one_per_domain - returns data on one citation of the keyword per domain；default value: as_is
- `[].internal_list_limit` — integer，可选。maximum number of elements within internal arrays；optional field；you can use this field to limit the number of elements within the following arrays:；top_domains；text_categories；page_categories；countries；languages；default value: 1；maximum value: 20
- `[].date_from` — string，可选。starting date of the time range；required field；date format: "yyyy-mm-dd"；example:；"2019-01-15"
- `[].date_to` — string，可选。ending date of the time range；optional field；if you don't specify this field, today's date will be used by default；date format: "yyyy-mm-dd"；example:；"2019-01-15"
- `[].date_group` — string，可选。time range which will be used to group the results；optional field；default value: month；possible values: day, week, month
- `[].initial_dataset_filters` — array<object>，可选。initial dataset filtering parameters；optional field；initial filtering parameters that apply to fields in the Search endpoint;；you can add several filters at once (8 filters maximum);；you should set a logical operator and, or between the conditions;；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, like,not_like, has, has_not, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters;；example:；["domain","&lt;&gt;", "logitech.com"][["domain","&lt;&gt;","logitech.com"],"and",["content_info.connotation_types.negative","&gt;",1000]][["domain","&lt;&gt","logitech.com"]],；"and",；[["content_info.connotation_types.negative","&gt;",1000],；"or",["content_info.text_category","has",10994]]]；for more information about filters, please refer to Content Analysis API - Filters；learn more about the initial dataset filters in this help center article.
- `[].rank_scale` — string，可选。defines the scale used for calculating and displaying the rank values；optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values:；one_hundred — rank values are displayed on a 0–100 scale；one_thousand — rank values are displayed on a 0–1000 scaledefault value: one_thousandlearn more about how this parameter works in this Help Center article
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "keyword": "logitech",
    "search_mode": "as_is",
    "date_from": "2022-09-01",
    "date_group": "month"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/content_analysis/rating_distribution/live

ID: `RatingDistributionLive`
用途: ‌ This endpoint will provide you with rating distribution data for the keyword and other parameters specified in the request.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。target keyword；required field；UTF-8 encoding；the keywords will be converted to a lowercase format;；Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; ；example: ；"keyword": "\"tesla palo alto\""learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].keyword_fields` — object，可选。target keyword fields and target keywords；optional field；use this parameter to filter the dataset by keywords that certain fields should contain;；fields you can specify: title, main_title, previous_title, snippet；you can indicate several fields;；Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; ；example:；`"keyword_fields": {；"snippet": "\"logitech mouse\"",；"main_title": "sale"；}`
- `[].page_type` — array<string>，可选。target page types；optional field；use this parameter to filter the dataset by page types；possible values: ；"ecommerce", "news", "blogs", "message-boards", "organization"
- `[].internal_list_limit` — integer，可选。maximum number of elements within internal arrays；optional field；you can use this field to limit the number of elements within the following arrays:；top_domains；text_categories；page_categories；countries；languages；default value: 1；maximum value: 20
- `[].search_mode` — string，可选。results grouping type；optional field；possible grouping types:；as_is - returns all citations for the target keyword；one_per_domain - returns one citation of the keyword per domain；default value: as_is
- `[].positive_connotation_threshold` — number，可选。positive connotation threshold；optional field；specified as the probability index threshold for positive sentiment related to the citation content；if you specify this field, connotation_types object in the response will only contain data on citations with positive sentiment probability more than or equal to the specified value；possible values: from 0 to 1；default value: 0.4
- `[].sentiments_connotation_threshold` — number，可选。sentiment connotation threshold；optional field；specified as the probability index threshold for sentiment connotations related to the citation content；if you specify this field, sentiment_connotations object in the response will only contain data on citations where the probability per each sentiment is more than or equal to the specified value；possible values: from 0 to 1；default value: 0.4
- `[].initial_dataset_filters` — array<object>，可选。initial dataset filtering parameters；optional field；initial filtering parameters that apply to fields in the Search endpoint；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, like,not_like, has, has_not, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["domain","&lt;&gt;", "logitech.com"][["domain","&lt;&gt;","logitech.com"],"and",["content_info.connotation_types.negative","&gt;",1000]][["domain","&lt;&gt","logitech.com"]],；"and",；[["content_info.connotation_types.negative","&gt;",1000],；"or",["content_info.text_category","has",10994]]]；for more information about filters, please refer to Content Analysis API - Filters；learn more about the initial dataset filters in this help center article.
- `[].rank_scale` — string，可选。defines the scale used for calculating and displaying the rank values；optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values:；one_hundred — rank values are displayed on a 0–100 scale；one_thousand — rank values are displayed on a 0–1000 scaledefault value: one_thousandlearn more about how this parameter works in this Help Center article
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "keyword": "logitech",
    "search_mode": "as_is",
    "internal_list_limit": "10"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/content_analysis/search/live

ID: `SearchLive`
用途: ‌ This endpoint will provide you with detailed citation data available for the target keyword.
中文补充: `POST /v3/content_analysis/search/live` 完整请求地址：`https://api.seermartech.cn/v3/content_analysis/search/live`

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。target keyword；required field；UTF-8 encoding；the keywords will be converted to a lowercase format;；Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; ；example: ；`"keyword": "\"tesla palo alto\""`learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].keyword_fields` — object，可选。target keyword fields and target keywords；optional field；use this parameter to filter the dataset by keywords that certain fields should contain;；fields you can specify: title, main_title, previous_title, snippet；you can indicate several fields;；Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; ；example:；`"keyword_fields": {；"snippet": "\"logitech mouse\"",；"main_title": "sale"；}"`
- `[].page_type` — array<string>，可选。target page types；optional field；use this parameter to filter the dataset by page types；possible values: ；"ecommerce", "news", "blogs", "message-boards", "organization"
- `[].search_mode` — string，可选。results grouping type；optional field；possible grouping types:；as_is - returns all citations for the target keyword；one_per_domain - returns one citation of the keyword per domain；default value: as_is
- `[].limit` — integer，可选。the maximum number of returned citations；optional field；default value: 100；maximum value: 1000
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, like,not_like, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["country","=", "US"][["domain_rank","&gt;",800],"and",["content_info.connotation_types.negative","&gt;",0.9]][["domain_rank","&gt;",800],；"and",；[["page_types","has","ecommerce"],；"or",["content_info.text_category","has",10994]]]；for more information about filters, please refer to Content Analysis API - Filters
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["content_info.sentiment_connotations.anger,desc"]；default rule:；["content_info.sentiment_connotations.anger,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["content_info.sentiment_connotations.anger,desc","keyword_data.keyword_info.cpc,desc"]
- `[].offset` — integer，可选。offset in the results array of returned citations；optional field；default value: 0；if you specify the 10 value, the first ten citations in the results array will be omitted and the data will be provided for the successive citations；Note: we recommend using this parameter only when retrieving up to 10,000 results；for retrieving over 10,000 results, use the offset_token instead.
- `[].offset_token` — string，可选。offset token for subsequent requests；optional field；provided in the identical field of the response to each request;；use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;；by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;；offset_token values are unique for each subsequent task ；Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task；learn more about this parameter on our Help Center
- `[].rank_scale` — string，可选。defines the scale used for calculating and displaying the domain_rank, and url_rank values；optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values:；one_hundred — rank values are displayed on a 0–100 scale；one_thousand — rank values are displayed on a 0–1000 scaledefault value: one_thousandlearn more about how this parameter works in this Help Center article
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "keyword_fields": {
      "snippet": "logitech"
    },
    "keyword": "logitech",
    "page_type": [
      "ecommerce",
      "news",
      "blogs",
      "message-boards",
      "organization"
    ],
    "search_mode": "as_is",
    "filters": [
      "main_domain",
      "=",
      "reviewfinder.ca"
    ],
    "order_by": [
      "content_info.sentiment_connotations.anger,desc"
    ],
    "limit": "10"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/content_analysis/sentiment_analysis/live

ID: `SentimentAnalysisLive`
用途: This endpoint will provide you with sentiment analysis data for the citations available for the target keyword. for more info please visit 'https://docs.dataforseo.com/v3/content_analysis/sentiment_analysis/live/?bash'
中文补充: 本接口用于分析目标引用的感分布感极性、绪类型、页面类型、国家/地区和语言等维度。

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。target keyword required field UTF-8 encoding the keywords will be converted to a lowercase format; Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; example: "keyword": "\"tesla palo alto\"" learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].keyword_fields` — object，可选。target keyword fields and target keywords optional field use this parameter to filter the dataset by keywords that certain fields should contain; fields you can specify: title, main_title, previous_title, snippet you can indicate several fields; Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; example: "keyword_fields": { "snippet": "\"logitech mouse\"", "main_title": "sale" }
- `[].page_type` — array<string>，可选。target page types optional field use this parameter to filter the dataset by page types possible values: "ecommerce", "news", "blogs", "message-boards", "organization"
- `[].internal_list_limit` — integer，可选。maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: top_domains text_categories page_categories countries languages default value: 1 maximum value: 20
- `[].positive_connotation_threshold` — number，可选。positive connotation threshold optional field specified as the probability index threshold for positive sentiment related to the citation content if you specify this field, connotation_types object in the response will only contain data on citations with positive sentiment probability more than or equal to the specified value possible values: from 0 to 1 default value: 0.4
- `[].sentiments_connotation_threshold` — number，可选。sentiment connotation threshold optional field specified as the probability index threshold for sentiment connotations related to the citation content if you specify this field, sentiment_connotations object in the response will only contain data on citations where the probability per each sentiment is more than or equal to the specified value possible values: from 0 to 1 default value: 0.4
- `[].initial_dataset_filters` — array<object>，可选。initial dataset filtering parameters optional field initial filtering parameters that apply to fields in the Search endpoint you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: ["domain","<>", "logitech.com"] [["domain","<>","logitech.com"],"and",["content_info.connotation_types.negative",">",1000]] [["domain","<>","logitech.com"]], "and", [["content_info.connotation_types.negative",">",1000], "or", ["content_info.text_category","has",10994]]] for more information about filters, please refer to Content Analysis API – Filters learn more about the initial dataset filters in this help center article.
- `[].rank_scale` — string，可选。defines the scale used for calculating and displaying the rank values optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: one_hundred — rank values are displayed on a 0–100 scale one_thousand — rank values are displayed on a 0–1000 scale default value: one_thousand learn more about how this parameter works in this Help Center article
- `[].tag` — string，可选。user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "keyword": "logitech",
    "internal_list_limit": "1"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/content_analysis/summary/live

ID: `ContentAnalysisSummaryLive`
用途: ‌ This endpoint will provide you with an overview of citation data available for the target keyword.
中文补充: 本接口通过 **POST `/v3/content_analysis/summary/live`** 获取目标的引用数据摘要引用来源域名、感倾向、文本类别、页面类别、页面类型、国家和语言分布等信息。

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。target keyword；required field；UTF-8 encoding；the keywords will be converted to a lowercase format;；Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; ；example: ；"keyword": "\"tesla palo alto\""learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].keyword_fields` — object，可选。target keyword fields and target keywords；optional field；use this parameter to filter the dataset by keywords that certain fields should contain;；fields you can specify: title, main_title, previous_title, snippet；you can indicate several fields;；Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; ；example:；"keyword_fields": {；"snippet": "\"logitech mouse\"",；"main_title": "sale"；}
- `[].page_type` — array<string>，可选。target page types；optional field；use this parameter to filter the dataset by page types；possible values: ；"ecommerce", "news", "blogs", "message-boards", "organization"
- `[].internal_list_limit` — integer，可选。maximum number of elements within internal arrays；optional field；you can use this field to limit the number of elements within the following arrays:；top_domains；text_categories；page_categories；countries；languages；default value: 1；maximum value: 20
- `[].positive_connotation_threshold` — number，可选。positive connotation threshold；optional field；specified as the probability index threshold for positive sentiment related to the citation content；if you specify this field, connotation_types object in the response will only contain data on citations with positive sentiment probability more than or equal to the specified value；possible values: from 0 to 1；default value: 0.4
- `[].sentiments_connotation_threshold` — number，可选。sentiment connotation threshold；optional field；specified as the probability index threshold for sentiment connotations related to the citation content；if you specify this field, sentiment_connotations object in the response will only contain data on citations where the ；probability per each sentiment is more than or equal to the specified value；possible values: from 0 to 1；default value: 0.4
- `[].initial_dataset_filters` — array<object>，可选。initial dataset filtering parameters；optional field；initial filtering parameters that apply to fields in the Search endpoint；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, like,not_like, has, has_not；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["domain","&lt;&gt;", "logitech.com"][["domain","&lt;&gt;","logitech.com"],"and",["content_info.connotation_types.negative","&gt;",1000]][["domain","&lt;&gt","logitech.com"]],；"and",；[["content_info.connotation_types.negative","&gt;",1000],；"or",["content_info.text_category","has",10994]]]；for more information about filters, please refer to Content Analysis API - Filters；learn more about the initial dataset filters in this help center article.
- `[].rank_scale` — string，可选。defines the scale used for calculating and displaying the rank values；optional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values:；one_hundred — rank values are displayed on a 0–100 scale；one_thousand — rank values are displayed on a 0–1000 scaledefault value: one_thousandlearn more about how this parameter works in this Help Center article
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "keyword": "logitech",
    "page_type": [
      "ecommerce",
      "news",
      "blogs",
      "message-boards",
      "organization"
    ],
    "internal_list_limit": "8",
    "positive_connotation_threshold": "0.5"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/amazon/bulk_search_volume/live

ID: `AmazonBulkSearchVolumeLive`
用途: ‌ This endpoint will provide you with search volume values for a maximum of 1,000 keywords in one API request. Here search volume represents the approximate number of monthly searches for a keyword on Amazon. The returned results are specific to the keywords, location, and language parameters specified in a POST request.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。target keywords；required field；UTF-8 encoding；maximum number of keywords you can specify in this array: 1000;；the keywords will be converted to lowercase formatlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of the location；required field if don't specify location_code；you can receive the list of available locations with their location_name by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；；Note: this endpoint currently supports the following locations and languages only:Australia - 2036, en；Austria - 2040, de；Canada - 2124, en；Egypt - 2818, ar；France - 2250, fr；Germany - 2276, de；India - 2356, en；Italy - 2380, it；Mexico - 2484, es；Netherlands - 2528, nl；Saudi Arabia - 2682, ar；Singapore - 2702, en；Spain - 2724, es；United Arab Emirates - 2784, ar；United Kingdom - 2826, en；United States - 2840, en；example:；United States
- `[].location_code` — integer，可选。location code；required field if don't specify location_name；you can receive the list of available locations with their location_code by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports these locations and languages only;；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if don't specify language_code；you can receive the list of available languages with their language_name by making a separate request to https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；Note: this endpoint currently supports these locations and languages only;；example:；English
- `[].language_code` — string，可选。language code；required field if don't specify language_name；you can receive the list of available languages with their language_code by making a separate request to https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；Note: this endpoint currently supports these locations and languages only;；example:；en
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "keywords": [
      "buy laptop",
      "cheap laptops for sale",
      "purchase laptop"
    ],
    "location_code": "2840",
    "language_code": "en"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/amazon/product_competitors/live

ID: `AmazonProductCompetitorsLive`
用途: ‌ This endpoint will provide you with a list of products that intersect with a target asin in Amazon SERPs. The data can help you identify product competitors for any listing published on Amazon. The returned results are specific to the asin as well as the location and language parameters specified in a POST request.
中文补充: **POST `/v3/dataforseo_labs/amazon/product_competitors/live`**

请求体: `application/json`

请求字段:
- `[].asin` — string，可选。product ID；required field；unique product identifier (ASIN) on Amazon;；you can receive the asin parameter by making a separate request to the Amazon Products endpoint
- `[].location_name` — string，可选。full name of the location；required field if don't specify location_code；you can receive the list of available locations with their location_name by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;；example:；United States
- `[].location_code` — integer，可选。location code；required field if don't specify location_name；you can receive the list of available locations with their location_code by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if don't specify language_code；you can receive the list of available languages with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；English
- `[].language_code` — string，可选。language code；required field if don't specify language_name；you can receive the list of available languages with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；en
- `[].limit` — integer，可选。the maximum number of products in the results array；optional field；default value: 100;；maximum value: 1000
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, ilike, not_ilike, like, not_like, match, not_match；you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters；example:；["full_metrics.amazon_serp.pos_1","&gt;", 20]for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting parameter；example:；["full_metrics.amazon_serp.pos_1,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["full_metrics.amazon_serp.pos_1,desc","avg_position,desc"]；default rule:；["ranked_serp_element.serp_item.rank_group,asc"]
- `[].offset` — integer，可选。offset in the results array of returned product competitors；optional field；default value: 0；if you specify the 10 value, the first ten product competitors in the results array will be omitted and the data will be provided for the successive product competitors
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "asin": "019005476X",
    "location_code": "2840",
    "language_code": "en"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/amazon/product_keyword_intersections/live

ID: `AmazonProductKeywordIntersectionsLive`
用途: ‌ This endpoint will provide you with a list of keywords for which the target products intersect in Amazon SERP. The returned results are specific to the asins specified in a POST request. Learn more about ASIN in this help center article.
中文补充: **POST** `/v3/dataforseo_labs/amazon/product_keyword_intersections/live`

请求体: `application/json`

请求字段:
- `[].asins` — object，可选。asins of target products；required field；product IDs of the products for which you need to find keyword intersections;；specify the ASINs as in the following example:；"asins": {；"1": "019005476X",；"2": "0190074442"；}；the maximum number of ASINs you can specify in this object is 20;；learn more about the parameter on this help center page
- `[].location_name` — string，可选。full name of the location；required field if don't specify location_code；you can receive the list of available locations with their location_name by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;；example:；United Kingdom
- `[].location_code` — integer，可选。location code；required field if don't specify location_name；you can receive the list of available locations with their location_code by making a separate request to；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if don't specify language_code；you can receive the list of available languages with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；English
- `[].language_code` — string，可选。language code；required field if don't specify language_name；you can receive the list of available languages with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；en
- `[].limit` — integer，可选。the maximum number of products in the results array；optional field；default value: 100;；maximum value: 1000
- `[].intersection_mode` — string，可选。mode for finding asin intersections；optional field；possible values: union, intersect;；default value: intersect;；learn more about the parameter in this help center guide
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, ilike, not_ilike, like, not_like, match, not_match；you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters；example:；["avg_position","&lt;", 10]for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting parameter；example:；["sum_position,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["intersections,desc","avg_position,asc"]；default rule:；["intersections,desc"]
- `[].offset` — integer，可选。offset in the results array of returned keywords；optional field；default value: 0；if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "asins": {
      "1": "B09172433Z",
      "2": "B07GBZ4Q68",
      "3": "B07GCKQD77"
    },
    "language_name": "English",
    "location_code": "2840"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/amazon/product_rank_overview/live

ID: `AmazonProductRankOverviewLive`
用途: ‌ This endpoint will provide you with ranking data from organic and paid Amazon SERPs for the target products. The returned results are specific to the asins specified in a POST request. Learn more about ASIN in this help center article.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].asins` — array<string>，可选。product IDs to compare；required field；product IDs to receive ranking data for;；the maximum number of ASINs you can specify in this array is 1000;；you can receive the asin parameter by making a separate request to the Amazon Products endpointNote: all letters in ASIN code must be specified in uppercase format;；example:；B01LW2SL7R
- `[].location_name` — string，可选。full name of the location；required field if don't specify location_code；you can receive the list of available locations with their location_name by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;；example:；United States
- `[].location_code` — integer，可选。location code；required field if don't specify location_name；you can receive the list of available locations with their location_code by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if don't specify language_code；you can receive the list of available languages with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；English
- `[].language_code` — string，可选。language code；required field if don't specify language_name；you can receive the list of available languages with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；en
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "asins": [
      "B001TJ3HUG",
      "B01LW2SL7R"
    ],
    "language_name": "English",
    "location_code": "2840"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/amazon/ranked_keywords/live

ID: `AmazonRankedKeywordsLive`
用途: ‌ This endpoint will provide you with a list of keywords the target product ranks for on Amazon. The returned results are specific to the asin specified in a POST request. Learn more about ASIN in this help center article.
中文补充: **POST** `/v3/dataforseo_labs/amazon/ranked_keywords/live`

请求体: `application/json`

请求字段:
- `[].asin` — string，可选。product ID；required field；unique product identifier (ASIN) on Amazon;；you can receive the asin parameter by making a separate request to the Amazon Products endpoint
- `[].location_name` — string，可选。full name of the location；required field if don't specify location_code；you can receive the list of available locations with their location_name by making a separate request to；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;；example:；United States
- `[].location_code` — integer，可选。location code；required field if don't specify location_name；you can receive the list of available locations with their location_code by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if don't specify language_code；you can receive the list of available languages with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；English
- `[].language_code` — string，可选。language code；required field if don't specify language_name；you can receive the list of available languages with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；en
- `[].limit` — integer，可选。the maximum number of products in the results array；optional field；default value: 100;；maximum value: 1000
- `[].ignore_synonyms` — boolean，可选。ignore highly similar keywords；optional field；if set to true only core keywords will be returned, all highly similar keywords will be excluded; ；default value: false
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, like, not_like, match, not_match；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["keyword_data.keyword_info.search_volume","in",[100,1000]];for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting parameter；example:；["keyword_data.keyword_info.competition,desc"]；default rule:；["ranked_serp_element.serp_item.rank_group,asc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["keyword_data.keyword_info.search_volume,desc","keyword_data.keyword_info.cpc,desc"]
- `[].offset` — integer，可选。offset in the results array of returned keywords；optional field；default value: 0；if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "asin": "B00R92CL5E",
    "location_code": "2840",
    "language_code": "en"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/amazon/related_keywords/live

ID: `AmazonRelatedKeywordsLive`
用途: ‌‌ The Related Keywords endpoint provides keywords appearing in the “Related Searches” section on Amazon.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；UTF-8 encoding；the keywords should be specified in the lowercase formatlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_name by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;；example:；United States
- `[].location_code` — integer，可选。location code；required field if you don't specify location_name；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_code by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；Note: it is required to specify either language_name or language_code；you can receive the list of available locations with their language_name by making a separate request to https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；English
- `[].language_code` — string，可选。language code；required field if you don't specify language_name；Note: it is required to specify either language_name or language_code；you can receive the list of available locations with their language_code by making a separate request to https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；en
- `[].depth` — integer，可选。keyword search depth；optional field；default value: 1;；number of the returned results depends on the value you set in this field;；you can specify a level from 0 to 4;；estimated number of keywords for each level (maximum):；0 - the keyword set in the keyword field；1 – 6 keywords；2 – 42 keywords；3 – 258 keywords；4 – 1554 keywords
- `[].include_seed_keyword` — boolean，可选。include data for the seed keyword；optional field；if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response；default value: false
- `[].ignore_synonyms` — boolean，可选。ignore highly similar keywords；optional field；if set to_true only core keywords will be returned, all highly similar keywords will be excluded; ；default value: falsen
- `[].limit` — integer，可选。the maximum number of returned keywords；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned keywords；optional field；default value: 0；if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "keyword": "computer mouse",
    "language_name": "English",
    "location_code": "2840",
    "limit": "5",
    "include_seed_keyword": "true"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/apple/app_competitors/live

ID: `AppleAppCompetitorsLive`
用途: ‌ This endpoint will provide you with a list of mobile applications that intersect with the target app for its ranking keywords on App Store. You will obtain the IDs of competitor apps along with search volume and ranking data on competitor ranking keywords.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].app_id` — string，可选。id of the app；required field；ID of the mobile application on App Store;；you can find the ID in the URL of every app listed on App Store;；example:；in the URL https://apps.apple.com/us/app/id835599320；the id is 835599320
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_name by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US location only;；example:；United States
- `[].location_code` — integer，可选。location code；required field if you don't specify location_name；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_code by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US location only;；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the English language only;；example:；English
- `[].language_code` — string，可选。language code；required field if you don't specify language_name；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the English language only；example:；en
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；&lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in；example:；["intersections","&gt;",500][["competitor_metrics.app_store_search_organic.pos_1","&lt;&gt;",10],"and",["avg_position","&gt;=","10"]][[["intersections","&gt;=",50],"and",["competitor_metrics.app_store_search_organic.pos_1","in",[1,5]]],；"or",；["sum_position","&gt;=","10000"]]for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results;；possible sorting types:；asc - results will be sorted in the ascending order;；desc - results will be sorted in the descending order;；you should use a comma to specify a sorting type;；example:；["intersections,asc"]；Note: you can set no more than three sorting rules in a single request;；you should use a comma to separate several sorting rules;；example:；["intersections,desc","sum_position,asc"]default rule:；["intersections,desc"]；Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array
- `[].limit` — integer，可选。the maximum number of returned apps；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned apps；optional field；default value: 0；if you specify the 10 value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "app_id": "686449807",
    "language_name": "English",
    "location_code": "2840",
    "limit": "10"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/apple/app_intersection/live

ID: `AppleAppIntersectionLive`
用途: ‌ This endpoint will provide you with a list of keywords for which the mobile applications specified in the app_ids object rank within the same App Store SERP.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].app_ids` — object，可选。ids of the target apps；required field；IDs of the target mobile applications on App Store;；you can find the ID in the URL of every app listed on App Store;；example:；in the URL https://apps.apple.com/us/app/id835599320；the id is 835599320;；the ids should be specified the following way:；`"app_ids": {；"1": "686449807",；"2": "382617920"；}`；if you specify a single ID here, the API will return results only for one application;；the maximum number of app IDs you can specify in this object is 20
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_name by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US location only;；example:；United States
- `[].location_code` — integer，可选。location code；required field if you don't specify location_name；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_code by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US location only;；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the English language only;；example:；English
- `[].language_code` — string，可选。language code；required field if you don't specify language_name；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the English language only；example:；en
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；&lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in；example:；["keyword_data.keyword_info.search_volume","&gt;",500][["keyword_data.keyword_info.search_volume","&lt;&gt;",500],"and",[intersection_result.382617920.rank_group","&gt;=","10"]]for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results;；possible sorting types:；asc - results will be sorted in the ascending order;；desc - results will be sorted in the descending order;；you should use a comma to specify a sorting type;；example:；["intersection_result.382617920.rank_absolute,asc"]；Note: you can set no more than three sorting rules in a single request;；you should use a comma to separate several sorting rules;；example:；["intersection_result.382617920.rank_absolute,desc","keyword_data.keyword_info.search_volume,asc"]；default rule:；["keyword_data.keyword_info.search_volume,desc"]；Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array
- `[].limit` — integer，可选。the maximum number of returned keywords；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned keywords；optional field；default value: 0；if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "app_ids": {
      "1": "686449807",
      "2": "382617920"
    },
    "language_name": "English",
    "location_code": "2840",
    "limit": "10"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/apple/bulk_app_metrics/live

ID: `AppleBulkAppMetricsLive`
用途: ‌ This endpoint will provide you with ranking metrics for up to 1000 App Store applications.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].app_ids` — array<string>，可选。ids of the apps；required field；IDs of mobile applications on App Store;；you can find the ID in the URL of every app listed on App Store;；example:；in the URL https://apps.apple.com/us/app/id835599320；the id is 835599320;；the maximum number of IDs you can specify in this field is 1000
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_name by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US location only;；example:；United States
- `[].location_code` — integer，可选。location code；required field if you don't specify location_name；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_code by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US location only;；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the English language only;；example:；English
- `[].language_code` — string，可选。language code；required field if you don't specify language_name；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the English language only；example:；en
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "app_ids": [
      "686449807",
      "382617920"
    ],
    "language_name": "English",
    "location_code": "2840"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/apple/keywords_for_app/live

ID: `AppleKeywordsForAppLive`
用途: ‌ This endpoint will provide you with a list of keywords for which the target app ranks on App Store. You will obtain keyword data and discover the app’s ranking position for each returned keyword.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].app_id` — string，可选。id of the app；required field；ID of the mobile application on App Store;；you can find the ID in the URL of every app listed on App Store;；example:；in the URL https://apps.apple.com/us/app/id835599320；the id is 835599320
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_name by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US location only;；example:；United States
- `[].location_code` — integer，可选。location code；required field if you don't specify location_name；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_code by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US location only;；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the English language only;；example:；English
- `[].language_code` — string，可选。language code；required field if you don't specify language_name；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the English language only；example:；en
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；&lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in；example:；["keyword_data.keyword_info.search_volume","&gt;",500][["keyword_data.keyword_info.search_volume","&lt;&gt;",500],"and",["ranked_serp_element.serp_item.rank_group","&gt;=","10"]]for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results;；possible sorting types:；asc - results will be sorted in the ascending order;；desc - results will be sorted in the descending order;；you should use a comma to specify a sorting type;；example:；["ranked_serp_element.serp_item.rank_group,asc"]；Note: you can set no more than three sorting rules in a single request;；you should use a comma to separate several sorting rules;；example:；["ranked_serp_element.serp_item.rank_group,desc","keyword_data.keyword_info.search_volume,asc"]；default rule:；["keyword_data.keyword_info.search_volume,desc"]；Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array
- `[].limit` — integer，可选。the maximum number of returned keywords；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned keywords；optional field；default value: 0；if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "app_id": "686449807",
    "language_name": "English",
    "location_code": "2840",
    "limit": "10"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/dataforseo_labs/available_filters

ID: `AvailableFilters`
用途: ‌‌ Here you will find all the necessary information about filters that can be used with DataForSEO Labs API endpoints.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results；contains the full list of available parameters that can be used for data filtration；the parameters are grouped by the endpoint they can be used with

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/dataforseo_labs/categories

ID: `Categories`
用途: We use Google product and service categories. This endpoint will provide you with the full list of available categories. You can also download the CSV file by this link.
中文补充: **GET** `https://api.seermartech.cn/v3/dataforseo_labs/categories`

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/errors

ID: `DataforseoLabsErrors`
用途: By calling this endpoint you will receive information about the DataForSEO Labs API tasks that returned an error within the past 7 days.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].limit` — integer，可选。the maximum number of returned tasks that responded with an error；optional field；default value: 1000；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned tasks；optional field；default value: 0；if you specify the 10 value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks
- `[].filtered_function` — string，可选。return tasks with a certain function；use this field to obtain a list of tasks that returned an error filtered by a certain function；you can filter the results by the values you receive in the function fields of the API response；i.e., once you receive unfiltered results, you can call this API again to filter them by function ；example: dataforseo_labs/related_keywords/live
- `[].datetime_from` — string，可选。start time for filtering results；optional field；allows filtering results by the datetime parameter within the range of the last 7 days;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2021-11-15 12:57:46 +00:00
- `[].datetime_to` — string，可选。finish time for filtering results；optional field；allows filtering results by the datetime parameter within the range of the last 7 days;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2021-11-15 13:57:46 +00:00

最小请求示例:

```json
[
  {
    "limit": "10"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/app_competitors/live

ID: `GoogleAppCompetitorsLive`
用途: ‌ This endpoint will provide you with a list of mobile applications that intersect with the target app for its ranking keywords on Google Play. You will obtain the IDs of competitor apps along with search volume and ranking data on competitor ranking keywords.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].app_id` — string，可选。id of the app；required field；ID of the mobile application on Google Play;；you can find the ID in the URL of every app listed on Google Play;；example:；in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger；the id is org.telegram.messenger
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_name by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US location only;；example:；United States
- `[].location_code` — integer，可选。location code；required field if you don't specify location_name；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_code by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US location only;；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the English language only;；example:；English
- `[].language_code` — string，可选。language code；required field if you don't specify language_name；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the English language only；example:；en
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；&lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in；example:；["intersections","&gt;",500][["competitor_metrics.google_play_search_organic.pos_1","&lt;&gt;",10],"and",["avg_position","&gt;=","10"]][[["intersections","&gt;=",50],"and",["competitor_metrics.google_play_search_organic.pos_1","in",[1,5]]],；"or",；["sum_position","&gt;=","10000"]]for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results;；possible sorting types:；asc - results will be sorted in the ascending order;；desc - results will be sorted in the descending order;；you should use a comma to specify a sorting type;；example:；["intersections,asc"]；Note: you can set no more than three sorting rules in a single request;；you should use a comma to separate several sorting rules;；example:；["intersections,desc","sum_position,asc"]default rule:；["intersections,desc"]；Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array
- `[].limit` — integer，可选。the maximum number of returned apps；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned apps；optional field；default value: 0；if you specify the 10 value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "app_id": "org.telegram.messenger",
    "language_name": "English",
    "location_code": "2840",
    "limit": "10"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/app_intersection/live

ID: `GoogleAppIntersectionLive`
用途: ‌ This endpoint will provide you with a list of keywords for which the mobile applications specified in the app_ids object rank within the same Google Play SERP.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].app_ids` — object，可选。ids of the target apps；required field；IDs of the target mobile applications on Google Play;；you can find the ID in the URL of every app listed on Google Play;；example:；in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger；the id is org.telegram.messenger;;；the ids should be specified the following way:；"app_ids": {；"1": "org.telegram.messenger",；"2": "com.zhiliaoapp.musically"；}；if you specify a single ID here, the API will return results only for one application;；the maximum number of app IDs you can specify in this object is 20
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_name by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US location only;；example:；United States
- `[].location_code` — integer，可选。location code；required field if you don't specify location_name；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_code by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US location only;；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the English language only;；example:；English
- `[].language_code` — string，可选。language code；required field if you don't specify language_name；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the English language only；example:；en
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；&lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in；example:；["keyword_data.keyword_info.search_volume","&gt;",500][["keyword_data.keyword_info.search_volume","&lt;&gt;",500],"and",[intersection_result.382617920.rank_group","&gt;=","10"]]for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results;；possible sorting types:；asc - results will be sorted in the ascending order;；desc - results will be sorted in the descending order;；you should use a comma to specify a sorting type;；example:；["intersection_result.382617920.rank_absolute,asc"]；Note: you can set no more than three sorting rules in a single request;；you should use a comma to separate several sorting rules;；example:；["intersection_result.382617920.rank_absolute,desc","keyword_data.keyword_info.search_volume,asc"]；default rule:；["keyword_data.keyword_info.search_volume,desc"]；Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array
- `[].limit` — integer，可选。the maximum number of returned keywords；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned keywords；optional field；default value: 0；if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "app_ids": {
      "1": "686449807",
      "2": "382617920"
    },
    "language_name": "English",
    "location_code": "2840",
    "limit": "10"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/dataforseo_labs/google/available_history

ID: `GoogleAvailableHistory`
用途: ‌ By calling this endpoint, you will find obtain a list of dates available for setting in the first_date and second_date fields of the Domain Metrics by Categories endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of objects containing results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/bulk_app_metrics/live

ID: `GoogleBulkAppMetricsLive`
用途: ‌ This endpoint will provide you with ranking metrics for up to 1000 Google Play applications.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].app_ids` — array<string>，可选。ids of the app；required field；IDs of the mobile applications on Google Play;；you can find the ID in the URL of every app listed on Google Play;；example:；in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger；the id is org.telegram.messenger;；the maximum number of IDs you can specify in this field is 1000
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_name by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US location only;；example:；United States
- `[].location_code` — integer，可选。location code；required field if you don't specify location_name；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_code by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US location only;；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the English language only;；example:；English
- `[].language_code` — string，可选。language code；required field if you don't specify language_name；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the English language only；example:；en
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "app_ids": [
      "org.telegram.messenger",
      "com.zhiliaoapp.musically"
    ],
    "language_name": "English",
    "location_code": "2840"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/bulk_keyword_difficulty/live

ID: `GoogleBulkKeywordDifficultyLive`
用途: This endpoint will provide you with the Keyword Difficulty metric for a maximum of 1,000 keywords in one API request. Keyword Difficulty stands for the relative difficulty of ranking in the first top-10 organic results for the related keyword. Keyword Difficulty in DataForSEO API responses indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。target keywords；required field；UTF-8 encoding；maximum number of keywords you can specify in this array: 1000；the keywords will be converted to lowercase formatlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of the location；required field if don't specify location_code；you can receive the list of available locations with their location_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；United Kingdom
- `[].location_code` — integer，可选。location code；required field if don't specify location_name；you can receive the list of available locations with their location_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if don't specify language_code；you can receive the list of available languages with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；English
- `[].language_code` — string，可选。language code；required field if don't specify language_name；you can receive the list of available languages with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；en
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "location_code": "2840",
    "language_code": "en",
    "keywords": [
      "dentist new york",
      "pizza brooklyn",
      "car dealer los angeles"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/bulk_traffic_estimation/live

ID: `GoogleBulkTrafficEstimationLive`
用途: ‌ This endpoint will provide you with estimated monthly traffic volumes for up to 1,000 domains, subdomains, or webpages. Along with organic search traffic estimations, you will also get separate values for paid search, featured snippet, and local pack results.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].targets` — array<string>，可选。target domains, subdomains, and webpages；required field；you can specify domains, subdomains, and webpages in this field;；domains and subdomains should be specified without https:// and www.;；pages should be specified with absolute URL, including https:// and www.;；you can set up to 1000 domains, subdomains or webpages
- `[].location_name` — string，可选。full name of the location；if you use this field, you don't have to specify location_code；you can receive the list of available locations with their location_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available locations；example:；United Kingdom
- `[].location_code` — integer，可选。location code；if you use this field, you don't have to specify location_name；you can receive the list of available locations with their location_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available locations；example:；2840
- `[].language_name` — string，可选。full name of the language；if you use this field, you don’t need to specify language_code；you can receive the list of available languages with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available languages；example:；English
- `[].language_code` — string，可选。language code；if you use this field, you don’t need to specify language_name；you can receive the list of available languages with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available languages；example:；en
- `[].item_types` — array<string>，可选。display results by item type；optional field；indicates the type of search results included in the responseNote: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the arraypossible values: ；["organic", "paid", "featured_snippet", "local_pack"]；default value: ；["organic", "paid"]
- `[].ignore_synonyms` — boolean，可选。ignore highly similar keywords；optional field；if set to_true, only core keywords will be returned, all highly similar keywords will be excluded; ；default value: false
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "targets": [
      "dataforseo.com",
      "cnn.com",
      "forbes.com"
    ],
    "location_code": "2840",
    "language_code": "en",
    "item_types": [
      "organic",
      "paid"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/categories_for_domain/live

ID: `GoogleCategoriesForDomainLive`
用途: ‌ This endpoint will provide you with Google product or service categories that include keywords the domain ranks for in search. Furthermore, you will obtain general rankings and traffic data for the keywords under a certain category.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].target` — string，可选。domain or subdomain；required field；the domain or subdomain name of the target website；the domain or subdomain should be specified without https:// and www.
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；United Kingdom
- `[].location_code` — integer，可选。location code；required field if you don't specify location_name；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；English
- `[].language_code` — string，可选。language code；required field if you don't specify language_name；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；en
- `[].include_subcategories` — boolean，可选。indicates if the subcategories will be included in the search；optional field；if set to false, the subcategories will be ignored；default value: false；learn more about the parameter in this help center article
- `[].include_clickstream_data` — boolean，可选。include or exclude data from clickstream-based metrics in the result；optional field；if the parameter is set to_true, you will receive clickstream_etv, clickstream_gender_distribution, and_clickstream_age_distribution_fields with clickstream data in the response；default value: false；with this parameter enabled, you will be charged double the price for the requestlearn more about how clickstream-based metrics are calculated in this help center articlen
- `[].historical_serp_mode` — string，可选。data collection mode；optional field；you can use this field to filter the results;；possible types of filtering:；live — return metrics for SERPs in which the specified target currently has ranking results;；lost — return metrics for SERPs in which the specified target had previously had ranking results, but didn't have them during the last check;；all — return metrics for both types of SERPs.；default value: live
- `[].item_types` — array<string>，可选。display results by item type；optional field；indicates the type of search results included in the responseNote: if the item_types array contains item types that are different from the organic object, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;possible values: ；["organic", "paid", "featured_snippet", "local_pack"]；default value: ；["organic", "paid"]
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in；example:；["metrics.organic.pos_1,"&gt;",0][[["metrics.organic.count","&gt;=",100],"and",["metrics.organic.pos_1","&gt;",0]],；"or",；["metrics.organic.etv","in",[10,100]]]；for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to specify a sorting type；example:；["metrics.paid.etv,asc"]；Note: you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["metrics.organic.etv,desc","metrics.paid.count,asc"]default rule:；["metrics.organic.count,desc"]；Note: if the item_types array contains item types that are different from the organic object, the results will be ordered by the first item type in the array
- `[].limit` — integer，可选。the maximum number of returned categories；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned categories ；optional field；default value: 0；if you specify the 10 value, the first ten categories in the results array will be omitted and the data will be provided for the successive categories
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "target": "dataforseo.com",
    "language_code": "en",
    "location_name": "United States",
    "item_types": [
      "paid",
      "organic",
      "featured_snippet",
      "local_pack"
    ],
    "limit": "3"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/dataforseo_labs/google/categories_for_keywords/languages

ID: `GoogleCategoriesForKeywordsLanguages`
用途: ‌ Using this endpoint you can get the full list of languages supported for the Google Categories for Keywords endpoint of DataForSEO Labs API.
中文补充: 本接口用于获取 Google「分类」接口支持的语言列表，可用于调用 `/v3/dataforseo_labs/google/categories_for_keywords/live` 时校验或选择语言。

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/categories_for_keywords/live

ID: `GoogleCategoriesForKeywordsLive`
用途: This endpoint will provide you with Google product and service categories related for each specified keyword. You can indicate a maximum of 1,000 keywords in one API request.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。target keywords；required field；UTF-8 encoding；maximum number of keywords you can specify in this array: 1000；the keywords will be converted to lowercase formatlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].language_name` — string，可选。full name of the language；required field if don't specify language_code；you can receive the list of available languages with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/google/categories_for_keywords/languages；example:；English
- `[].language_code` — string，可选。language code；required field if don't specify language_name；you can receive the list of available languages with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/google/categories_for_keywords/languages；example:；en
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "keywords": [
      "dentist new york",
      "pizza brooklyn",
      "car dealer los angeles"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/competitors_domain/live

ID: `GoogleCompetitorsDomainLive`
用途: ‌ This endpoint will provide you with a full overview of ranking and traffic data of the competitor domains from organic and paid search. In addition to that, you will get the metrics specific to the keywords both competitor domains and your domain rank for within the same SERP.
中文补充: **POST** `https://api.seermartech.cn/v3/dataforseo_labs/google/competitors_domain/live`

请求体: `application/json`

请求字段:
- `[].target` — string，可选。domain；required field；the domain name of the target website；the domain should be specified without https:// and www.；you can specify page URL, but the results will be specific to the domain in the specified URL
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；United Kingdom
- `[].location_code` — integer，可选。location code；required field if you don't specify location_name；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；English
- `[].language_code` — string，可选。language code；required field if you don't specify language_name；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；en
- `[].item_types` — array<string>，可选。display results by item type；optional field；indicates the type of search results included in the responseNote: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;possible values: ；["organic", "paid", "featured_snippet", "local_pack"]；default value: ；["organic", "paid"]
- `[].include_clickstream_data` — boolean，可选。include or exclude data from clickstream-based metrics in the result；optional field；if the parameter is set to_true, you will receive clickstream_etv, clickstream_gender_distribution, and_clickstream_age_distribution_fields with clickstream data in the response；default value: false；with this parameter enabled, you will be charged double the price for the requestlearn more about how clickstream-based metrics are calculated in this help center articlen
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in；example:；["metrics.organic.count","&gt;",50][[["metrics.organic.count","&gt;=",50],"and",["metrics.organic.pos_1","in",[1,5]]],；"or",；["metrics.organic.etv","&gt;=","100"]]for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to specify a sorting type；example:；["metrics.paid.etv,asc"]；Note: you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["metrics.organic.etv,desc","metrics.paid.count,asc"]default rule:；["metrics.organic.count,desc"]；Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array
- `[].limit` — integer，可选。the maximum number of returned domains；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned domains；optional field；default value: 0；if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
- `[].max_rank_group` — integer，可选。maximum rank up to which competitors will be considered；optional field；default value: 100if you specify 10 here, we will extract competitors from the top 10 Google search results only
- `[].exclude_top_domains` — boolean，可选。indicates whether to exclude world's largest websites；optional field；default value: false；set to true if you want to get highly-relevant competitors excluding the websites listed below:wikipedia.org；pinterest.com；amazon.com；google.com；facebook.com；wordpress.com；medium.com；quora.com；reddit.com；youtube.com；ebay.com；uol.com.br；instagram.com；olx.com；twitter.com；linkedin.com；slideshare.net
- `[].exclude_domains` — array<string>，可选。exclude domains from the results；optional field；use this parameter to exclude specific domains from the results；Note: you can specify up to 1000 domains in this arrayexample:；"exclude_domains": [；"reddit.com",；"youtube.com"；]
- `[].intersecting_domains` — array<string>，可选。additional domains for improving results accuracy；optional field；to improve the accuracy of the result, you can specify domains that are known to intersect with the target in SERPs;；if you use this array, metrics in the result will be based on SERPs where both target website and intersecting_domains appear;；Note: you can specify up to 20 domains in this array
- `[].ignore_synonyms` — boolean，可选。ignore highly similar keywords；optional field；if set to_true, only core keywords will be returned, all highly similar keywords will be excluded; ；default value: falsen
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "target": "newmouth.com",
    "intersecting_domains": [
      "dentaly.org",
      "health.com",
      "trysnow.com"
    ],
    "language_name": "English",
    "location_code": "2840",
    "limit": "3"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/domain_intersection/live

ID: `GoogleDomainIntersectionLive`
用途: ‌ This endpoint will provide you with the keywords for which both specified domains rank within the same SERP. You will get search volume, competition, cost-per-click and other data on each intersecting keyword. Along with that, you will get data on the first and second domain’s SERP element discovered for this keyword, as well as the estimated traffic volume and cost of ad traffic. Domain Intersection endpoint supports organic, paid, local pack, and featured snippet results.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].target1` — string，可选。domain； required field； the domain name of the first target website； the domain should be specified without https:// and www.
- `[].target2` — string，可选。domain； required field； the domain name of the second target website； the domain should be specified without https:// and www.
- `[].location_name` — string，可选。full name of the location； required field if you don't specify location_code； Note: it is required to specify either location_name or location_code； you can receive the list of available locations with their location_name by making a separate request to the； https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages； example:； United Kingdom
- `[].location_code` — integer，可选。location code； required field if you don't specify location_name； Note: it is required to specify either location_name or location_code； you can receive the list of available locations with their location_code by making a separate request to the； https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages； example:； 2840
- `[].language_name` — string，可选。full name of the language； required field if you don't specify language_code； Note: it is required to specify either language_name or language_code； you can receive the list of available languages with their language_name by making a separate request to the； https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages； example:； English
- `[].language_code` — string，可选。language code； required field if you don't specify language_name； Note: it is required to specify either language_name or language_code； you can receive the list of available languages with their language_code by making a separate request to the； https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages； example:； en
- `[].intersections` — boolean，可选。domain intersections in SERP； optional field； if you set intersections to true, you will get the keywords for which both target domains specified as target1 and target2 have results within the same SERP; the corresponding SERP elements for both domains will be provided in the results array； Note: this endpoint will not provide results if the number of intersecting keywords exceeds 10 million if you specify intersections: false, you will get the keywords for which the domain specified as target1 has results in SERP, and the domain specified as target2 doesn't;； thus, the corresponding SERP elements and other data will be provided for the domain specified as target1only； default value: true
- `[].item_types` — array<string>，可选。search results type； indicates type of search results included in the response； optional field possible values:； ["organic", "paid", "featured_snippet", "local_pack"]； default value:； ["organic", "paid"]
- `[].include_serp_info` — boolean，可选。include data from SERP for each keyword； optional field； if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response； default value: false
- `[].include_clickstream_data` — boolean，可选。include or exclude data from clickstream-based metrics in the result； optional field； if the parameter is set to true, you will receive clickstream_keyword_info, clickstream_etv, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response； default value: false； with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article
- `[].limit` — integer，可选。the maximum number of returned keywords； optional field； default value: 100； maximum value: 1000
- `[].offset` — integer，可选。offset in the items array of returned keywords； optional field； default value: 0； if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
- `[].filters` — array<object>，可选。array of results filtering parameters； optional field； you can add several filters at once (8 filters maximum)； you should set a logical operator and, or between the conditions； the following operators are supported:； regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, match, not_match, ilike, not_ilike, like, not_like； you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters； example:； ["keyword_data.keyword_info.search_volume","in",[100,1000]]； [["first_domain_serp_element.etv","&gt;",0],"and",["first_domain_serp_element.description","like","%goat%"]]； [["keyword_data.keyword_info.search_volume","&gt;",100],； "and",； [["first_domain_serp_element.description","like","%goat%"],； "or",；； ["second_domain_serp_element.type","=","organic"]]]； for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide
- `[].order_by` — array<string>，可选。results sorting rules； optional field； you can use the same values as in the filters array to sort the results； possible sorting types:； asc - results will be sorted in the ascending order； desc - results will be sorted in the descending order； you should use a comma to set up a sorting parameter； example:； ["keyword_data.keyword_info.competition,desc"]； default rule:； ["keyword_data.keyword_info.search_volume,desc"]； note that you can set no more than three sorting rules in a single request； you should use a comma to separate several sorting rules； example:； ["keyword_data.keyword_info.search_volume,desc","keyword_data.keyword_info.cpc,desc"]
- `[].tag` — string，可选。user-defined task identifier； optional field； the character limit is 255； you can use this parameter to identify the task and match it with the result； you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "target1": "mom.com",
    "target2": "quora.com",
    "language_code": "en",
    "location_code": "2840",
    "include_serp_info": "true",
    "limit": "3"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/domain_metrics_by_categories/live

ID: `GoogleDomainMetricsByCategoriesLive`
用途: ‌ This endpoint will provide you with dynamics of change in metrics of domains relevant to the specified product and service categories. You will receive historical ranking data from Google SERPs, along with valuable current and historical domain metrics, such as ETV, impressions ETV, estimated paid traffic cost, the total count of SERPs that contain domains, and more.
中文补充: **POST** `https://api.seermartech.cn/v3/dataforseo_labs/google/domain_metrics_by_categories/live`

请求体: `application/json`

请求字段:
- `[].category_codes` — array<string>，可选。product and service categories；required field；The maximum number of categories you can specify: 5；you can download the full list of possible categories
- `[].first_date` — string，可选。first date of comparison period；required field；first date for which domain metrics will be provided;；date format: "yyyy-mm-dd";；example: "2021-06-01";；the list available dates is available through the available history endpoint;；Note: first_date cannot be greater than today's date;；Also note: the dates specified in first_date and second_date cannot point to the same month of the same year;；you can specify the dates in any order: first_date can be greater than second_date and vice versa;；minimum date: "2020-10-01"
- `[].second_date` — string，可选。second date of comparison period；required field；second date for which domain metrics will be provided;；date format: "yyyy-mm-dd";；example: "2021-10-01";；the list available dates is available through the available history endpoint;；Note: second_date cannot be greater than today's date;；Also note: the dates specified in first_date and second_date cannot point to the same month of the same year;；you can specify the dates in any order: second_date can be greater than first_date and vice versa;；minimum date: "2020-10-01"
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code；Note: it is required to specify either location_name or location_code;；you can receive the list of available locations with their location_name by making a separate request to；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；example:；United Kingdom
- `[].location_code` — integer，可选。unique location identifier；required field if you don't specify location_name；Note: it is required to specify either location_name or location_code;；you can receive the list of available locations with their location_code by making a separate request to；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；Note: it is required to specify either language_name or language_code;；you can receive the list of available languages with their language_name by making a separate request to；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；example:；English
- `[].language_code` — string，可选。unique language identifier；required field if you don't specify language_name；Note: it is required to specify either language_name or language_code;；you can receive the list of available languages with their language_code by making a separate request to https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；example:；en
- `[].item_types` — array<string>，可选。display results by item type；optional field；indicates the type of search results included in the response;Note: if the item_types array contains item types that are different from the organic object, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;possible values: ；["organic", "paid", "featured_snippet", "local_pack"];；default value: ；["organic", "paid"]
- `[].top_categories_count` — integer，可选。number of additional domain categories；optional field；by using this parameter, you can receive domains relevant to additional categories that are not specified in category_codes above;；to learn more about the parameter, please refer to this help center article;；by default, top_categories_count is equal to the number of categories specified in the category_codes array;；Note: top_categories_count cannot be less than the number of categories in the category_codes array;；maximum value: 5
- `[].include_subdomains` — boolean，可选。return subdomains in the API response；optional field；if false, the API response will contain main_domain only;；if true, the API will return main_domain plus its subdomains (if available);；default value: true
- `[].etv_min` — integer，可选。minimum current organic ETV of the domain；optional field；if specified, the API will return only domains with organic_etv greater than the specified value
- `[].etv_max` — integer，可选。maximum current organic ETV of the domain；optional field；if specified, the API will return only domains with organic_etv lesser than the specified value
- `[].correlate` — boolean，可选。correlate data with previously obtained datasets；optional field；default value: true;；if you use this parameter, our system will correlate data you obtain now with previously obtained datasets;；this parameter is intended to mitigate any inconsistencies that may result from changes to our database;；Note: we do not recommend setting correlate to false
- `[].limit` — integer，可选。the maximum number of domains in the results array；optional field；default value: 100;；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned domains；optional field；default value: 0;；if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum);；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, match, not_match, ilike, not_ilike, like, not_like;；you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters;；example:；["metrics_history.202110.organic.pos_1", ">", 15];；for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results;；default rule: ["organic_etv,desc"];；possible sorting types:；asc - results will be sorted in ascending order；desc - results will be sorted in descending order;；you should use a comma to set up a sorting type;；example:；["organic_count,desc"];；note that you can set no more than three sorting rules in a single request;；you should use a comma to separate several sorting rules;；example:；["organic_etv,desc","organic_count,asc"]
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255;；you can use this parameter to identify the task and match it with the result;；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "location_code": "2840",
    "language_code": "en",
    "category_codes": [
      "13418",
      "11494"
    ],
    "first_date": "2021-06-01",
    "second_date": "2021-10-01",
    "limit": "3"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/domain_rank_overview/live

ID: `GoogleDomainRankOverviewLive`
用途: ‌ This endpoint will provide you with ranking and traffic data from organic and paid search for the specified domain. You will be able to review the domain ranking distribution in SERPs as well as estimated monthly traffic volume for both organic and paid results.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].target` — string，可选。domain；required field；the domain name of the target website；the domain should be specified without https:// and www.
- `[].location_name` — string，可选。full name of the location；optional field；if you use this field, you don't need to specify location_code；you can receive the list of available locations with their location_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available locations；example:；United Kingdom
- `[].location_code` — integer，可选。location code；optional field；if you use this field, you don't need to specify location_name；you can receive the list of available locations with their location_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available locations；example:；2840
- `[].language_name` — string，可选。full name of the language；optional field；if you use this field, you don't need to specify language_code；you can receive the list of available languages with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available languages；example:；English
- `[].language_code` — string，可选。language code；optional field；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available languages；example:；en
- `[].ignore_synonyms` — boolean，可选。ignore highly similar keywords；optional field；if set to_true, all highly similar keywords will be excluded from the ranking and traffic calculations, the results will be based on data for main keywords from groups of synonyms；default value: falsen
- `[].limit` — integer，可选。the maximum number of returned results for domain；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned items；optional field；default value: 0；if you specify the 10 value, the first ten items in the results array will be omitted and the data will be provided for the successive items
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "target": "dataforseo.com",
    "language_name": "English",
    "location_code": "2840"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/historical_bulk_traffic_estimation/live

ID: `GoogleHistoricalBulkTrafficEstimationLive`
用途: ‌ This endpoint will provide you with historical monthly traffic volumes for up to 1,000 domains collected within the specified time range through October 2020. If you do not specify the range, data will be returned for the previous 12 months. Along with organic search traffic estimations, you will also get separate values for paid search, featured snippet, and local pack results.
中文补充: **POST** `https://api.seermartech.cn/v3/dataforseo_labs/google/historical_bulk_traffic_estimation/live`

请求体: `application/json`

请求字段:
- `[].targets` — array<string>，可选。target domains and subdomains；required field；you can specify domains and subdomains in this field;；domains and subdomains should be specified without https:// and www.;；you can set up to 1000 domains or subdomains
- `[].location_name` — string，可选。full name of the location；if you use this field, you don't have to specify location_code；you can receive the list of available locations with their location_name by making a separate request to the；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available locations；example:；United Kingdom
- `[].location_code` — integer，可选。location code；if you use this field, you don't have to specify location_name；you can receive the list of available locations with their location_code by making a separate request to the；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available locations；example:；2840
- `[].language_name` — string，可选。full name of the language；if you use this field, you don’t need to specify language_code；you can receive the list of available languages with their language_name by making a separate request to the；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available languages；example:；English
- `[].language_code` — string，可选。language code；if you use this field, you don’t need to specify language_name；you can receive the list of available languages with their language_code by making a separate request to the；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available languages；example:；en
- `[].date_from` — string，可选。starting date of the time range；optional field；if you don't specify this field, the data will be provided for the previous 12 months；minimal possible value: 2020-10-01；date format: "yyyy-mm-dd"
- `[].date_to` — string，可选。ending date of the time range；optional field；if you don't specify this field, the today's date will be used by default;；date format: "yyyy-mm-dd"；example:；"2021-04-01"
- `[].ignore_synonyms` — boolean，可选。ignore highly similar keywords；optional field；if set to_true only core keywords will be returned, all highly similar keywords will be excluded;；default value: falsen
- `[].item_types` — array<string>，可选。display results by item type；optional field；indicates the type of search results included in the response;；Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array;；possible values:；["organic", "paid", "featured_snippet", "local_pack"]；default value:；["organic", "paid"]
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "targets": [
      "dataforseo.com",
      "cnn.com",
      "forbes.com"
    ],
    "location_code": "2840",
    "language_code": "en",
    "date_from": "2021-01-01",
    "date_to": "2021-03-29",
    "item_types": [
      "organic",
      "paid"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/historical_keyword_data/live

ID: `GoogleHistoricalKeywordDataLive`
用途: ‌‌ This endpoint provides Google historical keyword data for specified keywords, including search volume, cost-per-click, competition values for paid search, monthly searches, and search volume trends. You can get historical keyword data since August, 2021, depending on keywords along with location and language combination. You can find the list of supported locations and languages here.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。keywords；required field；The maximum number of keywords you can specify: 700；The maximum number of characters for each keyword: 80；The maximum number of words for each keyword phrase: 10；the specified keywords will be converted to lowercase format, data will be provided in a separate arraynote that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn't contain such keywords and cannot return data on them；you will not be charged for the keywords omitted in the resultslearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；United Kingdom
- `[].location_code` — integer，可选。location code；required field if you don't specify location_name；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；Note: it is required to specify either language_name or language_code；you can receive the list of available locations with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；English
- `[].language_code` — string，可选。language code；required field if you don't specify language_name；Note: it is required to specify either language_name or language_code；you can receive the list of available locations with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；en
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keywords": [
      "iphone"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/historical_rank_overview/live

ID: `GoogleHistoricalRankOverviewLive`
用途: ‌ This endpoint will provide you with historical data on rankings and traffic of the specified domain, such as domain ranking distribution in SERPs and estimated monthly traffic volume for both organic and paid results.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].target` — string，可选。domain；required field；the domain name of the target website；the domain should be specified without https:// and www.
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；United Kingdom
- `[].location_code` — integer，可选。location code；required field if you don't specify location_name；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；Note: it is required to specify either language_name or language_code；you can receive the list of available locations with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；English
- `[].language_code` — string，可选。language code；required field if you don't specify language_name；Note: it is required to specify either language_name or language_code；you can receive the list of available locations with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；en
- `[].date_from` — string，可选。starting date of the time range；optional field；if you don't specify this field, the data will be provided for the previous 6 months；minimal possible value: 2020-10-01；date format: "yyyy-mm-dd"
- `[].date_to` — string，可选。ending date of the time range；optional field；if you don't specify this field, the today's date will be used by default；date format: "yyyy-mm-dd"；example:；"2021-04-01"
- `[].correlate` — boolean，可选。correlate data with previously obtained datasets；optional field；default value: true；if you use this parameter, our system will correlate data you obtain now with previously obtained datasets；this parameter is intended to mitigate any inconsistencies that may result from changes to our database；we recommend always setting correlate to true
- `[].ignore_synonyms` — boolean，可选。ignore highly similar keywords；optional field；if set to true, only data based on core keywords will be returned, data for all highly similar keywords will be excluded; ；default value: false
- `[].include_clickstream_data` — boolean，可选。include or exclude data from clickstream-based metrics in the result；optional field；if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response;；default value: false;Note: historical clickstream data is available from 2024/05 (May, 2024);；with this parameter enabled, you will be charged double the price for the request;；learn more about how clickstream-based metrics are calculated in this help center article
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "target": "dataforseo.com",
    "location_code": "2840",
    "language_code": "en",
    "date_from": "2021-01-01",
    "date_to": "2021-03-29"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/historical_serps/live

ID: `GoogleHistoricalSerpsLive`
用途: ‌ This endpoint will provide you with Google SERPs collected within the specified time frame. You will also receive a complete overview of featured snippets and other extra elements that were present within the specified dates. The data will allow you to analyze the dynamics of keyword rankings over time for the specified keyword and location.
中文补充: 本接口使用 **POST `/v3/dataforseo_labs/google/historical_serps/live`**，用于查询指定、地区和语言在历史时间范围的 Google 搜索结果页（SERP）。响应每个月采集到的 SERP、自然结果、广告结果、精选摘要、知识面板、本地结果、图片、购物、新闻、AI Overview 等 SERP 特征及排名变化。

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；you can specify up to 700 characters in the keyword field;；all %## will be decoded (plus character ‘+’ will be decoded to a space character);；if you need to use the “%” character for your keyword, please specify it as “%25”;；if you need to use the “+” character for your keyword, please specify it as “%2B”
- `[].date_from` — string，可选。starting date of the time range；optional field；if you don't specify this field, the API will return all SERPs collected for 365 days starting from the current datetime value;；minimal possible value: 365 days from the current datetime value;；date format: "yyyy-mm-dd"
- `[].date_to` — string，可选。ending date of the time range；optional field；if you don't specify this field, the today's date will be used by default;；date format: "yyyy-mm-dd";；example:；"2021-09-01"
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_name by making a separate request to https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；United Kingdom
- `[].location_code` — integer，可选。unique location identifier；required field if you don't specify location_name；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_code by making a separate request to https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_name parameters by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；English
- `[].language_code` — string，可选。unique language identifier；required field if you don't specify language_name；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_code parameters by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；en
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "keyword": "albert einstein",
    "datetime_from": "2026-08-01 17:42:44",
    "datetime_to": "2026-08-11 17:42:44",
    "location_code": "2840",
    "language_code": "en",
    "limit": "10"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results； the array includes objects with SERPs for each month within the specified time frame

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/keyword_ideas/live

ID: `GoogleKeywordIdeasLive`
用途: ‌ The Keyword Ideas endpoint provides search terms that are relevant to the product or service categories of the specified keywords. The algorithm selects the keywords which fall into the same categories as the seed keywords specified in a POST array.
中文补充: 本接口使用 **POST `/v3/dataforseo_labs/google/keyword_ideas/live`**，根据最多 200 个种子所属的产品或服务类别，返回的建议及搜索数据。

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。keywords；required field；UTF-8 encoding；The maximum number of keywords you can specify: 200.；The keywords will be converted to lowercase formatlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_name by making a separate request to the；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；United Kingdom
- `[].location_code` — integer，可选。unique location identifier；required field if you don't specify location_name；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；2840
- `[].language_name` — string，可选。full name of the language；optional field；if you use this field, you don't need to specify language_code；you can receive the list of available languages with their language_name by making a separate request to the；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；English；Note: if omitted, results default to the language with the most keyword records in the specified location;；refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language
- `[].language_code` — string，可选。language code；optional field；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code by making a separate request to the；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；en；Note: if omitted, results default to the language with the most keyword records in the specified location;；refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language
- `[].closely_variants` — boolean，可选。search mode；optional field；if set to_true the results will be based on the phrase-match search algorithm；if set to false the results will be based on the broad-match search algorithm；default value: falsen
- `[].ignore_synonyms` — boolean，可选。ignore highly similar keywords；optional field；if set to_true only core keywords will be returned, all highly similar keywords will be excluded; ；default value: falsen
- `[].include_serp_info` — boolean，可选。include data from SERP for each keyword；optional field；if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response；default value: false
- `[].include_clickstream_data` — boolean，可选。include or exclude data from clickstream-based metrics in the result；optional field；if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response；default value: false；with this parameter enabled, you will be charged double the price for the requestlearn more about how clickstream-based metrics are calculated in this help center article
- `[].limit` — integer，可选。the maximum number of keywords in the results array；optional field；default value: 700；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned keywords；optional field；default value: 0；if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords；Note: we recommend using this parameter only when retrieving up to 10,000 results；for retrieving over 10,000 results, use the offset_token instead.
- `[].offset_token` — string，可选。offset token for subsequent requests；optional field；provided in the identical filed of the response to each request;；use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;；by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;；offset_token values are unique for each subsequent task ；Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task.；learn more about this parameter on our Help Center
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, match, not_match, ilike, not_ilike, like, not_like；you can use the % operator with like and not_like,as well as ilike, not_ilike to match any string of zero or more characters；note that you can not filter the results by relevance；example:；["keyword_info.search_volume","&gt;",0][["keyword_info.search_volume","in",[0,1000]],；"and",；["keyword_info.competition_level","=","LOW"]][["keyword_info.search_volume","&gt;",100],；"and",；[["keyword_info.cpc","&lt;",0.5],；"or",["keyword_info.high_top_of_page_bid","&lt;=",0.5]]]；for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting parameterdefault rule:；["relevance,desc"]；relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. Note that relevance is only our internal system identifier, so it can not be used as a filter, and you will not find this field in the result array. The relevance score is based on a similar principle as used in the Keywords For Keywords endpoint.note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["relevance,desc","keyword_info.search_volume,desc"]
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "keywords": [
      "phone",
      "watch"
    ],
    "location_code": "2840",
    "language_code": "en",
    "include_serp_info": "true",
    "limit": "3"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/keyword_overview/live

ID: `GoogleKeywordOverviewLive`
用途: ‌‌ This endpoint provides Google keyword data for specified keywords. For each keyword, you will receive current cost-per-click, competition values for paid search, search volume, search intent, monthly searches, as well as SERP and backlink information. Additionally, you can obtain clickstream data, such as clickstream search volume, by specifying the include_clickstream_data parameter.
中文补充: 本接口使用 **POST `/v3/dataforseo_labs/google/keyword_overview/live`** 获取指定的 Google 数据。响应当前每次点击费用（CPC）、付费搜索竞争度、搜索量、搜索意图、近 12 个月月度搜索量，以及 SERP 和外链信息。

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。keywords；required field；The maximum number of keywords you can specify: 700；The maximum number of characters for each keyword: 80；The maximum number of words for each keyword phrase: 10；the specified keywords will be converted to lowercase format, data will be provided in a separate arraynote that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn't contain such keywords and cannot return data on them；you will not be charged for the keywords omitted in the resultslearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；United Kingdom
- `[].location_code` — integer，可选。location code；required field if you don't specify location_name；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；Note: it is required to specify either language_name or language_code；you can receive the list of available locations with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；English
- `[].language_code` — string，可选。language code；required field if you don't specify language_name；Note: it is required to specify either language_name or language_code；you can receive the list of available locations with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；en
- `[].include_serp_info` — boolean，可选。include data from SERP for each keyword；optional field；if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response；default value: false
- `[].include_clickstream_data` — boolean，可选。include or exclude data from clickstream-based metrics in the result；optional field；if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response；default value: false；with this parameter enabled, you will be charged double the price for the requestlearn more about how clickstream-based metrics are calculated in this help center article
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "include_clickstream_data": "true",
    "include_serp_info": "true",
    "keywords": [
      "iphone"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/keyword_suggestions/live

ID: `GoogleKeywordSuggestionsLive`
用途: ‌‌ The Keyword Suggestions endpoint provides search queries that include the specified seed keyword.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；UTF-8 encoding；the keywords will be converted to lowercase format;learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of the location；optional field；if you use this field, you don't need to specify location_code；you can receive the list of available locations with their location_name by making a separate request to the；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available locations；example:；United Kingdom
- `[].location_code` — integer，可选。location code；optional field；if you use this field, you don't need to specify location_name；you can receive the list of available locations with their location_code by making a separate request to the；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available locations；example:；2840
- `[].language_name` — string，可选。full name of the language；optional field；if you use this field, you don't need to specify language_code；you can receive the list of available languages with their language_name by making a separate request to the；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；English；Note: if omitted, results default to the language with the most keyword records in the specified location;；refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language
- `[].language_code` — string，可选。language code；optional field；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code by making a separate request to the；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；en；Note: if omitted, results default to the language with the most keyword records in the specified location;；refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language
- `[].include_seed_keyword` — boolean，可选。include data for the seed keyword；optional field；if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response；default value: false
- `[].include_serp_info` — boolean，可选。include data from SERP for each keyword；optional field；if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response；default value: false
- `[].include_clickstream_data` — boolean，可选。include or exclude data from clickstream-based metrics in the result；optional field；if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response；default value: false；with this parameter enabled, you will be charged double the price for the requestlearn more about how clickstream-based metrics are calculated in this help center article
- `[].exact_match` — boolean，可选。search for the exact phrase；optional field；if set to true, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrase；default value: false
- `[].ignore_synonyms` — boolean，可选。ignore highly similar keywords；optional field；if set to true only core keywords will be returned, all highly similar keywords will be excluded;；default value: false
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, match, not_match, ilike, not_ilike, like, not_like；you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters；example:；["keyword_info.search_volume","&gt;",0]；[["keyword_info.search_volume","in",[0,1000]],；"and",；["keyword_info.competition_level","=","LOW"]][["keyword_info.search_volume","&gt;",100],；"and",；[["keyword_info.cpc","&lt;",0.5],；"or",；["keyword_info.high_top_of_page_bid","&lt;=",0.5]]]；for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；a comma is used as a separator；example:；["keyword_info.competition,desc"]；default rule:；["keyword_info.search_volume,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["keyword_info.search_volume,desc","keyword_info.cpc,desc"]
- `[].limit` — integer，可选。the maximum number of returned keywords；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned keywords；optional field；default value: 0；if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords；Note: we recommend using this parameter only when retrieving up to 10,000 results；for retrieving over 10,000 results, use the offset_token instead.
- `[].offset_token` — string，可选。offset token for subsequent requests；optional field；provided in the identical filed of the response to each request;；use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;；by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;；offset_token values are unique for each subsequent task；Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task.；learn more about this parameter on our Help Center
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "keyword": "phone",
    "location_code": "2840",
    "language_code": "en",
    "include_serp_info": "true",
    "include_seed_keyword": "true",
    "limit": "1"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/keywords_for_app/live

ID: `GoogleKeywordsForAppLive`
用途: ‌ This endpoint will provide you with a list of keywords for which the target app ranks on Google Play. You will obtain keyword data and discover the app’s ranking position for each returned keyword.
中文补充: 本接口使用 **POST `/v3/dataforseo_labs/google/keywords_for_app/live`**，返回指定 Google Play 应用当前排名的列表、指标及应用在 Google Play 搜索结果中的排名信息。

请求体: `application/json`

请求字段:
- `[].app_id` — string，可选。id of the apps；required field；ID of the mobile application on Google Play;；you can find the ID in the URL of every app listed on Google Play;；example:；in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger；the id is org.telegram.messenger
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_name by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US location only;；example:；United States
- `[].location_code` — integer，可选。location code；required field if you don't specify location_name；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_code by making a separate request to ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the US location only;；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the English language only;；example:；English
- `[].language_code` — string，可选。language code；required field if you don't specify language_name；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages;；Note: this endpoint currently supports the English language only；example:；en
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；&lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in；example:；["keyword_data.keyword_info.search_volume","&gt;",500][["keyword_data.keyword_info.search_volume","&lt;&gt;",500],"and",["ranked_serp_element.serp_item.rank_group","&gt;=","10"]]for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results;；possible sorting types:；asc - results will be sorted in the ascending order;；desc - results will be sorted in the descending order;；you should use a comma to specify a sorting type;；example:；["ranked_serp_element.serp_item.rank_group,asc"]；Note: you can set no more than three sorting rules in a single request;；you should use a comma to separate several sorting rules;；example:；["ranked_serp_element.serp_item.rank_group,desc","keyword_data.keyword_info.search_volume,asc"]；default rule:；["keyword_data.keyword_info.search_volume,desc"]；Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array
- `[].limit` — integer，可选。the maximum number of returned keywords；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned keywords；optional field；default value: 0；if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "app_id": "org.telegram.messenger",
    "language_name": "English",
    "location_code": "2840",
    "limit": "10"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/keywords_for_categories/live

ID: `GoogleKeywordsForCategoriesLive`
用途: ‌ This endpoint will provide you with a list of keywords relevant to the specified product categories. You will get the search volume rate for the last month, search volume trend for the previous 12 months, as well as current cost-per-click and competition values for each keyword.
中文补充: 本接口通过 Google 搜索数据，根据指定的产品或服务类别返回。每个最近一个月的搜索量、过去 12 个月的搜索量趋势、平均每次点击费用（CPC）、竞争程度及 SEO 数据。

请求体: `application/json`

请求字段:
- `[].category_codes` — array<string>，可选。product and service categories；required field；The maximum number of categories you can specify: 20；you can download the full list of possible categories
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_name by making a separate request to the；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；United Kingdom
- `[].location_code` — integer，可选。unique location identifier；required field if you don't specify location_name；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_code by making a separate request to the；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_name by making a separate request to the；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；English
- `[].language_code` — string，可选。unique language identifier；required field if you don't specify language_name；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_code by making a separate request to the；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；en
- `[].category_intersection` — boolean，可选。category intersections；optional field；if set to true, you will get keywords featured in all specified categories;；if set to false, you will keywords that are specified in any of the specified categories;；default value: true
- `[].include_serp_info` — boolean，可选。include data from SERP for each keyword；optional field；if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response；default value: false
- `[].include_clickstream_data` — boolean，可选。include or exclude data from clickstream-based metrics in the result；optional field；if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response；default value: false；with this parameter enabled, you will be charged double the price for the requestlearn more about how clickstream-based metrics are calculated in this help center article
- `[].ignore_synonyms` — boolean，可选。ignore highly similar keywords；optional field；if set to true only core keywords will be returned, all highly similar keywords will be excluded;；default value: false
- `[].limit` — integer，可选。the maximum number of keywords in the results array；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned keywords；optional field；default value: 0；if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords；Note: we recommend using this parameter only when retrieving up to 10,000 results；for retrieving over 10,000 results, use the offset_token instead.
- `[].offset_token` — string，可选。offset token for subsequent requests；optional field；provided in the identical filed of the response to each request;；use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;；by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;；offset_token values are unique for each subsequent task；Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task.；learn more about this parameter on our Help Center
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, match, not_match, ilike, not_ilike, like, not_like；you can use the % operator with like and not_like,as well as ilike, not_ilike to match any string of zero or more characters；example:；["keyword_info.search_volume","&gt;",0]；[["keyword_info.search_volume","in",[0,1000]],；"and",；["keyword_info.competition_level","=","LOW"]][["keyword_info.search_volume","&gt;",100],；"and",；[["keyword_info.cpc","&lt;",0.5],；"or",；["keyword_info.high_top_of_page_bid","&lt;=",0.5]]]；for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["keyword_info.competition,desc"]；default rule:；["keyword_info.search_volume,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["keyword_info.search_volume,desc","keyword_info.competition,asc"]
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "category_codes": [
      "12191",
      "12193"
    ],
    "language_name": "English",
    "location_code": "2840",
    "include_serp_info": "true",
    "limit": "3"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/keywords_for_site/live

ID: `GoogleKeywordsForSiteLive`
用途: ‌ The Keywords For Site endpoint will provide you with a list of keywords relevant to the target domain. Each keyword is supplied with relevant categories, search volume data for the last month, cost-per-click, competition, and search volume trend values for the past 12 months.
中文补充: **POST** `/v3/dataforseo_labs/google/keywords_for_site/live`

请求体: `application/json`

请求字段:
- `[].target` — string，可选。target domain；required field；the domain name of the target website；the domain should be specified without https://
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_name by making a separate request to the；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；United Kingdom
- `[].location_code` — integer，可选。unique location identifier；required field if you don't specify location_name；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_code by making a separate request to the；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；2840
- `[].language_name` — string，可选。full name of the language；optional field；if you use this field, you don't need to specify language_code；you can receive the list of available languages with their language_name by making a separate request to the；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；English；Note: if omitted, results default to the language with the most keyword records in the specified location;；refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language
- `[].language_code` — string，可选。language code；optional field；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code by making a separate request to the；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；en；Note: if omitted, results default to the language with the most keyword records in the specified location;；refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language
- `[].include_serp_info` — boolean，可选。include data from SERP for each keyword；optional field；if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response；default value: false
- `[].include_subdomains` — boolean，可选。indicates if the subdomains will be included in the search；optional field；if set to false, the subdomains will be ignored；default value: true
- `[].include_clickstream_data` — boolean，可选。include or exclude data from clickstream-based metrics in the result；optional field；if the parameter is set to_true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response；default value: false；with this parameter enabled, you will be charged double the price for the requestlearn more about how clickstream-based metrics are calculated in this help center articlen"
- `[].limit` — integer，可选。the maximum number of keywords in the results array；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned keywords；optional field；default value: 0；if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords；Note: we recommend using this parameter only when retrieving up to 10,000 results；for retrieving over 10,000 results, use the offset_token instead.
- `[].offset_token` — string，可选。offset token for subsequent requests；optional field；provided in the identical filed of the response to each request;；use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;；by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;；offset_token values are unique for each subsequent task；Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task.；learn more about this parameter on our Help Center
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, match, not_match, ilike, not_ilike, like, not_like；you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters；note that you can not filter the results by relevance；example:；["keyword_info.search_volume","&gt;",0]；for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting parameterdefault rule:；["relevance,desc"]；relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. Note that relevance is only our internal system identifier, so it can not be used as a filter, and you will not find this field in the result array. The relevance score is based on a similar principle as used in the Keywords For Keywords endpoint.note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["relevance,desc","keyword_info.search_volume,desc"]
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "target": "apple.com",
    "language_code": "en",
    "location_code": "2840",
    "include_serp_info": "true",
    "include_subdomains": "true",
    "filters": [
      "serp_info.se_results_count",
      ">",
      "0"
    ],
    "limit": "3"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/page_intersection/live

ID: `GooglePageIntersectionLive`
用途: ‌ This endpoint will provide you with the keywords for which specified pages rank within the same SERP. You will get search volume, competition, cost-per-click data on each intersecting keyword. Along with that, you will get data on SERP elements that specified pages rank for in search results, as well as the estimated traffic volume and cost of ad traffic. Page Intersection endpoint supports organic, paid, local pack and featured snippet results.
中文补充: **POST** `/v3/dataforseo_labs/google/page_intersection/live`

请求体: `application/json`

请求字段:
- `[].pages` — object，可选。target URLs of pages；required field；you can set up to 20 pages in this object；the pages should be specified with absolute URLs (including http:// or https://)；example:；`"pages": {`；`"1":"https://www.apple.com/mac/*",`；`"2":"https://dataforseo.com/*",`；`"3":"https://support.microsoft.com/"`；`}`if you specify a single page here, we will return results only for this page;；you can also use a wildcard ('*') character to specify the search pattern；example:；"example.com"；search for the exact URL；"example.com/eng/*"；search for the example.com page and all its related URLs which start with '/eng/', such as "example.com/eng/index.html" and "example.com/eng/help/", etc.；note: a wilcard should be placed after the slash ('/') character in the end of the URL, it is not possible to place it after the domain in the following way:；`https://dataforseo.com`*；use `https://dataforseo.com`/* insteadNote: this endpoint will not provide results if the number of intersecting keywords exceeds 10 million
- `[].exclude_pages` — array<string>，可选。URLs of pages you want to exclude；optional field；you can set up to 10 pages in this array；if you use this array, results will contain the keywords for which URLs from the pages object rank, but URLs from exclude_pages array do not;note that if you specify this field, the results will be based on the keywords any URL from pages ranks for regardless of intersections between them. However, you can set intersection_mode to intersect and results will contain the keywords all URLs from pages rank for in the same SERP and URLs from exclude_pages do not. ；use a wildcard ('&ast;') character to specify the search pattern；example:；`"exclude_pages":`；`["https://www.apple.com/iphone/&ast;",`；`"https://dataforseo.com/apis/&ast;",`；`"https://www.microsoft.com/en-us/industry/services/"]`
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；United Kingdom
- `[].location_code` — integer，可选。location code；required field if you don't specify location_name；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；English
- `[].language_code` — string，可选。language code；required field if you don't specify language_name；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；en
- `[].item_types` — array<string>，可选。search results type；indicates type of search results included in the response；optional fieldpossible values: ；["organic", "paid", "featured_snippet", "local_pack"]；default value: ；["organic", "paid"]
- `[].limit` — integer，可选。the maximum number of returned keywords；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the items array of returned keywords；optional field；default value: 0；if you specify 10 here, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
- `[].include_subdomains` — boolean，可选。indicates if the subdomains will be included in the search；optional field；if set to false, the subdomains will be ignored；default value: true
- `[].intersection_mode` — string，可选。indicates whether to intersect keywords；optional field；use this field to intersect or merge results for the specified URLspossible values: union, intersectunion - results are based on all keywords any URL from pages rank for;intersect - results are based on the keywords all URLs from pages rank for in the same SERP:by default, results are based on the intersect mode if you specify only pages array. If you specify exclude_pages as well, results are based on the union mode
- `[].include_serp_info` — boolean，可选。include data from SERP for each keyword；optional field；if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response；default value: false
- `[].include_clickstream_data` — boolean，可选。include or exclude data from clickstream-based metrics in the result；optional field；if the parameter is set to true, you will receive clickstream_keyword_info, clickstream_etv, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response；default value: false；with this parameter enabled, you will be charged double the price for the requestlearn more about how clickstream-based metrics are calculated in this help center article
- `[].ignore_synonyms` — boolean，可选。ignore highly similar keywords；optional field；if set to true only core keywords will be returned, all highly similar keywords will be excluded; ；default value: false
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, ilike, not_ilike, like, not_like, match, not_match；you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters；note that if you want to filter by any field in the intersection_result array you need to specify the number of corresponding page；for instance, if you want to filter results by the ranking of the first specified URL, you should set the following filter:；[intersection_result.1.rank_absolute,"=",1]；if you want to filter results and receive only organic listings for the third specified URL, you should set the following filter:；[intersection_result.3.type,"=","organic"] , etc.example:；["keyword_data.keyword_info.search_volume","in",[100,1000]]；[["intersection_result.1.etv","&gt;",0],"and",["intersection_result.1.description","like","%goat%"]][["keyword_data.keyword_info.search_volume","&gt;",100],；"and",；[["intersection_result.2.description","like","%goat%"],；"or",；["intersection_result.2.type","=","organic"]]]；for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting parameter；example:；["keyword_data.keyword_info.competition,desc"]；default rule:；["keyword_data.keyword_info.search_volume,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["intersection_result.1.rank_group,asc","intersection_result.2.rank_absolute,asc"]
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "pages": {
      "1": "https://forbes.com",
      "2": "https://cnn.com/*"
    },
    "language_name": "English",
    "location_code": "2840",
    "include_serp_info": "true",
    "limit": "3"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/ranked_keywords/live

ID: `GoogleRankedKeywordsLive`
用途: ‌ This endpoint will provide you with the list of keywords that any domain, subdomain, or webpage is ranking for. You will also get SERP elements related to the keyword position, as well as monthly searches and other data relevant to the returned keywords.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].target` — string，可选。domain name or page url；required field；the domain name of the target website, subdomain or URL of the target webpage;；the domain name must be specified without https:// or www.;；the subdomain must be specified without https://;；the webpage URL must be specified with https:// or www.；Note: if you specify the webpage URL without https:// or www., the result will be returned for the entire domain rather than the specific page
- `[].location_name` — string，可选。full name of the location；optional field；if you use this field, you don't need to specify location_code；you can receive the list of available locations with their location_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available locations；example:；United Kingdom
- `[].location_code` — integer，可选。location code；optional field；if you use this field, you don't need to specify location_name；you can receive the list of available locations with their location_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available locations；example:；2840
- `[].language_name` — string，可选。full name of the language；optional field；if you use this field, you don't need to specify language_code；you can receive the list of available languages with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available languages；example:；English
- `[].language_code` — string，可选。language code；optional field；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available languages；example:；en
- `[].ignore_synonyms` — boolean，可选。ignore highly similar keywords；optional field；if set to true only core keywords will be returned, all highly similar keywords will be excluded; ；default value: false
- `[].item_types` — array<string>，可选。display results by item type；optional field；indicates the type of search results included in the responseNote: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;possible values: ；["organic", "paid", "featured_snippet", "local_pack", "ai_overview_reference"]；default value: ；["organic", "paid"]
- `[].include_clickstream_data` — boolean，可选。include or exclude data from clickstream-based metrics in the result；optional field；if the parameter is set to true, you will receive clickstream_keyword_info, clickstream_etv, clickstream_gender_distribution, clickstream_age_distribution, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response；default value: false；with this parameter enabled, you will be charged double the price for the requestlearn more about how clickstream-based metrics are calculated in this help center article
- `[].limit` — integer，可选。the maximum number of returned keywords；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned keywords；optional field；default value: 0；if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
- `[].load_rank_absolute` — boolean，可选。return rankings distribution by rank_absolute；optional field；default value: false；if set to true, we will return the field metrics_absolute containing rankings distribution by the rank_absolute parameter that indicates the result’s position among all SERP elements
- `[].historical_serp_mode` — string，可选。data collection mode；optional field；you can use this field to filter the results;；possible types of filtering:；live — return keywords for which the specified target currently has ranking results in SERP;；lost — return keywords for which the specified target had previously had ranking results in SERP, but didn't have them during the last check;；all — return both types of keywords.；default value: live
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, match, not_match, ilike, not_ilike, like, not_like；you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters；example:；["ranked_serp_element.serp_item.rank_group","&lt;=",10][["ranked_serp_element.serp_item.rank_group","&lt;=",10],；"and",；["ranked_serp_element.serp_item.type","&lt;&gt;","paid"]][["keyword_data.keyword_info.search_volume","&lt;&gt;",0],；"and",；[["ranked_serp_element.serp_item.type","&lt;&gt;","paid"],"or",["ranked_serp_element.serp_item.is_malicious","=",false]]]if you want to get the keywords a particular webpage ranks for, you can use a target field or filter by the ranked_serp_element.serp_item.relative_url parameter；example:；["ranked_serp_element.serp_item.relative_url", "=", "/apis/rank-tracker-api"]；for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["keyword_data.keyword_info.competition,desc"]；default rule:；["ranked_serp_element.serp_item.rank_group,asc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["keyword_data.keyword_info.search_volume,desc","keyword_data.keyword_info.cpc,desc"]
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "target": "dataforseo.com",
    "language_name": "English",
    "location_name": "United States",
    "load_rank_absolute": "true",
    "limit": "3"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/related_keywords/live

ID: `GoogleRelatedKeywordsLive`
用途: The Related Keywords endpoint provides keywords appearing in the “Searches Related to” SERP element. View the element. You can get up to 4680 keyword ideas by specifying the search depth. Each related keyword comes with the list of relevant product categories, search volume rate for the last month, search volume trend for the previous 12 months, as well as current cost-per-click and competition values.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；UTF-8 encoding；the keywords will be converted to lowercase formatlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；United Kingdom
- `[].location_code` — integer，可选。location code；required field if you don't specify location_name；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；Note: it is required to specify either language_name or language_code；you can receive the list of available locations with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；English
- `[].language_code` — string，可选。language code；required field if you don't specify language_name；Note: it is required to specify either language_name or language_code；you can receive the list of available locations with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；en
- `[].depth` — integer，可选。keyword search depth；optional field；default value: 1number of the returned results depends on the value you set in this field；you can specify a level from 0 to 4；estimated number of keywords for each level (maximum):；0 - the keyword set in the keyword field；1 – 8 keywords；2 – 72 keywords；3 – 584 keywords；4 – 4680 keywords
- `[].include_seed_keyword` — boolean，可选。include data for the seed keyword；optional field；if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response；default value: false
- `[].include_serp_info` — boolean，可选。include data from SERP for each keyword；optional field；if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response；default value: false
- `[].include_clickstream_data` — boolean，可选
- `[].ignore_synonyms` — boolean，可选
- `[].replace_with_core_keyword` — boolean，可选。return data for core keyword；optional field；if true, serp_info and related_keywords will be returned for the main keyword in the group that the specified keyword belongs to;；if false, serp_info and related_keywords will be returned for the specified keyword (if available);；refer to this help center article for more details;；default value: false
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, match, not_match, ilike, not_ilike, like,not_like；you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters；example:；["keyword_data.keyword_info.search_volume","&gt;",0][["keyword_info.search_volume","in",[0,1000]],；"and",；["keyword_data.keyword_info.competition_level","=","LOW"]][["keyword_data.keyword_info.search_volume","&gt;",100],；"and",；[["keyword_data.keyword_info.cpc","&lt;",0.5],；"or",["keyword_info.high_top_of_page_bid","&lt;=",0.5]]]；for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["keyword_data.keyword_info.competition,desc"]；default rule:；["keyword_data.keyword_info.search_volume,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["keyword_data.keyword_info.search_volume,desc","keyword_data.keyword_info.cpc,desc"]
- `[].limit` — integer，可选。the maximum number of returned keywords；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned keywords；optional field；default value: 0；if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "keyword": "phone",
    "language_name": "English",
    "location_code": "2840",
    "limit": "3"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/relevant_pages/live

ID: `GoogleRelevantPagesLive`
用途: ‌
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].target` — string，可选。domain；required field；the domain name of the target website；the domain should be specified without https:// and www.
- `[].location_name` — string，可选。full name of the location；optional field；if you use this field, you don't need to specify location_code；you can receive the list of available locations with their location_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available locations；example:；United Kingdom
- `[].location_code` — integer，可选。location code；optional field；if you use this field, you don't need to specify location_name；you can receive the list of available locations with their location_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available locations；example:；2840
- `[].language_name` — string，可选。full name of the language；optional field；if you use this field, you don't need to specify language_code；you can receive the list of available languages with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available languages；example:；English
- `[].language_code` — string，可选。language code；optional field；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available languages；example:；en
- `[].item_types` — array<string>，可选。display results by item type；optional field；indicates the type of search results included in the responseNote: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;possible values: ；["organic", "paid", "featured_snippet", "local_pack"]；default value: ；["organic", "paid"]
- `[].include_clickstream_data` — boolean，可选。include or exclude data from clickstream-based metrics in the result；optional field；if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response；default value: false；with this parameter enabled, you will be charged double the price for the requestlearn more about how clickstream-based metrics are calculated in this help center article
- `[].limit` — integer，可选。the maximum number of returned pages；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned pages；optional field；default value: 0；if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages
- `[].historical_serp_mode` — string，可选。data collection mode；optional field；you can use this field to filter the results;；possible types of filtering:；live — return metrics for SERPs in which the specified target currently has ranking results;；lost — return metrics for SERPs in which the specified target had previously had ranking results, but didn't have them during the last check;；all — return metrics for both types of SERPs.；default value: live
- `[].ignore_synonyms` — boolean，可选。ignore highly similar keywords；optional field；if set to true, only core keywords will be returned, all highly similar keywords will be excluded; ；default value: false
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_inexample:；["metrics.paid.count","&gt;",0][["metrics.organic.count","&gt;",50],"and",["metrics.organic.pos_1","&lt;&gt;",0]][[""metrics.organic.count","&gt;",50"],；"and",；[["metrics.organic.pos_1","&lt;&gt;",0],"or",["metrics.organic.pos_2_3","&lt;&gt;",0]]]；for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to specify a sorting type；example:；["metrics.paid.etv,asc"]；Note: you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["metrics.organic.etv,desc","metrics.paid.count,asc"]default rule:；["metrics.organic.count,desc"]；Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "target": "amazon.com",
    "language_name": "English",
    "location_code": "2840",
    "filters": [
      [
        "metrics.organic.pos_1",
        "<>",
        "0"
      ],
      "or",
      [
        "metrics.organic.pos_2_3",
        "<>",
        "0"
      ]
    ],
    "limit": "3"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/search_intent/live

ID: `GoogleSearchIntentLive`
用途: ‌ This endpoint will provide you with search intent data for up to 1,000 keywords. For each keyword that you specify when setting a task, the API will return the keyword’s search intent and intent probability. Besides the highest probable search intent, the results will also provide you with other likely search intent(s) and their probability.
中文补充: **POST** `https://api.seermartech.cn/v3/dataforseo_labs/google/search_intent/live`

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。target keywords；required field；UTF-8 encoding；maximum number of keywords you can specify in this array: 1000;；the keywords will be converted to lowercase formatlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].language_name` — string，可选。full name of the language；required field if don't specify language_code；you can receive the list of available languages with their language_name by making a separate request to https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；；Note: this endpoint currently supports the following languages only:；Arabic, ar,；Chinese(Traditional), zh-TW,；Czech, cs,；Danish, da,；Dutch, nl,；English, en,；Finnish, fi,；French, fr,；German, de,；Hebrew, he,；Hindi, hi,；Italian, it,；Japanese, ja,；Korean, ko,；Malay, ms,；Norwegian(Bokmål), nb,；Polish, pl,；Portuguese, pt,；Romanian, ro,；Russian, ru,；Spanish, es,；Swedish, sv,；Thai, th,；Ukrainian, uk,；Vietnamese, vi,；Bulgarian, bg,；Croatian, hr,；Serbian, sr,；Slovenian, sl,；Bosnian, bs,；Greek, el,；Hungarian, hu,；Slovak, sk,；Turkish, trexample:；English
- `[].language_code` — string，可选。language code；required field if don't specify language_name；you can receive the list of available languages with their language_code by making a separate request to https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；Note: this endpoint currently supports these languages only;；example:；en
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "keywords": [
      "login page",
      "audi a7",
      "elon musk",
      "milk store new york"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/serp_competitors/live

ID: `GoogleSerpCompetitorsLive`
用途: ‌ This endpoint will provide you with a list of domains ranking for the keywords you specify. You will also get SERP rankings, rating, estimated traffic volume, and visibility values the provided domains gain from the specified keywords.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。keywords array；required field；the results will be based on the keywords you specify in this array；UTF-8 encoding;；the keywords will be converted to lowercase format;；you can specify the maximum of 200 keywordslearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with location_name parameters by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；United Kingdom
- `[].location_code` — integer，可选。unique location identifier；required field if you don't specify location_name；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_code parameters by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_name parameters by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；English
- `[].language_code` — string，可选。unique language identifier；required field if you don't specify language_name；Note: it is required to specify either language_name or language_code；you can receive the list of available languages with their language_code parameters by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；en
- `[].include_subdomains` — boolean，可选。indicates if the subdomains will be included in the search；optional field；if set to false, the subdomains will be ignored；default value: true
- `[].item_types` — array<string>，可选。search results type；indicates type of search results included in the response；optional fieldpossible values: ；["organic", "paid", "featured_snippet", "local_pack"]；default value: ；["organic", "paid"]
- `[].limit` — integer，可选。the maximum number of returned domains；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned domains；optional field；default value: 0；if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, match, not_match, ilike, not_ilike, like, not_like；you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters；example:；["median_position","in",[1,10]][["median_position","in",[1,10]],"and",["domain","not_like","%wikipedia.org%"]][["domain","not_like","%wikipedia.org%"],；"and",；[["relevant_serp_items","&gt;",0],"or",["median_position","in",[1,10]]]]；for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；the comma is used as a separator；example:；["avg_position,asc"]；default rule:；["rating,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["avg_position,asc","etv,desc"]
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "keywords": [
      "phone"
    ],
    "language_name": "English",
    "location_code": "2840",
    "item_types": [
      "organic"
    ],
    "limit": "5"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/subdomains/live

ID: `GoogleSubdomainsLive`
用途: ‌‌ This endpoint will provide you with a list of subdomains of the specified domain, along with the ranking distribution across organic and paid search. In addition to that, you will also get the estimated traffic volume of subdomains based on search volume and impressions.
中文补充: **POST** `https://api.seermartech.cn/v3/dataforseo_labs/google/subdomains/live`

请求体: `application/json`

请求字段:
- `[].target` — string，可选。domain；required field；the domain name of the target website；the domain should be specified without https:// and www.
- `[].location_name` — string，可选。full name of the location；optional field；if you use this field, you don't need to specify location_code；you can receive the list of available locations with their location_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available locations；example:；United Kingdom
- `[].location_code` — integer，可选。location code；optional field；if you use this field, you don't need to specify location_name；you can receive the list of available locations with their location_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available locations；example:；2840
- `[].language_name` — string，可选。full name of the language；optional field；if you use this field, you don't need to specify language_code；you can receive the list of available languages with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available languages；example:；English
- `[].language_code` — string，可选。language code；optional field；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；ignore this field to get the results for all available languages；example:；en
- `[].item_types` — array<string>，可选。display results by item type；optional field；indicates the type of search results included in the responseNote: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;possible values: ；["organic", "paid", "featured_snippet", "local_pack"]；default value: ；["organic", "paid"]
- `[].include_clickstream_data` — boolean，可选。include or exclude data from clickstream-based metrics in the result；optional field；if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response；default value: false；with this parameter enabled, you will be charged double the price for the requestlearn more about how clickstream-based metrics are calculated in this help center article
- `[].historical_serp_mode` — string，可选。data collection mode；optional field；you can use this field to filter the results;；possible types of filtering:；live — return metrics for SERPs in which the specified target currently has ranking results;；lost — return metrics for SERPs in which the specified target had previously had ranking results, but didn't have them during the last check;；all — return metrics for both types of SERPs.；default value: live
- `[].ignore_synonyms` — boolean，可选。ignore highly similar keywords；optional field；if set to true, only core keywords will be returned, all highly similar keywords will be excluded; ；default value: false
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in；example:；["metrics.paid.count","&gt;",0][["metrics.paid.count","&gt;",0],"and",["metrics.paid.etv","&gt;","50"]][["metrics.organic.count","&gt;","10"],；"and",；[["metrics.organic.pos_1","&lt;&gt;",0],"or",["metrics.organic.pos_2_3","&lt;&gt;",0]]]；for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to specify a sorting type；example:；["metrics.paid.etv,asc"]；Note: you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["metrics.organic.etv,desc","metrics.paid.count,asc"]default rule:；["metrics.organic.count,desc"]；Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array
- `[].limit` — integer，可选。the maximum number of returned keywords；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned keywords；optional field；default value: 0；if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "target": "dataforseo.com",
    "language_name": "English",
    "location_code": "2840",
    "filters": [
      [
        "metrics.organic.pos_1",
        "<>",
        "0"
      ],
      "or",
      [
        "metrics.organic.pos_2_3",
        "<>",
        "0"
      ]
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/google/top_searches/live

ID: `GoogleTopSearchesLive`
用途: ‌‌ The Top Searches endpoint of DataForSEO Labs API can provide you with over 7 billion keywords from the DataForSEO Keyword Database. Each keyword in the API response is provided with a set of relevant keyword data with Google Ads metrics, product categories, and Google SERP data.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；United Kingdom
- `[].location_code` — integer，可选。location code；required field if you don't specify location_name；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；2840
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；Note: it is required to specify either language_name or language_code；you can receive the list of available locations with their language_name by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；English
- `[].language_code` — string，可选。language code；required field if you don't specify language_name；Note: it is required to specify either language_name or language_code；you can receive the list of available locations with their language_code by making a separate request to the ；https://api.seermartech.cn/v3/dataforseo_labs/locations_and_languages；example:；en
- `[].include_serp_info` — boolean，可选。include data from SERP for each keyword；optional field；if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response；default value: false
- `[].include_clickstream_data` — boolean，可选。include or exclude data from clickstream-based metrics in the result；optional field；if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response；default value: false；with this parameter enabled, you will be charged double the price for the requestlearn more about how clickstream-based metrics are calculated in this help center article
- `[].ignore_synonyms` — boolean，可选。ignore highly similar keywords；optional field；if set to true only core keywords will be returned, all highly similar keywords will be excluded; ；default value: false
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, match, not_match, ilike, not_ilike, like,not_like；you can use the % operator with like and not_like,as well as ilike and not_ilike to match any string of zero or more characters；example:；["keyword_info.search_volume","&gt;",0][["keyword_info.search_volume","in",[0,1000]],；"and",；["keyword_info.competition_level","=","LOW"]][["keyword_info.search_volume","&gt;",100],；"and",；[["keyword_info.cpc","&lt;",0.5],；"or",["keyword_info.high_top_of_page_bid","&lt;=",0.5]]]；for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["keyword_info.competition,desc"]；default rule:；["keyword_info.search_volume,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["keyword_info.search_volume,desc","keyword_info.cpc,desc"]
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].limit` — integer，可选。the maximum number of returned keywords；optional field；note: you can get more than 1000 results by using the offset_token provided in the response to each subsequent request；default value: 1000；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned keywords；optional field；default value: 0；if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords；Note: we recommend using this parameter only when retrieving up to 10,000 results；for retrieving over 10,000 results, use the offset_token instead.
- `[].offset_token` — string，可选。offset token for subsequent requests；optional field；provided in the identical filed of the response to each request;；use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;；by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;；offset_token values are unique for each subsequent task ；Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task.；learn more about this parameter on our Help Center

最小请求示例:

```json
[
  {
    "language_name": "English",
    "location_code": "2840",
    "limit": "3"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/dataforseo_labs/id_list

ID: `DataforseoLabsIdList`
用途: This endpoint is designed to provide you with a list of IDs and metadata for all DataForSEO Labs tasks created within the specified time period, including both successful and uncompleted tasks.
中文补充: 本接口用于获取指定时间范围创建的所有 Labs 任务 ID 及数据已成功完成和未完成的任务。

请求体: `application/json`

请求字段:
- `[].datetime_from` — string，可选。start time for filtering results；required field；if include_metadata is set to true, maximum value: a month from current datetime;；if include_metadata is set to false, maximum value: six months from current datetime;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2023-01-15 12:57:46 +00:00
- `[].datetime_to` — string，可选。finish time for filtering results；required field；maximum value: current datetime;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2023-01-31 13:57:46 +00:00
- `[].limit` — integer，可选。the maximum number of returned task IDs；optional field；default value: 1000；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned task IDs；optional field；default value: 0；if you specify the 10 value, the first ten tasks in the results array will be omitted
- `[].sort` — string，可选。sorting by task execution time；optional field；possible values: "asc", "desc"；default value: "asc"
- `[].include_metadata` — boolean，可选。include task metadata in the respond；optional field；default value: false

最小请求示例:

```json
[
  {
    "datetime_from": "2026-08-01 17:42:44",
    "datetime_to": "2026-08-11 17:42:44",
    "limit": "10",
    "include_metadata": "true"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/dataforseo_labs/locations_and_languages

ID: `LocationsAndLanguages`
用途: ‌ Using this endpoint you can get the full list of locations and languages supported in DataForSEO Labs API. Available sources currently include Google, Bing, and Amazon search engines. However, you should note that Amazon and Bing locations and languages are currently limited to the US/English.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/dataforseo_labs/status

ID: `Status`
用途: ‌ By calling this endpoint, you will find out when the DataForSEO Labs data was last updated. The API response will provide separate update dates for the Google, Bing, and Amazon endpoints of DataForSEO Labs API.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/domain_analytics/errors

ID: `DomainAnalyticsErrors`
用途: By calling this endpoint you will receive information about the Domain Analytics API tasks that returned an error within the past 7 days.
中文补充: 本接口使用 **POST** 方法，请求路径为 **`/v3/domain_analytics/errors`**。用于查询过去 7 天 Domain Analytics API 中返回错误的任务。

请求体: `application/json`

请求字段:
- `[].limit` — integer，可选。the maximum number of returned tasks that responded with an error；optional field；default value: 1000；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned tasks；optional field；default value: 0；if you specify the 10 value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks
- `[].filtered_function` — string，可选。return tasks with a certain function；use this field to obtain a list of tasks that returned an error filtered by a certain function；you can filter the results by the values you receive in the function fields of the API response；i.e., once you receive unfiltered results, you can call this API again to filter them by function ；example: domain_analytics/task_get, postback_url, pingback_url
- `[].datetime_from` — string，可选。start time for filtering results；optional field；allows filtering results by the datetime parameter within the range of the last 7 days;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2021-11-15 12:57:46 +00:00
- `[].datetime_to` — string，可选。finish time for filtering results；optional field；allows filtering results by the datetime parameter within the range of the last 7 days;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2021-11-15 13:57:46 +00:00

最小请求示例:

```json
[
  {
    "limit": "10",
    "offset": "0",
    "filtered_function": "pingback_url"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/domain_analytics/id_list

ID: `DomainAnalyticsIdList`
用途: This endpoint is designed to provide you with a list of IDs and metadata for all Domain Analytics tasks created within the specified time period, including both successful and uncompleted tasks.
中文补充: 本接口使用 **POST** 方法，请求路径为 `/v3/domain_analytics/id_list`。用于查询指定时间范围创建的 Domain Analytics 任务 ID 及数据，结果同时已完成和未完成的任务。

请求体: `application/json`

请求字段:
- `[].datetime_from` — string，可选。start time for filtering results；required field；if include_metadata is set to true, maximum value: a month from current datetime;；if include_metadata is set to false, maximum value: six months from current datetime;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2023-01-15 12:57:46 +00:00
- `[].datetime_to` — string，可选。finish time for filtering results；required field；maximum value: current datetime;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2023-01-31 13:57:46 +00:00
- `[].limit` — integer，可选。the maximum number of returned task IDs；optional field；default value: 1000；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned task IDs；optional field；default value: 0；if you specify the 10 value, the first ten tasks in the results array will be omitted
- `[].sort` — string，可选。sorting by task execution time；optional field；possible values: "asc", "desc"；default value: "asc"
- `[].include_metadata` — boolean，可选。include task metadata in the respond；optional field；default value: false

最小请求示例:

```json
[
  {
    "datetime_from": "2026-08-01 17:42:44",
    "datetime_to": "2026-08-11 17:42:44",
    "limit": "10",
    "include_metadata": "true"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/domain_analytics/technologies/aggregation_technologies/live

ID: `TechnologiesAggregationTechnologiesLive`
用途: ‌‌ The Aggregation Technologies endpoint will provide you with a list of the most popular technologies websites use alongside the technologies you specify. Alternatively, you can specify technology categories or groups to obtain wider stats.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].group` — string，可选。id of the target technology group；required field if you don't specify technology, category or keyword；at least one field (group, category, keyword, technology) must be set；you can find the full list of technology group ids on this page；example:；"marketing"
- `[].category` — string，可选。id of the target technology category；required field if you don't specify group, keyword or technology；at least one field (group, category, keyword, technology) must be set；you can find the full list of technology category ids on this page；example:；"crm"
- `[].technology` — string，可选。target technology；required field if you don't specify group, keyword or category；at least one field (group, category, keyword, technology) must be set；you can find the full list of technologies on this page；example:；"Salesforce"
- `[].keyword` — string，可选。target keyword in the domain's meta keywords；required field if you don't specify group, category or technology；at least one field (group, category, keyword, technology) must be set；UTF-8 encoding；example:；"seo"learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].mode` — string，可选。search mode；optional field；possible search mode types:；as_is - search for results exactly matching the specified group ids, category ids, or technology names；entry - search for results matching a part of the specified group ids, category ids, or technology names；default value: as_is
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；&lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, like,not_like；you can use the % operator with like and not_like to match any string of zero or more characters；you can use the following parameters to filter the results: domain_rank, last_visited, country_iso_code, language_code, content_language_code；Note: all filtering parameters are taken from the domain_technology_item of the domain_technologies endpoint;；example:；[["country_iso_code","=","US"],；"and",；["domain_rank","&gt;",800]]for more information about filters, please refer to Domain Analytics Technologies API - Filters
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the following values to sort the results: groups_count, categories_count, technologies_count；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["groups_count,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["groups_count,desc","technologies_count,desc"]；default value:；["groups_count,desc","categories_count,desc","technologies_count,desc"]
- `[].internal_groups_list_limit` — integer，可选。maximum number of returned technology groups；optional field；you can use this field to limit the number of items with identical "group" in the results；default value: 5；minimum value: 1；maximum value: 10000
- `[].internal_categories_list_limit` — integer，可选。maximum number of returned technology categories within the same group；optional field；you can use this field to limit the number of items with identical "category" in the results；default value: 5；minimum value: 1；maximum value: 10000
- `[].internal_technologies_list_limit` — integer，可选。maximum number of returned technologies within the same category；optional field；you can use this field to limit the number of items with identical "technology" in the results；default value: 10；minimum value: 1；maximum value: 10000
- `[].internal_list_limit` — integer，可选。maximum number of items with identical "category", "group", and "technology"；optional field；if you use this field, the values specified in internal_groups_list_limit, internal_categories_list_limit and internal_technologies_list_limit will be ignored;；you can use this field to limit the number of items with identical "category", "group", or "technology"；default value: 10；minimum value: 1；maximum value: 10000
- `[].limit` — integer，可选。the maximum number of returned technologies；optional field；default value: 100；maximum value: 10000
- `[].offset` — integer，可选。offset in the results array of returned domains；optional field；default value: 0；maximum value: 9999；if you specify the 10 value, the first ten technologies in the results array will be omitted and the data will be provided for the successive technologies
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "mode": "entry",
    "technology": "Nginx",
    "keyword": "WordPress",
    "filters": [
      [
        "country_iso_code",
        "=",
        "US"
      ],
      "and",
      [
        "domain_rank",
        ">",
        "800"
      ]
    ],
    "order_by": [
      "groups_count,desc"
    ],
    "limit": "10"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/domain_analytics/technologies/available_filters

ID: `TechnologiesAvailableFilters`
用途: ‌‌ Here you will find all the necessary information about filters that can be used with Domain Analytics Technologies API endpoints.
中文补充: 本页说明 Domain Analytics Technologies 接口可使用的过滤器，以及如何获取完整的可用过滤字段和操作符列表。

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/domain_analytics/technologies/domain_technologies/live

ID: `TechnologiesDomainTechnologiesLive`
用途: ‌‌ Using this endpoint you will get a list of technologies used in a particular domain.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].target` — string，可选。target domain；required field；domain name of the website to analyze；Note: results will be returned for the specified domain only

最小请求示例:

```json
[
  {
    "target": "dataforseo.com"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/domain_analytics/technologies/domains_by_html_terms/live

ID: `TechnologiesDomainsByHtmlTermsLive`
用途: ‌‌ This endpoint provides domains based on the HTML terms they use on their homepage. In addition to the list of domains, you will also get their technology profiles, the country and language they belong to, and other related data.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].search_terms` — array<string>，可选。target search terms；required field；specify target HTML elements, tags, attributes, their content or all of the above；if you specify more than one search term, you will receive only the domains containing all of the specified terms in the HTML code of their homepage；maximum number of search terms you can specify: 10；example:；["data-attrid"]
- `[].keywords` — array<string>，可选。target keywords in the domain's title, description or meta keywords；optional field；UTF-8 encoding；maximum number of keywords you can specify: 10 ；example:；["seo","software"]learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].mode` — string，可选。search mode；optional field；possible search mode types:；strict_entry - search for results exactly matching the order, intervals and separators in the specified search terms；entry - search for results ignoring the order, intervals and separators in the specified search terms；default value: entry
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；&lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, like, not_like；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["domain","like","%seo%"][["country_iso_code","=","US"],；"and",；["domain_rank","&gt;",100]][["domain_rank","&gt;",100],；"and",；[["country_iso_code","=","US"],"or",["country_iso_code","=","CA"]]]for more information about filters, please refer to Domain Analytics Technologies API - Filters
- `[].order_by` — array<string>，可选。results sorting rules；optional field；available fields: ；domain_rank, domain, last_visited, country_iso_code, language_code, content_language_code；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["last_visited,desc"]；default rule:；["domain_rank,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["last_visited,desc","domain_rank,desc"]
- `[].limit` — integer，可选。the maximum number of returned domains；optional field；default value: 100；maximum value: 10000
- `[].offset` — integer，可选。offset in the results array of returned domains；optional field；default value: 0；if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains;；Note: the maximum value is 9999, the sum of limit and offset must not exceed 10000;；use the offset_token if you would like to offset more results
- `[].offset_token` — string，可选。token for subsequent requests；optional field；provided in the identical filed of the response to each request;；use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;；by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;；offset_token values are unique for each subsequent task ；Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request；learn more about this parameter on our Help Center

最小请求示例:

```json
[
  {
    "search_terms": [
      "data-attrid"
    ],
    "order_by": [
      "last_visited,desc"
    ],
    "limit": "10",
    "offset": "0"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/domain_analytics/technologies/domains_by_technology/live

ID: `TechnologiesDomainsByTechnologyLive`
用途: ‌‌ This endpoint provides domains based on the technology they use. In addition to the list of domains, you will also get their technology profiles, the country and language they belong to, and other related data.
中文补充: 本接口通过指定技术、技术分类、技术组或，查找使用技术的网站域名，并返回域名的技术画像、所属国家和语言、网站数据、联系信息及数据。

请求体: `application/json`

请求字段:
- `[].technology_paths` — array<string>，可选。target technology paths；required field if you don't specify groups, technologies, keywords or categories；at least one field (technology_paths, groups, technologies, keywords or categories) must be set;；each technology path should be specified as a separate object containing "path" and "name", where "path" is specified as "$group_id.$category_id" and "name" - as the name of the target technology; ；each object with a technology path should be separated with a comma；you can find the full list of technology group ids, category ids and technology names on this page；note: you can specify up to 10 technology paths in this array；example:；[{"path": "content.cms","name": "wordpress"}, {"path": "marketing.crm","name": "salesforce"}]
- `[].groups` — array<string>，可选。ids of the target technology groups；required field if you don't specify technologies, technology_paths, keywords or categories；you can find the full list of technology group ids on this page；note: you can specify up to 10 technology groups in this array；example:；["sales", "marketing"]
- `[].categories` — array<string>，可选。ids of the target technology categories；required field if you don't specify groups, technology_paths, keywords or technologies；you can find the full list of technology category ids on this page；note: you can specify up to 10 technology categories in this array；example:；["payment_processors","crm"]
- `[].technologies` — array<string>，可选。target technologies；required field if you don't specify groups, technology_paths, keywords or categories；you can find the full list of technologies you can specify here on this page；note: you can specify up to 10 technologies in this array；example:；["Google Pay","Salesforce"]
- `[].keywords` — array<string>，可选。target keywords in the domain's title, description or meta keywords；required field if you don't specify groups, technology_paths, technologies or categories；optional field；you can specify the maximum of 10 keywords;；UTF-8 encoding;；example:；["seo","software"]learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].mode` — string，可选。search mode；optional field；possible search mode types:；as_is - search for results exactly matching the specified group ids, category ids, or technology names；entry - search for results matching a part of the specified group ids, category ids, or technology names；default value: as_is
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；&lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, like, not_like；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["country_iso_code","=","US"][["country_iso_code","=","US"],；"and",；["domain_rank","&gt;",100]][["domain_rank","&gt;",100],；"and",；[["country_iso_code","=","US"],"or",["country_iso_code","=","CA"]]]for more information about filters, please refer to Domain Analytics Technologies API - Filters
- `[].order_by` — array<string>，可选。results sorting rules；optional field；available fields: ；domain_rank, domain, last_visited, country_iso_code, language_code, content_language_code；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["last_visited,desc"]；default rule:；["domain_rank,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["last_visited,desc","domain_rank,desc"]
- `[].limit` — integer，可选。the maximum number of returned domains；optional field；default value: 100；maximum value: 10000
- `[].offset` — integer，可选。offset in the results array of returned domains；optional field；default value: 0；if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains;；Note: the maximum value is 9999, the sum of limit and offset must not exceed 10000;；use the offset_token if you would like to offset more results
- `[].offset_token` — string，可选。token for subsequent requests；optional field；provided in the identical filed of the response to each request;；use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;；by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;；offset_token values are unique for each subsequent task ；Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request；learn more about this parameter on our Help Center

最小请求示例:

```json
[
  {
    "technologies": [
      "Nginx"
    ],
    "filters": [
      [
        "country_iso_code",
        "=",
        "US"
      ],
      "and",
      [
        "domain_rank",
        ">",
        "800"
      ]
    ],
    "order_by": [
      "last_visited,desc"
    ],
    "limit": "10"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/domain_analytics/technologies/languages

ID: `TechnologiesLanguages`
用途: You will receive the list of languages by calling this API. As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/domain_analytics/technologies/locations

ID: `TechnologiesLocations`
用途: You will receive the list of locations by this API call.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/domain_analytics/technologies/technologies

ID: `TechnologiesTechnologies`
用途: This endpoint will provide you with the full list of available technologies structured by technology groups and categories each particular technology belongs to.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/domain_analytics/technologies/technologies_summary/live

ID: `TechnologiesTechnologiesSummaryLive`
用途: ‌‌ The Technologies Summary endpoint will provide you with the number of domains across different countries and languages that use the specified technology names, technology groups, or technology categories.
中文补充: **POST** `https://api.seermartech.cn/v3/domain_analytics/technologies/technologies_summary/live`

请求体: `application/json`

请求字段:
- `[].technology_paths` — array<string>，可选。target technology paths；required field if you don't specify groups, technologies and categories；each technology path should be specified as a separate object containing "path" and "name", where "path" is specified as "$group_id.$category_id" and "name" - as the name of the target technology; ；each object with a technology path should be separated with a comma；you can find the full list of technology group ids, category ids and technology names on this page；note: you can specify up to 10 technology paths in this array；example:；[{"path": "content.cms","name": "wordpress"}, {"path": "marketing.crm","name": "salesforce"}]
- `[].groups` — array<string>，可选。ids of the target technology groups；required field if you don't specify technologies, technology_paths, categories, or keywords；you can find the full list of technology group ids on this page；note: you can specify up to 10 technology groups in this array；example:；["sales", "marketing"]
- `[].categories` — array<string>，可选。ids of the target technology categories；required field if you don't specify groups, technology_paths, technologies, or keywords；you can find the full list of technology category ids on this page；note: you can specify up to 10 technology categories in this array；example:；["payment_processors","crm"]
- `[].technologies` — array<string>，可选。target technologies；required field if you don't specify groups, technology_paths, categories, or keywords；you can find the full list of technologies you can specify here on this page；note: you can specify up to 10 technologies in this array；example:；["Google Pay","Salesforce"]
- `[].keywords` — array<string>，可选。target keywords in the domain's title, description or meta keywords；required field if you don't specify groups, technology_paths, categories, or technologies；you can specify the maximum of 10 keywords;；UTF-8 encoding;；example:；["seo","software"]learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].mode` — string，可选。search mode；optional field；possible search mode types:；as_is - search for results exactly matching the specified group ids, category ids, or technology names；entry - search for results matching a part of the specified group ids, category ids, or technology names；default value: as_is
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；&lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, like,not_like；you can use the % operator with like and not_like to match any string of zero or more characters；you can use the following parameters to filter the results: domain_rank, last_visited, country_iso_code, language_code, content_language_code；example:；[["country_iso_code","=","US"],；"and",；["domain_rank",">",800]]for more information about filters, please refer to Domain Analytics Technologies API - Filters
- `[].internal_list_limit` — integer，可选。maximum number of elements within internal arrays；optional field；you can use this field to limit the number of elements within the following arrays:；countries, languages, content_languages, keywords；default value: 10；minimum value: 1；maximum value: 10000
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "mode": "entry",
    "technologies": [
      "Ngi"
    ],
    "keywords": [
      "WordPress"
    ],
    "filters": [
      [
        "country_iso_code",
        "=",
        "US"
      ],
      "and",
      [
        "domain_rank",
        ">",
        "800"
      ]
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/domain_analytics/technologies/technology_stats/live

ID: `TechnologiesTechnologyStatsLive`
用途: ‌‌ The Technology Stats endpoint will provide you with historical data on the number of domains across different countries and languages that use the specified technology.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].technology` — string，可选。target technology；required field；you can find the full list of technologies you can specify here on this page；example:；"Salesforce"
- `[].date_from` — string，可选。starting date of the time range；optional field；minimum value: 2022-10-31；if you don't specify this field, the minimum value will be used by default；date format: "yyyy-mm-dd"；example:；"2023-06-01"
- `[].date_to` — string，可选。ending date of the time range；optional field；if you don't specify this field, the today's date will be used by default；date format: "yyyy-mm-dd"；example:；"2023-01-15"
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "technology": "jQuery",
    "date_from": "2022-10-31",
    "date_to": "2023-06-01"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/domain_analytics/whois/available_filters

ID: `WhoisAvailableFilters`
用途: ‌‌ Here you will find all the necessary information about filters that can be used with Domain Analytics Whois API.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/domain_analytics/whois/overview/live

ID: `WhoisOverviewLive`
用途: ‌ This endpoint will provide you with Whois data enriched with backlink stats, and ranking and traffic info from organic and paid search results. Using this endpoint you will be able to get all these data for the domains matching the parameters you specify in the request.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].limit` — integer，可选。the maximum number of returned domains；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned items；optional field；default value: 0；if you specify the 10 value, the first ten items in the results array will be omitted and the data will be provided for the successive items;；Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead
- `[].offset_token` — string，可选。token for subsequent requests；optional field；provided in the identical filed of the response to each request;；use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request;；by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;；offset_token values are unique for each subsequent task；Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request；learn more about this parameter on our Help Center
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, like, not_like；you can use the % operator with like and not_like to match any string of zero or more characters
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；the comma is used as a separator；example:；["metrics.organic.pos_1,desc"]；default rule:；["metrics.organic.count,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["expiration_datetime,asc","metrics.organic.etv,desc","metrics.organic.pos_1,desc"]
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "limit": "2",
    "filters": [
      [
        "epp_status_codes",
        "in",
        [
          "client_transfer_prohibited",
          "client_update_prohibited"
        ]
      ]
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/bing/audience_estimation/industries

ID: `BingAudienceEstimationIndustries`
用途: By calling this API you will receive the list of industries with industry_id supported by Bing Ads Audience Estimation endpoint.
中文补充: 本接口使用 **GET** 方法，路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/bing/audience_estimation/job_functions

ID: `BingAudienceEstimationJobFunctions`
用途: By calling this API you will receive the list of job functions with job_function_id supported by Bing Ads Audience Estimation endpoint.
中文补充: 本接口使用 **GET** 方法，路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/bing/audience_estimation/live

ID: `BingAudienceEstimationLive`
用途: This endpoint provides estimated audience size for an ad campaign based on specified targeting criteria. It returns data on the total estimated audience, such as suggested bid and budget for an ad campaign and estimated engagement metrics.
中文补充: **POST** `https://api.seermartech.cn/v3/keywords_data/bing/audience_estimation/live`

请求体: `application/json`

请求字段:
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius (in km)" format；the data will be provided for the country the specified coordinates belong to；example:；29.6821525,-82.4098881,100
- `[].age` — array<string>，可选。selection of age ranges for targeting；possible values: eighteen_to_twenty_four, fifty_to_sixty_four, sixty_five_and_above, thirteen_to_seventeen, thirty_five_to_forty_nine, twenty_five_to_thirty_four, unknown, zero_to_twelve
- `[].bid` — number，可选。desired bid setting value in USD；maximum value: 1000
- `[].daily_budget` — number，可选。daily campaign budget value in USD；maximum value: 10000
- `[].gender` — array<string>，可选。gender to target；possible values: male, female, unknown
- `[].industry` — array<string>，可选。industry of LinkedIn profile targetingif you use this field, you can receive the list of available industry names with industry_id by making a separate request to the https://api.seermartech.cn/v3/keywords_data/bing/audience_estimation/industriesexample: 806301758
- `[].job_function` — array<string>，可选。job function of LinkedIn profile targetingif you use this field, you can receive the list of available job function names with job_function_id by making a separate request to the https://api.seermartech.cn/v3/keywords_data/bing/audience_estimation/job_functionsexample: 806300451

最小请求示例:

```json
[
  {
    "location_coordinate": "29.6821525,-82.4098881,100",
    "age": [
      "twenty_five_to_thirty_four",
      "eighteen_to_twenty_four",
      "unknown"
    ],
    "bid": "1",
    "daily_budget": "24",
    "gender": [
      "male"
    ],
    "industry": [
      "806303407",
      "806301758"
    ],
    "job_function": [
      "806298607"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/bing/audience_estimation/task_get/{id}

ID: `BingAudienceEstimationTaskGet`
用途: ‌

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/bing/audience_estimation/task_post

ID: `BingAudienceEstimationTaskPost`
用途: ‌ This endpoint provides estimated audience size for an ad campaign based on specified targeting criteria. It returns data on the total estimated audience, such as suggested bid and budget for an ad campaign and estimated engagement metrics.
中文补充: 本接口使用 **POST `/v3/keywords_data/bing/audience_estimation/task_post`** 创建 Bing Ads 受众估算任务。

请求体: `application/json`

请求字段:
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius (in km)" format；the data will be provided for the country the specified coordinates belong to；example:；29.6821525,-82.4098881,100
- `[].age` — array<string>，可选。selection of age ranges for targeting；possible values: eighteen_to_twenty_four, fifty_to_sixty_four, sixty_five_and_above, thirteen_to_seventeen, thirty_five_to_forty_nine, twenty_five_to_thirty_four, unknown, zero_to_twelve
- `[].bid` — number，可选。desired bid setting value in USD；maximum value: 1000
- `[].daily_budget` — number，可选。daily campaign budget value in USD；maximum value: 10000
- `[].gender` — array<string>，可选。gender to target；possible values: male, female, unknown
- `[].industry` — array<string>，可选。industry of LinkedIn profile targetingif you use this field, you can receive the list of available industry names with industry_id by making a separate request to the https://api.seermartech.cn/v3/keywords_data/bing/audience_estimation/industriesexample: 806301758
- `[].job_function` — array<string>，可选。job function of LinkedIn profile targetingif you use this field, you can receive the list of available job function names with job_function_id by making a separate request to the https://api.seermartech.cn/v3/keywords_data/bing/audience_estimation/job_functionsexample: 806300451

最小请求示例:

```json
[
  {
    "location_coordinate": "29.6821525,-82.4098881,100",
    "age": [
      "twenty_five_to_thirty_four",
      "eighteen_to_twenty_four",
      "unknown"
    ],
    "bid": "1",
    "daily_budget": "24",
    "gender": [
      "male"
    ],
    "industry": [
      "806303407",
      "806301758"
    ],
    "job_function": [
      "806298607"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/bing/audience_estimation/tasks_ready

ID: `BingAudienceEstimationTasksReady`
用途: ‌ This endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
中文补充: 本接口使用 **GET** 方法和以下路径：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/bing/keyword_performance/live

ID: `BingKeywordPerformanceLive`
用途: ‌ You can receive a set of keyword performance stats for a group of keywords depending on the specified match type, location and language parameters. Ad position, clicks, impressions, and other keyword metrics are aggregated for the last month for one or all of the following device types: mobile, desktop, tablet.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。keywords；required field；The maximum number of keywords you can specify: 1000；The maximum number of characters for each keyword: 80；The maximum number of words for each keyword phrase: 10；the specified keywords will be converted to lowercase, data will be provided in a separate arraylearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].device` — string，可选。device type；optional field；specify this field if you want to get the data for a particular device typepossible values: desktop, mobile, tablet, all；default value: all
- `[].match` — string，可选。keywords match type；optional field；can take the following values:；aggregate returns data across all match types;；broad returns data for all user queries containing the specified keyword with varying word order;；phrase returns data for all user queries containing the specified keyword with identical word order;；exact returns data for user query that matches the specified keyword;Note: the aggregate match type is applied by default
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations and languages by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/keyword_performance/locations_and_languages；example:；"United States"
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations and languages by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/keyword_performance/locations_and_languages；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude" format；the data will be provided for the country the specified coordinates belong to；example:；52.6178549,-155.352142
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available locations and languages by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/keyword_performance/locations_and_languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；you can receive the list of available locations and languages by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/keyword_performance/locations_and_languages；example:；"en"
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "location_code": "2840",
    "language_code": "en",
    "keywords": [
      "dataforseo",
      "seo",
      "ranking"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/bing/keyword_performance/locations_and_languages

ID: `BingKeywordPerformanceLocationsAndLanguages`
用途: ‌ Using this endpoint you can get the full list of locations and languages supported in Keyword Performance endpoints of Bing Keywords Data API.
中文补充: **GET** `/v3/keywords_data/bing/keyword_performance/locations_and_languages`

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/bing/keyword_performance/task_get/{id}

ID: `BingKeywordPerformanceTaskGet`
用途: ‌ You can receive a set of keyword performance stats for a group of keywords depending on the specified match type, location and language parameters. Ad position, clicks, impressions, and other keyword metrics are aggregated for the last month for one or all of the following device types: mobile, desktop, tablet.

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/bing/keyword_performance/task_post

ID: `BingKeywordPerformanceTaskPost`
用途: ‌ You can receive a set of keyword performance stats for a group of keywords depending on the specified match type, location and language parameters. Ad position, clicks, impressions, and other keyword metrics are aggregated for the last month for one or all of the following device types: mobile, desktop, tablet.
中文补充: 使用 `POST /v3/keywords_data/bing/keyword_performance/task_post` 创建 Bing 效果查询任务。该接口按指定的匹类型、地区、语言和设备类型，返回近一个月的广告效果汇总数据广告排名、点击量、展示量等指标。

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。keywords；required field；The maximum number of keywords you can specify: 1000；The maximum number of characters for each keyword: 80；The maximum number of words for each keyword phrase: 10；the specified keywords will be converted to lowercase, data will be provided in a separate arraylearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].device` — string，可选。device type；optional field；specify this field if you want to get the data for a particular device typepossible values: desktop, mobile, tablet, all；default value: all
- `[].match` — string，可选。keywords match type；optional field；can take the following values:；aggregate returns data across all match types;；broad returns data for all user queries containing the specified keyword with varying word order;；phrase returns data for all user queries containing the specified keyword with identical word order;；exact returns data for user query that matches the specified keyword;Note: the aggregate match type is applied by default
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations and languages by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/keyword_performance/locations_and_languages；example:；"United States"
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations and languages by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/keyword_performance/locations_and_languages；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude" format；the data will be provided for the country the specified coordinates belong to；example:；52.6178549,-155.352142
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available locations and languages by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/keyword_performance/locations_and_languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；you can receive the list of available locations and languages by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/keyword_performance/locations_and_languages；example:；"en"
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "location_code": "2840",
    "language_code": "en",
    "keywords": [
      "dataforseo",
      "seo",
      "ranking"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/bing/keyword_performance/tasks_ready

ID: `BingKeywordPerformanceTasksReady`
用途: ‌ This endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/bing/keywords_for_keywords/live

ID: `BingKeywordsForKeywordsLive`
用途: ‌ This endpoint will select the relevant keywords for the specified ones. Set up to 200 keywords and get the results, which are suggested by Bing Ads for your query. You can get up to 3000 keyword suggestions using this function.
中文补充: **POST** `/v3/keywords_data/bing/keywords_for_keywords/live`

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。keywords；required field；you can specify the maximum of 200 keywords with each keyword containing no more than 100 characters;；the specified keywords will be converted to lowercase, data will be provided in a separate arraylearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude" format；the data will be provided for the country the specified coordinates belong to；example:；52.6178549,-155.352142
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；supported languages:；English, French, German
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；supported languages:；en, fr, de
- `[].sort_by` — string，可选。results sorting parameters；optional field；Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order；default value: relevance
- `[].keywords_negative` — array<string>，可选。keywords negative array；optional field；These keywords will be ignored in the results array;；You can specify a maximum of 200 terms that you want to exclude from the results;；the specified keywords will be converted to lowercase format
- `[].device` — string，可选。device type；optional field；specify this field if you want to get the data for a particular device type;；possible values: all, mobile, desktop, tablet；default value: all
- `[].date_from` — string，可选。starting date of the time range；optional field；minimal value: 24 months from today's date;；if you don't specify this field, data will be provided for the last 12 months;；if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;；if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior;；date format: "yyyy-mm-dd"；example:；"2020-01-01"Note: we do not recommend using a custom time range for the past year's dates
- `[].date_to` — string，可选。ending date of the time range；optional field；if you don't specify this field, data will be provided for the last 12 months;；minimum value: two years back from today’s date;；maximum value: one month from today's date;；date format: "yyyy-mm-dd"；example:；"2020-03-15"Note: we do not recommend using a custom time range for the past year's dates
- `[].search_partners` — boolean，可选。Bing search partners type；optional field；if you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.；default value: false - results are returned for Bing, AOL, and Yahoo search networks
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "location_name": "United States",
    "language_name": "English",
    "keywords": [
      "average page rpm adsense",
      "adsense blank ads how long",
      "leads and prospects"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/bing/keywords_for_keywords/task_get/{id}

ID: `BingKeywordsForKeywordsTaskGet`
用途: ‌ This endpoint will select relevant keywords for the specified terms. Set up to 200 keywords and get the results, which are suggested by Bing Ads for your query. You can get up to 3000 keyword suggestions using this function.

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/bing/keywords_for_keywords/task_post

ID: `BingKeywordsForKeywordsTaskPost`
用途: ‌‌ This endpoint will select relevant keywords for the specified terms. Set up to 200 keywords and get the results, which are suggested by Bing Ads for your query. You can get up to 3000 keyword suggestions using this function.
中文补充: 本接口使用 **POST `/v3/keywords_data/bing/keywords_for_keywords/task_post`** 创建 Bing 扩展任务。接口会根据指定，返回由 Bing Ads 推荐的。单个任务最多提交 200 个，最多可获取 3000 条建议。

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。keywords；required field；you can specify the maximum of 200 keywords with each keyword containing no more than 100 characters;；the specified keywords will be converted to lowercase, data will be provided in a separate arraylearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude" format；the data will be provided for the country the specified coordinates belong to；example:；52.6178549,-155.352142
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；supported languages:；English, French, German
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；supported languages:；en, fr, de
- `[].sort_by` — string，可选。results sorting parameters；optional field；Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order；default value: relevance
- `[].keywords_negative` — array<string>，可选。keywords negative array；optional field；These keywords will be ignored in the results array;；You can specify a maximum of 200 terms that you want to exclude from the results;；the specified keywords will be converted to lowercase format
- `[].device` — string，可选。device type；optional field；specify this field if you want to get the data for a particular device type;；possible values: all, mobile, desktop, tablet；default value: all
- `[].date_from` — string，可选。starting date of the time range；optional field；minimal value: 24 months from today's date;；if you don't specify this field, data will be provided for the last 12 months;；if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;；if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior;；date format: "yyyy-mm-dd"；example:；"2020-01-01"Note: we do not recommend using a custom time range for the past year's dates
- `[].date_to` — string，可选。ending date of the time range；optional field；if you don't specify this field, data will be provided for the last 12 months;；minimum value: two years back from today’s date;；maximum value: one month from today's date;；date format: "yyyy-mm-dd"；example:；"2020-03-15"Note: we do not recommend using a custom time range for the past year's dates
- `[].search_partners` — boolean，可选。Bing search partners type；optional field；if you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.；default value: false - results are returned for Bing, AOL, and Yahoo search networks
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "location_code": "2840",
    "language_code": "en",
    "keywords": [
      "average page rpm adsense",
      "adsense blank ads how long",
      "leads and prospects"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/bing/keywords_for_keywords/tasks_ready

ID: `BingKeywordsForKeywordsTasksReady`
用途: ‌ This endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/bing/keywords_for_site/live

ID: `BingKeywordsForSiteLive`
用途: ‌This endpoint will provide you with a list of keywords relevant to the specified URL along with their search volume for the last month, search volume trend for up to 24 past months (for estimating search volume dynamics), current cost-per-click and competition values for paid search. The maximum number of returned keywords is 3000.
中文补充: **POST `/v3/keywords_data/bing/keywords_for_site/live`**

请求体: `application/json`

请求字段:
- `[].target` — string，可选。domain or URL；required field；the domain name or URL of the target website
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude" format；the data will be provided for the country the specified coordinates belong to；example:；52.6178549,-155.352142
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；supported languages:；English, French, German
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；supported languages:；en, fr, de
- `[].keywords_negative` — array<string>，可选。keywords negative array；optional field；These keywords will be ignored in the results array;；You can specify a maximum of 200 terms that you want to exclude from the results;；the specified keywords will be converted to lowercase format
- `[].device` — string，可选。device type；optional field；specify this field if you want to get the data for a particular device typepossible values: all, mobile, desktop, tablet；default value: all
- `[].date_from` — string，可选。starting date of the time range；optional field；minimal value: 24 months from today's date;；if you don't specify this field, data will be provided for the last 12 months;；if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;；if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior;；date format: "yyyy-mm-dd"；example:；"2020-01-01"Note: we do not recommend using a custom time range for the past year's dates
- `[].date_to` — string，可选。ending date of the time range；optional field；if you don't specify this field, data will be provided for the last 12 months;；minimum value: two years back from today’s date;；maximum value: one month from today's date;；note: we do not recommend using a custom time range for the past year's dates;；date format: "yyyy-mm-dd"；example:；"2020-03-15"Note: we do not recommend using a custom time range for the past year's dates
- `[].sort_by` — string，可选。results sorting parameters；optional field；Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order；default value: relevance
- `[].search_partners` — boolean，可选。Bing search partners type；optional field；if you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.；default value: false - results are returned for Bing, AOL, and Yahoo search networks
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "target": "dataforseo.com"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/bing/keywords_for_site/task_get/{id}

ID: `BingKeywordsForSiteTaskGet`
用途: ‌ This endpoint will provide you with a list of keywords relevant to the specified website along with their search volume for the last month, search volume trend for the last year (for estimating search volume dynamics), current cost-per-click and competition level for paid search. The maximum number of returned keywords is 3000.

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/bing/keywords_for_site/task_post

ID: `BingKeywordsForSiteTaskPost`
用途: ‌This endpoint will provide you with a list of keywords relevant to the specified website along with their search volume for the last month, search volume trend for up to 24 past months (for estimating search volume dynamics), current cost-per-click and competition level for paid search. The maximum number of returned keywords is 3000.
中文补充: **POST** `/v3/keywords_data/bing/keywords_for_site/task_post`

请求体: `application/json`

请求字段:
- `[].target` — string，可选。domain or URL；required field；the URL of the webpage or the domain to scan for possible keywords
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude" format；the data will be provided for the country the specified coordinates belong to；example:；52.6178549,-155.352142
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；supported languages:；English, French, German
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；supported languages:；en, fr, de
- `[].keywords_negative` — array<string>，可选。keywords negative array；optional field；These keywords will be ignored in the results array;；You can specify a maximum of 200 terms that you want to exclude from the results;；the specified keywords will be converted to lowercase format
- `[].device` — string，可选。device type；optional field；specify this field if you want to get the data for a particular device type；possible values: all, mobile, desktop, tablet；default value: all
- `[].sort_by` — string，可选。results sorting parameters；optional field；Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order；default value: relevance
- `[].date_from` — string，可选。starting date of the time range；optional field；minimal value: 24 months from today's date;；if you don't specify this field, data will be provided for the last 12 months;；if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;；if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior;；date format: "yyyy-mm-dd"；example:；"2020-01-01"Note: we do not recommend using a custom time range for the past year's dates
- `[].date_to` — string，可选。ending date of the time range；optional field；if you don't specify this field, data will be provided for the last 12 months;；minimum value: two years back from today’s date;；maximum value: one month from today's date;；date format: "yyyy-mm-dd"；example:；"2020-03-15"Note: we do not recommend using a custom time range for the past year's dates
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].search_partners` — boolean，可选。Bing search partners type；optional field；if you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.；default value: false - results are returned for Bing, AOL, and Yahoo search networks
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "target": "dataforseo.com"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/bing/keywords_for_site/tasks_ready

ID: `BingKeywordsForSiteTasksReady`
用途: ‌ This endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/bing/languages

ID: `KeywordsDataBingLanguages`
用途: By calling this API you will receive the list of languages supported by Bing Ads API.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/bing/locations

ID: `KeywordsDataBingLocations`
用途: By calling this API you will receive the list of locations supported in Bing Ads API.
中文补充: 获取 Bing 数据 API 支持的地域列表。

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/bing/search_volume/live

ID: `BingSearchVolumeLive`
用途: ‌This endpoint will provide you with search volume data for the last month, search volume trend for up to 24 past months (that will let you estimate search volume dynamics), current cost-per-click and competition values for paid search.
中文补充: **POST `/v3/keywords_data/bing/search_volume/live`**

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。keywords；required field；The maximum number of keywords you can specify: 1000；The maximum number of characters for each keyword: 100；the specified keywords will be converted to lowercase, data will be provided in a separate arraylearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude" format；the data will be provided for the country the specified coordinates belong to；example:；52.6178549,-155.352142
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；supported languages:；English, French, German
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；supported languages:；en, fr, de
- `[].device` — string，可选。device type；optional field；specify this field if you want to get the data for a particular device type;；possible values: all, mobile, desktop, tablet；default value: all
- `[].sort_by` — string，可选。results sorting parameters；optional field；Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order；default value: relevance
- `[].date_from` — string，可选。starting date of the time range；optional field；minimal value: 24 months from today's date;；if you don't specify this field, data will be provided for the last 12 months;；minimum value: two years back from today’s date;；if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;；if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior;；date format: "yyyy-mm-dd"；example:；"2020-01-01"Note: we do not recommend using a custom time range for the past year's dates
- `[].date_to` — string，可选。ending date of the time range；optional field；if you don't specify this field, data will be provided for the last 12 months;；minimum value: two years back from today’s date;；maximum value: one month from today's date;；note: we do not recommend using a custom time range for the past year's dates;；date format: "yyyy-mm-dd"；example:；"2020-03-15"Note: we do not recommend using a custom time range for the past year's dates
- `[].search_partners` — boolean，可选。Bing search partners type；optional field；if you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.；default value: false - results are returned for Bing, AOL, and Yahoo search networks
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "location_name": "United States",
    "language_code": "en",
    "keywords": [
      "tom and jerry",
      "silicon valley",
      "spider man"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/bing/search_volume/task_get/{id}

ID: `BingSearchVolumeTaskGet`
用途: ‌

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/bing/search_volume/task_post

ID: `BingSearchVolumeTaskPost`
用途: ‌ This endpoint will provide you with search volume data for the last month, search volume trend for up to 24 past months (that will let you estimate search volume dynamics), current cost-per-click and competition values for paid search.
中文补充: 本接口使用 **POST** 方法创建 Bing 搜索量任务：

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。keywords；required field；The maximum number of keywords you can specify: 1000；The maximum number of characters for each keyword: 100；the specified keywords will be converted to lowercase, data will be provided in a separate arraylearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude" format；the data will be provided for the country the specified coordinates belong to；example:；52.6178549,-155.352142
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；supported languages:；English, French, German
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；supported languages:；en, fr, de
- `[].device` — string，可选。device type；optional field；specify this field if you want to get the data for a particular device typepossible values: all, mobile, desktop, tablet；default value: all
- `[].sort_by` — string，可选。results sorting parameters；optional field；Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order；default value: relevance
- `[].date_from` — string，可选。starting date of the time range；optional field；if you don't specify this field, data will be provided for the last 12 months；minimal value: 24 months from today's date；if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;；if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior;；date format: "yyyy-mm-dd"；example:；"2020-01-01"Note: we do not recommend using a custom time range for the past year's dates
- `[].date_to` — string，可选。ending date of the time range；optional field；if you don't specify this field, data will be provided for the last 12 months;；minimum value: two years back from today’s date;；maximum value: one month from today's date;；note: we do not recommend using a custom time range for the past year's dates;；date format: "yyyy-mm-dd"；example:；"2020-03-15"Note: we do not recommend using a custom time range for the past year's dates
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].search_partners` — boolean，可选。Bing search partners type；optional field；if you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.；default value: false - results are returned for Bing, AOL, and Yahoo search networks
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "location_name": "United States",
    "language_name": "English",
    "keywords": [
      "average page rpm adsense",
      "adsense blank ads how long",
      "leads and prospects"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/bing/search_volume/tasks_ready

ID: `BingSearchVolumeTasksReady`
用途: ‌ This endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/bing/search_volume_history/live

ID: `BingSearchVolumeHistoryLive`
用途: ‌This endpoint will provide you with historical search volume data for up to 1000 keywords in one request. You can get search volume for keywords in monthly, weekly, or daily format and specify the device type.
中文补充: **POST** `/v3/keywords_data/bing/search_volume_history/live`

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。keywords；required field；The maximum number of keywords you can specify: 1000；The maximum number of characters for each keyword: 100；the specified keywords will be converted to lowercase, data will be provided in a separate arraylearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/search_volume_history/locations_and_languages；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/search_volume_history/locations_and_languages；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude" format；the data will be provided for the country the specified coordinates belong to；example:；52.6178549,-155.352142
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/search_volume_history/locations_and_languages
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages of the search engines with their language_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/search_volume_history/locations_and_languages
- `[].device` — array<string>，可选。device types；optional field；specify this field if you want to get the data for a particular device types；possible values: mobile, desktop, tablet, non_smartphones；default value: ["mobile", "desktop", "tablet", "non_smartphones"]
- `[].period` — string，可选。aggregates the returned data to a certain time period；optional field；specify this field if you want to get the data in monthly, weekly or daily formatpossible values: monthly, weekly, dailymonthly - returns data up to past 24 months；weekly - returns data up to past 15 weeks；daily - returns data up to past 45 daysdefault value: monthly
- `[].date_from` — string，可选。starting date of the time range；optional field；minimum value: 24 months back from today’s date;；if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;；if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior;date format: "yyyy-mm-dd"；example:；"2020-01-01"Note: we do not recommend using a custom time range;Note 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 months;if you specify the period parameter:with value weekly, you will get results for the past 15 weeks;；with value daily, you will get results for the past 45 days
- `[].date_to` — string，可选。ending date of the time range；optional fieldminimum value: two years back from today’s date;；maximum value: one day from today's date;；date format: "yyyy-mm-dd"；example:；"2020-03-15"Note: we do not recommend using a custom time rangeNote 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 monthsif you specify the period parameter:with value weekly, you will get results for the past 15 weeks；with value daily, you will get results for the past 45 days
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "location_code": "2840",
    "language_code": "en",
    "keywords": [
      "10 minute timer"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/bing/search_volume_history/locations_and_languages

ID: `BingSearchVolumeHistoryLocationsAndLanguages`
用途: By calling this API you will receive the list of locations and languages supported by Bing ‘Search Volume History’ endpoint.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/bing/search_volume_history/task_get/{id}

ID: `BingSearchVolumeHistoryTaskGet`
用途: ‌

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/bing/search_volume_history/task_post

ID: `BingSearchVolumeHistoryTaskPost`
用途: ‌ This endpoint will provide you with historical search volume data for up to 1000 keywords in one request. You can get search volume for keywords in monthly, weekly, or daily format and specify the device type.
中文补充: **POST `/v3/keywords_data/bing/search_volume_history/task_post`**

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。keywords；required field；The maximum number of keywords you can specify: 1000；The maximum number of characters for each keyword: 100；the specified keywords will be converted to lowercase, data will be provided in a separate arraylearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/search_volume_history/locations_and_languages；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/bing/search_volume_history/locations_and_languages；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude" format；the data will be provided for the country the specified coordinates belong to；example:；52.6178549,-155.352142
- `[].language_name` — string，可选
- `[].language_code` — string，可选
- `[].device` — array<string>，可选。device types；optional field；specify this field if you want to get the data for a particular device types；possible values: mobile, desktop, tablet, non_smartphones；default value: ["mobile", "desktop", "tablet", "non_smartphones"]
- `[].period` — string，可选。aggregates the returned data to a certain time period；optional field；specify this field if you want to get the data in monthly, weekly or daily formatpossible values: monthly, weekly, dailymonthly - returns data up to past 24 months；weekly - returns data up to past 15 weeks；daily - returns data up to past 45 daysdefault value: monthly
- `[].date_from` — string，可选。starting date of the time range；optional field；minimum value: two years back from today’s date；if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;；if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior;；date format: "yyyy-mm-dd"；example:；"2020-01-01"Note: we do not recommend using a custom time rangeNote 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 monthsif you specify the period parameter:with value weekly, you will get results for the past 15 weeks；with value daily, you will get results for the past 45 days
- `[].date_to` — string，可选。ending date of the time range；optional fieldminimum value: two years back from today’s date;；maximum value: one day from today's date;；date format: "yyyy-mm-dd"；example:；"2020-03-15"Note: we do not recommend using a custom time rangeNote 2: if date_from and date_to parameters are not specified, the data will be returned for the past 24 monthsif you specify the period parameter:with value weekly, you will get results for the past 15 weeks；with value daily, you will get results for the past 45 days
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "location_code": "2840",
    "language_code": "en",
    "keywords": [
      "10 minute timer"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/bing/search_volume_history/tasks_ready

ID: `BingSearchVolumeHistoryTasksReady`
用途: ‌ This endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
中文补充: **请求方式：** `GET` **请求路径：** `/v3/keywords_data/bing/search_volume_history/tasks_ready`

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/clickstream_data/bulk_search_volume/live

ID: `ClickstreamDataBulkSearchVolumeLive`
用途: ‌‌ The Bulk Clickstream Search Volume endpoint of DataForSEO Keywords Data API is designed to provide clickstream-based search volume data for up to 1000 keywords in a single Live request. What’s more, it offers historical search volume values for up to 12 months (depending on keywords, location, and language parameters).
中文补充: **POST** `https://api.seermartech.cn/v3/keywords_data/clickstream_data/bulk_search_volume/live`

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。target keywords；required field；UTF-8 encoding；maximum number of keywords you can specify in this array: 1000;；each keyword should be at least 3 characters long;；the keywords will be converted to lowercase format;；Note: certain symbols and characters (e.g., UTF symbols, emojis) are not allowed；to learn more about which symbols and characters can be used, please refer to this articlelearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_name by making a separate request to the ；https://api.seermartech.cn/v3/keywords_data/clickstream_data/locations_and_languages；example:；United Kingdom
- `[].location_code` — integer，可选。location code；required field if you don't specify location_name；Note: it is required to specify either location_name or location_code；you can receive the list of available locations with their location_code by making a separate request to the ；https://api.seermartech.cn/v3/keywords_data/clickstream_data/locations_and_languages；example:；2840
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "location_code": "2840",
    "tag": "test-tag",
    "keywords": [
      "you tube",
      "youtube",
      "youtub"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/clickstream_data/dataforseo_search_volume/live

ID: `ClickstreamDataDataforseoSearchVolumeLive`
用途: ‌
中文补充: **POST** `https://api.seermartech.cn/v3/keywords_data/clickstream_data/dataforseo_search_volume/live`

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。target keywords；required field；UTF-8 encoding；maximum number of keywords you can specify in this array: 1000；the keywords will be converted to lowercase formatNote: certain symbols and characters (e.g., UTF symbols, emojis) are not allowed；to learn more about which symbols and characters can be used, please refer to this articlelearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；required field if you don’t specify location_code ；you can receive the list of available locations with location_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/clickstream_data/locations_and_languages；example:；United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don’t specify location_name；if you use this field, you can receive the list of available locations with location_code by making a separate request to the https://api.seermartech.cn/v3/keywords_data/clickstream_data/locations_and_languages；example:；2826
- `[].language_name` — string，可选。full name of search engine language；required field if don’t specify language_code；you can receive the list of available languages with their language_name by making a separate request to the https://api.seermartech.cn/v3/keywords_data/clickstream_data/locations_and_languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if don’t specify language_name；you can receive the list of available languages with their language_code by making a separate request to the https://api.seermartech.cn/v3/keywords_data/clickstream_data/locations_and_languages；example:；en
- `[].use_clickstream` — boolean，可选。use clickstream data to provide results；optional field；if set to true, you will get DataForSEO search volume values based on clickstream data;；if set to false, Bing search volume data will be used to calculate DataForSEO search volume;；default value: true;；Note: Bing search volume is available for locations provided in Bing Search Volume History Locations and Bing Ads Locations endpoints; search volume values for any other location are calculated based on clickstream data even if you set this parameter to false
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "location_code": "2840",
    "language_code": "en",
    "tag": "test-tag",
    "keywords": [
      "you tube",
      "youtube",
      "youtub"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/clickstream_data/global_search_volume/live

ID: `ClickstreamDataGlobalSearchVolumeLive`
用途: ‌‌ The Clickstream Global Search Volume endpoint of DataForSEO Keywords Data API is designed to provide clickstream-based search volume data for up to 1000 keywords in a single Live request. What’s more, it offers geographical distribution of clickstream search volume values across all available locations.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。target keywords；required field；UTF-8 encoding；maximum number of keywords you can specify in this array: 1000;；each keyword should be at least 3 characters long;；the keywords will be converted to lowercase format;；Note: certain symbols and characters (e.g., UTF symbols, emojis) are not allowed；to learn more about which symbols and characters can be used, please refer to this articlelearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "tag": "test-tag",
    "keywords": [
      "you tube",
      "youtube",
      "youtub"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/clickstream_data/locations_and_languages

ID: `ClickstreamDataLocationsAndLanguages`
用途: ‌ Using this endpoint you can get the full list of locations and languages supported in DataForSEO Clickstream Data API.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/dataforseo_trends/demography/live

ID: `DataforseoTrendsDemographyLive`
用途: This endpoint will provide you with the demographic breakdown (by age and gender) of keyword popularity per each specified term based on DataForSEO Trends data. You can check keyword trends for Google Search, Google News, and Google Shopping.
中文补充: **POST** `/v3/keywords_data/dataforseo_trends/demography/live`

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。keywords；required field；the maximum number of keywords you can specify: 5；avoid symbols and special characters (e.g., UTF symbols, emojis);；specifying non-Latin characters, you’ll get data for the countries where they are usedlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；optional field；if you don't use this field, you will recieve global results；if you use this field, you don't need to specify location_code；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/dataforseo_trends/locations；note that the data will be provided for the country the specified location_name belongs to;；example:；United Kingdom
- `[].location_code` — integer，可选。search engine location code；optional field；if you don't use this field, you will recieve global results；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/dataforseo_trends/locations；note that the data will be provided for the country the specified location_code belongs to;；example:；2840
- `[].type` — string，可选。type of element
- `[].date_from` — string，可选。starting date of the time range；optional field；if you don't specify this field, the current day and month of the preceding year will be used by default；minimal value for the web type: 2004-01-01；minimal value for other types: 2008-01-01；date format: "yyyy-mm-dd"；example:；"2019-01-15"
- `[].date_to` — string，可选。ending date of the time range；optional field；if you don't specify this field, the today's date will be used by default；date format: "yyyy-mm-dd"；example:；"2019-01-15"
- `[].time_range` — string，可选。preset time ranges；optional field；if you specify date_from or date_to parameters, this field will be ignored when setting a task；possible values for all type parameters:；past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "keywords": [
      "rugby",
      "cricket"
    ],
    "date_from": "2023-01-01",
    "date_to": "2024-01-01",
    "type": "web",
    "location_name": "United States"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/dataforseo_trends/explore/live

ID: `DataforseoTrendsExploreLive`
用途: This endpoint will provide you with the keyword popularity data from DataForSEO Trends. You can check keyword trends for Google Search, Google News, and Google Shopping.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。keywords；required field；the maximum number of keywords you can specify: 5learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；optional field；if you don't use this field, you will recieve global results；if you use this field, you don't need to specify location_code；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/dataforseo_trends/locations；note that the data will be provided for the country the specified location_name belongs to;；example:；United Kingdom
- `[].location_code` — integer，可选。search engine location code；optional field；if you don't use this field, you will recieve global results；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/dataforseo_trends/locations；note that the data will be provided for the country the specified location_code belongs to;；example:；2840
- `[].type` — string，可选。type of element
- `[].date_from` — string，可选。starting date of the time range；optional field；if you don't specify this field, the current day and month of the preceding year will be used by default；minimal value for the web type: 2004-01-01；minimal value for other types: 2008-01-01；date format: "yyyy-mm-dd"；example:；"2019-01-15"
- `[].date_to` — string，可选。ending date of the time range；optional field；if you don't specify this field, the today's date will be used by default；date format: "yyyy-mm-dd"；example:；"2019-01-15"
- `[].time_range` — string，可选。preset time ranges；optional field；if you specify date_from or date_to parameters, this field will be ignored when setting a task；possible values for all type parameters:；past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "keywords": [
      "iphone 14",
      "samsung s23"
    ],
    "location_code": "2840"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/dataforseo_trends/locations

ID: `DataforseoTrendsLocations`
用途: You will receive the list of DataForSEO Trends locations by calling this API. You can filter the list of locations by country when setting a task. Please note that the minimum geographic scope supported for the DataForSEO Trends API is country level.
中文补充: 用于获取趋势数据支持的地理位置列表。通过在路径中指定国家/地区 ISO 代码，可以筛选对应国家/地区的地理位置。

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/dataforseo_trends/locations/{country}

ID: `DataforseoTrendsLocationsCountry`
用途: You will receive the list of DataForSEO Trends locations by calling this API. You can filter the list of locations by country when setting a task. Please note that the minimum geographic scope supported for the DataForSEO Trends API is country level.

路径与查询参数:
- `country` — path，string，必填。country ISO code；optional field；specify the ISO code if you want to filter the list of locations by country；example:；us

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/dataforseo_trends/merged_data/live

ID: `DataforseoTrendsMergedDataLive`
用途: This endpoint will provide you with the keyword popularity data from DataForSEO Trends. In addition to keyword popularity rate over the given time range, you will get location-specific keyword popularity data, and a demographic breakdown of keyword popularity per each specified term along with comparative values.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。keywords；required field；the maximum number of keywords you can specify: 5；avoid symbols and special characters (e.g., UTF symbols, emojis);；specifying non-Latin characters, you’ll get data for the countries where they are usedlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；optional field；if you don't use this field, you will recieve global results；if you use this field, you don't need to specify location_code；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/dataforseo_trends/locations；note that the data will be provided for the country the specified location_name belongs to;；example:；United Kingdom
- `[].location_code` — integer，可选。search engine location code；optional field；if you don't use this field, you will recieve global results；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/dataforseo_trends/locations；note that the data will be provided for the country the specified location_code belongs to;；example:；2840
- `[].type` — string，可选。type of element
- `[].date_from` — string，可选。starting date of the time range；optional field；if you don't specify this field, the current day and month of the preceding year will be used by default；minimal value for the web type: 2004-01-01；minimal value for other types: 2008-01-01；date format: "yyyy-mm-dd"；example:；"2019-01-15"
- `[].date_to` — string，可选。ending date of the time range；optional field；if you don't specify this field, the today's date will be used by default；date format: "yyyy-mm-dd"；example:；"2019-01-15"
- `[].time_range` — string，可选。preset time ranges；optional field；if you specify date_from or date_to parameters, this field will be ignored when setting a task；possible values for all type parameters:；past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "keywords": [
      "rugby",
      "cricket"
    ],
    "date_from": "2023-01-01",
    "date_to": "2024-01-01",
    "type": "web",
    "location_name": "United States"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/dataforseo_trends/subregion_interests/live

ID: `DataforseoTrendsSubregionInterestsLive`
用途: This endpoint will provide you with location-specific keyword popularity data from DataForSEO Trends. You can check keyword trends for Google Search, Google News, and Google Shopping.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。keywords；required field；the maximum number of keywords you can specify: 5；avoid symbols and special characters (e.g., UTF symbols, emojis);；specifying non-Latin characters, you’ll get data for the countries where they are usedlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；optional field；if you don't use this field, you will recieve global results；if you use this field, you don't need to specify location_code；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/dataforseo_trends/locations；note that the data will be provided for the country the specified location_name belongs to;；example:；United Kingdom
- `[].location_code` — integer，可选。search engine location code；optional field；if you don't use this field, you will recieve global results；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/dataforseo_trends/locations；note that the data will be provided for the country the specified location_code belongs to;；example:；2840
- `[].type` — string，可选。type of element
- `[].date_from` — string，可选。starting date of the time range；optional field；if you don't specify this field, the current day and month of the preceding year will be used by default；minimal value for the web type: 2004-01-01；minimal value for other types: 2008-01-01；date format: "yyyy-mm-dd"；example:；"2019-01-15"
- `[].date_to` — string，可选。ending date of the time range；optional field；if you don't specify this field, the today's date will be used by default；date format: "yyyy-mm-dd"；example:；"2019-01-15"
- `[].time_range` — string，可选。preset time ranges；optional field；if you specify date_from or date_to parameters, this field will be ignored when setting a task；possible values for all type parameters:；past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "keywords": [
      "rugby",
      "cricket"
    ],
    "date_from": "2023-01-01",
    "date_to": "2024-01-01",
    "type": "web",
    "location_name": "United States"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/errors

ID: `KeywordsDataErrors`
用途: By calling this endpoint you will receive information about the Keywords Data API tasks that returned an error within the past 7 days.
中文补充: 本接口用于查询过去 7 天返回错误的数据 API 任务。HTTP 方法与路径如下：

请求体: `application/json`

请求字段:
- `[].limit` — integer，可选。the maximum number of returned tasks that responded with an error；optional field；default value: 1000；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned tasks；optional field；default value: 0；if you specify the 10 value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks
- `[].filtered_function` — string，可选。return tasks with a certain function；use this field to obtain a list of tasks that returned an error filtered by a certain function；you can filter the results by the values you receive in the function fields of the API response；i.e., once you receive unfiltered results, you can call this API again to filter them by function ；example: keywords_data/keywords_for_site/task_post, postback_url, pingback_url
- `[].datetime_from` — string，可选。start time for filtering results；optional field；allows filtering results by the datetime parameter within the range of the last 7 days;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2021-11-15 12:57:46 +00:00
- `[].datetime_to` — string，可选。finish time for filtering results；optional field；allows filtering results by the datetime parameter within the range of the last 7 days;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2021-11-15 13:57:46 +00:00

最小请求示例:

```json
[
  {
    "limit": "10",
    "offset": "0",
    "filtered_function": "pingback_url"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/google_ads/ad_traffic_by_keywords/live

ID: `GoogleAdsAdTrafficByKeywordsLive`
中文补充: **POST** `/v3/keywords_data/google_ads/ad_traffic_by_keywords/live`

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。keywords；required field；The maximum number of keywords you can specify: 1000；The maximum number of characters for each keyword: 80；The maximum number of words for each keyword phrase: 10；the keywords you specify will be converted to a lowercase format；Note: Google Ads may return no data for certain groups of keywords；visit our Help Center to learn more；Also note that Google Ads doesn't allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can't use them when setting a task;；to learn more about which symbols and characters can be used, please refer to this articlelearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].bid` — integer，可选。the maximum custom bid；required field；the collected data will be based on this value；it stands for the price you are willing to pay for an ad; the higher value you specify here, the higher values you will get in the returned metrics；learn more in this help center article
- `[].match` — string，可选。keywords match-type；required field；can take the following values: exact, broad, phrase
- `[].location_name` — string，可选。full name of search engine location；optional field；if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；optional field；if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;；if you use this field, you don't need to specify location_name or location_coordinate;；you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；optional field；if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;；if you use this field, you don't need to specify location_name or location_code;；location_coordinate parameter should be specified in the "latitude,longitude" format;；the data will be provided for the country the specified coordinates belong to;；example:；52.6178549,-155.352142
- `[].language_name` — string，可选。full name of search engine language；optional field；you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/languages；example:；English
- `[].language_code` — string，可选。search engine language code；optional field；you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/languages；example:；en
- `[].date_from` — string，可选。starting date of the forecasting time range；required field if you specify date_to；if you indicate date_from and date_to, you don't need to specify date_interval；minimum value is tomorrow's date；the value you specify in date_from shouldn't be further than date_to；date format: "yyyy-mm-dd"；example:；"2021-10-30"if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;；if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior
- `[].date_to` — string，可选。ending date of the forecasting time range；required field if you specify date_from；if you indicate date_from and date_to, you don't need to specify date_interval；minimum value is date_from +1 day；maximum value is current day and month of the next year；date format: "yyyy-mm-dd"；example:；"2022-10-30"
- `[].date_interval` — string，可选。forecasting date interval；optional field；if you specify date_interval, you don't need to indicate date_from and date_to；possible values: next_week, next_month, next_quarter；default value: next_month
- `[].sort_by` — string，可选。results sorting parameters；optional field；Use these parameters to sort the results by relevance, impressions, ctr, average_cpc, cost, or clicks in the descending order；default value: relevance
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "location_code": "2840",
    "language_code": "en",
    "bid": "999",
    "match": "exact",
    "keywords": [
      "seo marketing"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/google_ads/ad_traffic_by_keywords/task_get/{id}

ID: `GoogleAdsAdTrafficByKeywordsTaskGet`

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/google_ads/ad_traffic_by_keywords/task_post

ID: `GoogleAdsAdTrafficByKeywordsTaskPost`
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。keywords；required field；The maximum number of keywords you can specify: 1000；The maximum number of characters for each keyword: 80；The maximum number of words for each keyword phrase: 10；the keywords you specify will be converted to a lowercase format；Note #1: Google Ads may return no data for certain groups of keywords;；Note #2: Google Ads provides combined search volume values for groups of similar keywords；to obtain search volume for similar keywords, we recommend submitting such keywords in separate requests;；Note #3: Google Ads doesn't allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can't use them when setting a task;；to learn more about which symbols and characters can be used, please refer to this articlelearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].bid` — number，可选。the maximum custom bid；required field；the collected data will be based on this value；it stands for the price you are willing to pay for an ad; the higher value you specify here, the higher values you will get in the returned metrics；learn more in this help center article
- `[].match` — string，可选。keywords match-type；required field；can take the following values: exact, broad, phrase
- `[].location_name` — string，可选。full name of search engine location；optional field；if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；optional field；if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;；if you use this field, you don't need to specify location_name or location_coordinate;；you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；optional field；if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;；if you use this field, you don't need to specify location_name or location_code;；location_coordinate parameter should be specified in the "latitude,longitude" format;；the data will be provided for the country the specified coordinates belong to;；example:；52.6178549,-155.352142
- `[].language_name` — string，可选。full name of search engine language；optional field；you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/languages；example:；English
- `[].language_code` — string，可选。search engine language code；optional field；you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/languages；example:；en
- `[].date_from` — string，可选。starting date of the forecasting time range；required field if you specify date_to；if you indicate date_from and date_to, you don't need to specify date_interval；minimum value is tomorrow's date；the value you specify in date_from shouldn't be further than date_to；date format: "yyyy-mm-dd"；example:；"2021-10-30"if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;；if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior
- `[].date_to` — string，可选。ending date of the forecasting time range；required field if you specify date_from；if you indicate date_from and date_to, you don't need to specify date_interval；minimum value is date_from +1 day；maximum value is current day and month of the next year；date format: "yyyy-mm-dd"；example:；"2022-10-30"
- `[].date_interval` — string，可选。forecasting date interval；optional field；if you specify date_interval, you don't need to indicate date_from and date_to；possible values: next_week, next_month, next_quarter；default value: next_month
- `[].sort_by` — string，可选。results sorting parameters；optional field；Use these parameters to sort the results by relevance, average_cpc, cost, or clicks in the descending order；default value: relevance
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "bid": "999",
    "match": "exact",
    "keywords": [
      "seo marketing"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/google_ads/ad_traffic_by_keywords/tasks_ready

ID: `GoogleAdsAdTrafficByKeywordsTasksReady`
用途: ‌ This endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/google_ads/keywords_for_keywords/live

ID: `GoogleAdsKeywordsForKeywordsLive`
用途: Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. ‌‌ This endpoint will provide relevant keywords for the specified terms. Set up to 20 keywords in the keywords array and get keyword suggestions from Google Ads.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。keywords；required field；The maximum number of keywords you can specify: 20；The maximum number of characters for each keyword: 80；the keywords you specify will be converted to a lowercase format；Note: Google Ads may return no data for certain groups of keywords；visit our Help Center to learn more；Also note that Google Ads doesn't allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can't use them when setting a task;；to learn more about which symbols and characters can be used, please refer to this articlelearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；optional field；if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；optional field；if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;；if you use this field, you don't need to specify location_name or location_coordinate;；you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；optional field；if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;；if you use this field, you don't need to specify location_name or location_code;；location_coordinate parameter should be specified in the "latitude,longitude" format;；the data will be provided for the country the specified coordinates belong to;；example:；52.6178549,-155.352142
- `[].language_name` — string，可选。full name of search engine language；optional field；you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/languages；example:；English
- `[].language_code` — string，可选。search engine language code；optional field；you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/languages；example:；en
- `[].search_partners` — boolean，可选。include Google search partners；optional field；if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;；default value: false - results are returned for Google search sites
- `[].date_from` — string，可选。starting date of the time range；optional field；date format: "yyyy-mm-dd"；minimal value: 4 years from the current date；by default, data is returned for the past 12 months;；Note: the indicated date cannot be greater than that specified in date_to and/or yesterday's date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;；if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior
- `[].date_to` — string，可选。ending date of the time range；optional field；Note: the indicated date cannot be greater than yesterday's date;；if you don't specify this field, yesterday's date will be used by default；date format: "yyyy-mm-dd"；example:；"2022-11-30"
- `[].sort_by` — string，可选。results sorting parameters；optional field；Use these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in descending order；default value: relevance
- `[].include_adult_keywords` — boolean，可选。include keywords associated with adult content；optional field；if set to true, adult keywords will be included in the response；default value: false；note that the API may return no data for such keywords due to Google Ads restrictions
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "location_code": "2840",
    "keywords": [
      "phone",
      "cellphone"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/google_ads/keywords_for_keywords/task_get/{id}

ID: `GoogleAdsKeywordsForKeywordsTaskGet`
用途: Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. ‌ This endpoint will select relevant keywords for the specified terms. Set up to 20 keywords and get the results, which are suggested by Google Ads for your query.
中文补充: 本接口通过任务 ID 获取“”任务的结果。请求方式与路径为：

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/google_ads/keywords_for_keywords/task_post

ID: `GoogleAdsKeywordsForKeywordsTaskPost`
用途: Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. ‌‌ This endpoint will provide relevant keywords for the specified terms. Set up to 20 keywords in the keywords array and get keyword suggestions from Google Ads. You can get up to 20,000 keyword suggestions with all essential keyword data in response to one request.
中文补充: 本接口使用 `POST /v3/keywords_data/google_ads/keywords_for_keywords/task_post` 创建“拓展”任务。提交最多 20 个后，本平台将从 Google Ads 获取建议及数据；单个任务最多可返回 20,000 条建议。

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。keywords；required field；The maximum number of keywords you can specify: 20；The maximum number of characters for each keyword: 80；the keywords you specify will be converted to a lowercase format；Note: Google Ads may return no data for certain groups of keywords；visit our Help Center to learn more；Also note that Google Ads doesn't allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can't use them when setting a task;；to learn more about which symbols and characters can be used, please refer to this articlelearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].target` — string，可选。target website；optional field；specify a website or URL to get a list of keywords relevant to it;；Note: if a website url is specified, you will still get keywords relevant for the entire website
- `[].location_name` — string，可选。full name of search engine location；optional field；if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；optional field；if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;；if you use this field, you don't need to specify location_name or location_coordinate;；you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；optional field；if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;；if you use this field, you don't need to specify location_name or location_code;；location_coordinate parameter should be specified in the "latitude,longitude" format;；the data will be provided for the country the specified coordinates belong to;；example:；52.6178549,-155.352142
- `[].language_name` — string，可选。full name of search engine language；optional field；you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/languages；example:；English
- `[].language_code` — string，可选。search engine language code；optional field；you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/languages；example:；en
- `[].search_partners` — boolean，可选。include Google search partners；optional field；if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;；default value: false - results are returned for Google search sites
- `[].date_from` — string，可选。starting date of the time range；optional field；date format: "yyyy-mm-dd"；minimal value: 4 years from the current date；by default, data is returned for the past 12 months;；Note: the indicated date cannot be greater than that specified in date_to and/or yesterday's date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;；if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior
- `[].date_to` — string，可选。ending date of the time range；optional field；Note: the indicated date cannot be greater than yesterday's date;；if you don't specify this field, yesterday's date will be used by default；date format: "yyyy-mm-dd"；example:；"2022-11-30"
- `[].sort_by` — string，可选。results sorting parameters；optional field；Use these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in descending order；default value: relevance
- `[].include_adult_keywords` — boolean，可选。include keywords associated with adult content；optional field；if set to true, adult keywords will be included in the response；default value: false；note that the API may return no data for such keywords due to Google Ads restrictions
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "location_code": "2840",
    "keywords": [
      "phone",
      "cellphone"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/google_ads/keywords_for_keywords/tasks_ready

ID: `GoogleAdsKeywordsForKeywordsTasksReady`
用途: ‌ This endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/google_ads/keywords_for_site/live

ID: `GoogleAdsKeywordsForSiteLive`
用途: Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. ‌‌ This endpoint will provide you with a list of keywords relevant to the specified domain along with their bids, search volumes for the last month, search volume trends for the last year (for estimating search volume dynamics), and competition levels.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].target` — string，可选。domain or page；required field；the domain name of the target website or the url of the target page;；note: to obtain keywords for the target website, use the target_type parameter
- `[].target_type` — string，可选。search keywords for site or for url；optional field；possible values: site, page;；default value: page;；if set to site, keywords will be provided for the entire site;；if set to page, keywords will be provided for the specified webpage
- `[].location_name` — string，可选。full name of search engine location；optional field；if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；optional field；if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;；if you use this field, you don't need to specify location_name or location_coordinate;；you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；optional field；if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;；if you use this field, you don't need to specify location_name or location_code;；location_coordinate parameter should be specified in the "latitude,longitude" format;；the data will be provided for the country the specified coordinates belong to;；example:；52.6178549,-155.352142
- `[].language_name` — string，可选。full name of search engine language；optional field；you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/languages；example:；English
- `[].language_code` — string，可选。search engine language code；optional field；you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/languages；example:；en
- `[].search_partners` — boolean，可选。include Google search partners；optional field；if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;；default value: false - results are returned for Google search sites
- `[].date_from` — string，可选。starting date of the time range；optional field；date format: "yyyy-mm-dd"；minimal value: 4 years from the current date；by default, data is returned for the past 12 months;；Note: the indicated date cannot be greater than that specified in date_to and/or yesterday's date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;；if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior
- `[].date_to` — string，可选。ending date of the time range；optional field；Note: the indicated date cannot be greater than yesterday's date;；if you don't specify this field, yesterday's date will be used by default；date format: "yyyy-mm-dd"；example:；"2022-11-30"
- `[].include_adult_keywords` — boolean，可选。include keywords associated with adult content；optional field；if set to true, adult keywords will be included in the response；default value: false；note that the API may return no data for such keywords due to Google Ads restrictions
- `[].sort_by` — string，可选。results sorting parameters；optional field；Use these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in descending order；default value: relevance
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "location_code": "2840",
    "target": "dataforseo.com"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/google_ads/keywords_for_site/task_get/{id}

ID: `GoogleAdsKeywordsForSiteTaskGet`
用途: ‌ Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. ‌‌ This endpoint will provide you with a list of keywords relevant to the specified domain along with their bids, search volumes for the last month, search volume trends for the last year (for estimating search volume dynamics), and competition levels.

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/google_ads/keywords_for_site/task_post

ID: `GoogleAdsKeywordsForSiteTaskPost`
用途: ‌
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].target` — string，可选。domain or page；required field；the domain name of the target website or the url of the target page;；note: to obtain keywords for the target website, use the target_type parameter
- `[].target_type` — string，可选。search keywords for site or url；optional field；possible values: site, page;；default value: page；if set to site, keywords will be provided for the entire site;；if set to page, keywords will be provided for the specified webpage
- `[].location_name` — string，可选。full name of search engine location；optional field；if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；optional field；if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;；if you use this field, you don't need to specify location_name or location_coordinate;；you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；optional field；if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;；if you use this field, you don't need to specify location_name or location_code;；location_coordinate parameter should be specified in the "latitude,longitude" format;；the data will be provided for the country the specified coordinates belong to;；example:；52.6178549,-155.352142
- `[].language_name` — string，可选。full name of search engine language；optional field；you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/languages；example:；English
- `[].language_code` — string，可选。search engine language code；optional field；you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/languages；example:；en
- `[].search_partners` — boolean，可选。include Google search partners；optional field；if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;；default value: false - results are returned for Google search sites
- `[].date_from` — string，可选。starting date of the time range；optional field；date format: "yyyy-mm-dd"；minimal value: 4 years from the current date；by default, data is returned for the past 12 months;；Note: the indicated date cannot be greater than that specified in date_to and/or yesterday's date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;；if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior
- `[].date_to` — string，可选。ending date of the time range；optional field；Note: the indicated date cannot be greater than yesterday's date;；if you don't specify this field, yesterday's date will be used by default；date format: "yyyy-mm-dd"；example:；"2022-11-30"
- `[].include_adult_keywords` — boolean，可选。include keywords associated with adult content；optional field；if set to true, adult keywords will be included in the response；default value: false；note that the API may return no data for such keywords due to Google Ads restrictions
- `[].sort_by` — string，可选。results sorting parameters；optional field；Use these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in descending order；default value: relevance
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "location_code": "2840",
    "target": "dataforseo.com"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/google_ads/keywords_for_site/tasks_ready

ID: `GoogleAdsKeywordsForSiteTasksReady`
用途: ‌ This endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/google_ads/languages

ID: `GoogleAdsLanguages`
用途: By calling this API you will receive the list of languages supported by Keywords Data API. ‌ ‌‌As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information about available languages.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/google_ads/locations

ID: `GoogleAdsLocations`
用途: ‌ We use Google Geographical Targeting. You can refer to Google Ads Target Types page to review the full list of possible location types. With Keywords Data API, you can select any location type supported by Google, except for “Okrug”. Postal Codes can be used to set a task, albeit API response will not return data for such tasks.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/google_ads/locations/{country}

ID: `GoogleAdsLocationsCountry`
用途: ‌ We use Google Geographical Targeting. You can refer to Google Ads Target Types page to review the full list of possible location types. With Keywords Data API, you can select any location type supported by Google, except for “Okrug”. Postal Codes can be used to set a task, albeit API response will not return data for such tasks.

路径与查询参数:
- `country` — path，string，必填。country ISO code optional field specify the ISO code if you want to filter the list of locations by country example: us

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/google_ads/search_volume/live

ID: `GoogleAdsSearchVolumeLive`
用途: ‌ Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。keywords；required field；The maximum number of keywords you can specify: 1000；The maximum number of characters for each keyword: 80；The maximum number of words for each keyword phrase: 10；the keywords you specify will be converted to a lowercase format；Note #1: Google Ads may return no data for certain groups of keywords;；Note #2: Google Ads provides combined search volume values for groups of similar keywords；to obtain search volume for similar keywords, we recommend submitting such keywords in separate requests;；Note #3: Google Ads doesn't allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can't use them when setting a task;；to learn more about which symbols and characters can be used, please refer to this articlelearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；optional field；if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；optional field；if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;；if you use this field, you don't need to specify location_name or location_coordinate;；you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；optional field；if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;；if you use this field, you don't need to specify location_name or location_code;；location_coordinate parameter should be specified in the "latitude,longitude" format;；the data will be provided for the country the specified coordinates belong to;；example:；52.6178549,-155.352142
- `[].language_name` — string，可选。full name of search engine language；optional field；you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/languages；example:；English
- `[].language_code` — string，可选。search engine language code；optional field；you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/languages；example:；en
- `[].search_partners` — boolean，可选。include Google search partners；optional field；if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;；default value: false - results are returned for Google search sites
- `[].date_from` — string，可选。starting date of the time range；optional field；date format: "yyyy-mm-dd"；minimal value: 4 years from the current date；by default, data is returned for the past 12 months;；Note: the indicated date cannot be greater than that specified in date_to and/or yesterday's date;if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;；if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior
- `[].date_to` — string，可选。ending date of the time range；optional field；Note: the indicated date cannot be greater than the past month, Google Ads does not return data on the current month;；if you don't specify this field, yesterday's date will be used by default；date format: "yyyy-mm-dd"；example:；"2022-11-30"
- `[].include_adult_keywords` — boolean，可选。include keywords associated with adult content；optional field；if set to_true, adult keywords will be included in the response；default value:_false；note_that the API may return no data for such keywords due to_Google Ads restrictionsn
- `[].sort_by` — string，可选。results sorting parameters；optional field；use these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in the descending order；default value: relevance
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data array of the response

最小请求示例:

```json
[
  {
    "location_code": "2840",
    "keywords": [
      "buy laptop",
      "cheap laptops for sale",
      "purchase laptop"
    ],
    "date_from": "2021-08-01",
    "search_partners": "true"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/google_ads/search_volume/task_get/{id}

ID: `GoogleAdsSearchVolumeTaskGet`
用途: ‌ Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API.

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/google_ads/search_volume/task_post

ID: `GoogleAdsSearchVolumeTaskPost`
用途: ‌ Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API.
中文补充: **POST** `https://api.seermartech.cn/v3/keywords_data/google_ads/search_volume/task_post`

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。keywords；required field；The maximum number of keywords you can specify: 1000；The maximum number of characters for each keyword: 80；The maximum number of words for each keyword phrase: 10；the keywords you specify will be converted to a lowercase format；Note #1: Google Ads may return no data for certain groups of keywords;；Note #2: Google Ads provides combined search volume values for groups of similar keywords；to obtain search volume for similar keywords, we recommend submitting such keywords in separate requests;；Note #3: Google Ads doesn't allow using certain symbols and characters (e.g., UTF symbols, emojis), so you can't use them when setting a task;；to learn more about which symbols and characters can be used, please refer to this articlelearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；optional field；if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；optional field；if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;；if you use this field, you don't need to specify location_name or location_coordinate;；you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；optional field；if you do not indicate the location, you will receive worldwide results, i.e., for all available locations;；if you use this field, you don't need to specify location_name or location_code;；location_coordinate parameter should be specified in the "latitude,longitude" format;；the data will be provided for the country the specified coordinates belong to;；example:；52.6178549,-155.352142
- `[].language_name` — string，可选。full name of search engine language；optional field；you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/languages；example:；English
- `[].language_code` — string，可选。search engine language code；optional field；you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_ads/languages；example:；en
- `[].search_partners` — boolean，可选。include Google search partners；optional field；if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search;；default value: false - results are returned for Google search sites
- `[].date_from` — string，可选。starting date of the time range；optional field；date format: "yyyy-mm-dd"；minimal value: 4 years from the current date；by default, data is returned for the past 12 months;；Note: the indicated date cannot be greater than that specified in date_to and/or yesterday's date;；if Status endpoint returns false in the actual_data field, date_from can be set to the month before last and prior;；if Status endpoint returns true in the actual_data field, date_from can be set to the last month and prior
- `[].date_to` — string，可选。ending date of the time range；optional field；Note: the indicated date cannot be greater than the past month, Google Ads does not return data on the current month;；if you don't specify this field, yesterday's date will be used by default；date format: "yyyy-mm-dd"；example:；"2022-11-30"
- `[].include_adult_keywords` — boolean，可选。include keywords associated with adult content；optional field；if set to_true, adult keywords will be included in the response；default value:_false；note_that the API may return no data for such keywords due to_Google Ads restrictionsn
- `[].sort_by` — string，可选。results sorting parameters；optional field；use these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in the descending order；default value: relevance
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special character in postback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special character in pingback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data array of the response

最小请求示例:

```json
[
  {
    "location_name": "United States",
    "keywords": [
      "buy laptop",
      "cheap laptops for sale",
      "purchase laptop"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/google_ads/search_volume/tasks_ready

ID: `GoogleAdsSearchVolumeTasksReady`
用途: ‌ This endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/google_ads/status

ID: `GoogleAdsStatus`
用途: ‌ By calling this endpoint, you will know if Google updated keyword data for the previous month. Generally, Google updates keyword data in the middle of the month. So, if Google updated its data in October, you would be able to see the actual search volume, cost-per-click, competition, and other metrics for September. If Google didn’t update its data in October, the latest information would be available for August.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/google_trends/categories

ID: `GoogleTrendsCategories`
用途: By calling this API you will receive the list of categories supported by Google Trends API. ‌ ‌‌As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information about available categories.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/google_trends/explore/live

ID: `GoogleTrendsExploreLive`
用途: This endpoint will provide you with the keyword popularity data from the ‘Explore’ feature of Google Trends. You can check keyword trends for Google Search, Google News, Google Images, Google Shopping, and YouTube.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。keywords；required field；the maximum number of keywords you can specify: 5；the maximum number of characters you can specify in a keyword: 100；the minimum number of characters must be greater than 1；comma characters (,) in the specified keywords will be unset and ignoredNote: keywords cannot consist of a combination of the following characters: &lt; &gt; | " - + = ~ ! : * ( ) [ ] { }Note: to obtain google_trends_topics_list and google_trends_queries_list items, specify no more than 1 keywordlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；optional field；if you don't use this field, you will recieve global results；if you use this field, you don't need to specify location_code；you can use this field as an array to set several locations, each corresponding to a specific keyword - learn more;；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_trends/locations；example:；United Kingdom
- `[].location_code` — string，可选。search engine location code；optional field；if you don't use this field, you will recieve global results；if you use this field, you don't need to specify location_name；you can use this field as an array to set several locations, each corresponding to a specific keyword - learn more;；you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_trends/locations；example:；2840
- `[].language_name` — string，可选。full name of search engine language；optional field；default value: English；if you use this field, you don't need to specify language_code；you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_trends/languages；example:；English
- `[].language_code` — string，可选。search engine language code；optional field；default value: en；if you use this field, you don't need to specify language_name；you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_trends/languages；example:；en
- `[].type` — string，可选。type of element
- `[].category_code` — integer，可选。google trends search category；optional field；if you don't specify this field, the 0 value will be applied by default and the search will be carried out across all available categories；you can receive the list of available categories with their category_code by making a separate request to the https://api.seermartech.cn/v3/keywords_data/google_trends/categories
- `[].date_from` — string，可选。starting date of the time range；optional field；if you don't specify this field, the current day and month of the preceding year will be used by default；minimal value for the web type: 2004-01-01；minimal value for other types: 2008-01-01；date format: "yyyy-mm-dd"；example:；"2019-01-15"
- `[].date_to` — string，可选。ending date of the time range；optional field；if you don't specify this field, the today's date will be used by default；date format: "yyyy-mm-dd"；example:；"2019-01-15"
- `[].time_range` — string，可选。preset time ranges；optional field；if you specify date_from or date_to parameters, this field will be ignored when setting a task；possible values for all type parameters:；past_hour, past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years；possible values for web only:；2004_present；possible values for news, youtube, images, froogle:；2008_present
- `[].item_types` — array<string>，可选。types of items returned；optional field；to speed up the execution of the request, specify one item at a time;；possible values:；"google_trends_graph", "google_trends_map", "google_trends_topics_list","google_trends_queries_list"；default value:；"google_trends_graph"Note: to obtain google_trends_topics_list and google_trends_queries_list items, specify no more than 1 keyword in the keywords field
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "location_name": "United States",
    "date_from": "2019-01-01",
    "date_to": "2020-01-01",
    "type": "youtube",
    "category_code": "3",
    "keywords": [
      "rugby",
      "cricket"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/google_trends/explore/task_get/{id}

ID: `GoogleTrendsExploreTaskGet`
用途: ‌

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/google_trends/explore/task_post

ID: `GoogleTrendsExploreTaskPost`
用途: ‌ This endpoint will provide you with the keyword popularity data from the ‘Explore’ feature of Google Trends. You can check keyword trends for Google Search, Google News, Google Images, Google Shopping, and YouTube.
中文补充: **POST `/v3/keywords_data/google_trends/explore/task_post`**

请求体: `application/json`

请求字段:
- `[].keywords` — array<string>，可选。keywords；required field；the maximum number of keywords you can specify: 5；the maximum number of characters you can specify in a keyword: 100；the minimum number of characters must be greater than 1；comma characters (,) in the specified keywords will be unset and ignoredNote: keywords cannot consist of a combination of the following characters: &lt; &gt; | " - + = ~ ! : * ( ) [ ] { }Note: to obtain google_trends_topics_list and google_trends_queries_list items, specify no more than 1 keywordlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；optional field；if you don't use this field, you will recieve global results；if you use this field, you don't need to specify location_code；you can use this field as an array to set several locations, each corresponding to a specific keyword - learn more;；you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_trends/locations；example:；United Kingdom
- `[].location_code` — string，可选。search engine location code；optional field；if you don't use this field, you will recieve global results；if you use this field, you don't need to specify location_name；you can use this field as an array to set several locations, each corresponding to a specific keyword - learn more;；you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_trends/locations；example:；2840
- `[].language_name` — string，可选。full name of search engine language；optional field；default value: English；if you use this field, you don't need to specify language_code；you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_trends/languages；example:；English
- `[].language_code` — string，可选。search engine language code；optional field；default value: en；if you use this field, you don't need to specify language_name；you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.seermartech.cn/v3/keywords_data/google_trends/languages；example:；en
- `[].type` — string，可选。type of element
- `[].category_code` — integer，可选。google trends search category；optional field；if you don't specify this field, the 0 value will be applied by default and the search will be carried out across all available categories；you can receive the list of available categories with their category_code by making a separate request to the https://api.seermartech.cn/v3/keywords_data/google_trends/categories
- `[].date_from` — string，可选。starting date of the time range；optional field；if you don't specify this field, the current day and month of the preceding year will be used by default；minimal value for the web type: 2004-01-01；minimal value for other types: 2008-01-01；date format: "yyyy-mm-dd"；example:；"2019-01-15"
- `[].date_to` — string，可选。ending date of the time range；optional field；if you don't specify this field, the today's date will be used by default；date format: "yyyy-mm-dd"；example:；"2019-01-15"
- `[].time_range` — string，可选。preset time ranges；optional field；if you specify date_from or date_to parameters, this field will be ignored when setting a task；possible values for all type parameters:；past_hour, past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years；possible values for web only:；2004_present；possible values for news, youtube, images, froogle:；2008_present
- `[].item_types` — array<string>，可选。types of items returned；optional field；to speed up the execution of the request, specify one item at a time;；possible values:；"google_trends_graph", "google_trends_map", "google_trends_topics_list","google_trends_queries_list"；default value:；"google_trends_graph"Note: to obtain google_trends_topics_list and google_trends_queries_list items, specify no more than 1 keyword in the keywords field
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "date_from": "2019-01-01",
    "date_to": "2020-01-01",
    "type": "youtube",
    "category_code": "3",
    "keywords": [
      "seo api",
      "rank api"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/google_trends/explore/tasks_ready

ID: `GoogleTrendsExploreTasksReady`
用途: ‌ This endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/google_trends/languages

ID: `GoogleTrendsLanguages`
用途: By calling this API you will receive the list of languages supported by Google Trends API. ‌ ‌‌As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information about available languages.
中文补充: **GET** `https://api.seermartech.cn/v3/keywords_data/google_trends/languages`

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/google_trends/locations

ID: `GoogleTrendsLocations`
用途: ‌
中文补充: 本接口提供 Google Trends 支持的地理位置列表，可用于在创建趋势任务时获取和校验位置参数。

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/keywords_data/google_trends/locations/{country}

ID: `GoogleTrendsLocationsCountry`
用途: ‌

路径与查询参数:
- `country` — path，string，必填。country ISO code；optional field；specify the ISO code if you want to filter the list of locations by country；example:；us

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/keywords_data/id_list

ID: `KeywordsDataIdList`
用途: This endpoint is designed to provide you with a list of IDs and metadata for all Keywords Data tasks created within the specified time period, including both successful and uncompleted tasks.
中文补充: 本接口使用 **POST** 方法，路径为 **`/v3/keywords_data/id_list`**，用于查询指定时间范围创建的 Keywords Data 任务 ID 及数据，已完成和未完成的任务。

请求体: `application/json`

请求字段:
- `[].datetime_from` — string，可选。start time for filtering results；required field；if include_metadata is set to true, maximum value: a month from current datetime;；if include_metadata is set to false, maximum value: six months from current datetime;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2023-01-15 12:57:46 +00:00
- `[].datetime_to` — string，可选。finish time for filtering results；required field；maximum value: current datetime;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2023-01-31 13:57:46 +00:00
- `[].limit` — integer，可选。the maximum number of returned task IDs；optional field；default value: 1000；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned task IDs；optional field；default value: 0；if you specify the 10 value, the first ten tasks in the results array will be omitted
- `[].sort` — string，可选。sorting by task execution time；optional field；possible values: "asc", "desc"；default value: "asc"
- `[].include_metadata` — boolean，可选。include task metadata in the respond；optional field；default value: false

最小请求示例:

```json
[
  {
    "datetime_from": "2026-08-01 17:42:44",
    "datetime_to": "2026-08-11 17:42:44",
    "limit": "10",
    "include_metadata": "true"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/merchant/amazon/asin/live/advanced

ID: `AmazonAsinLiveAdvanced`
用途: ‌‌ This endpoint will provide you with a full list of ASINs assigned to different modifications of a product.
中文补充: **POST** `https://api.seermartech.cn/v3/merchant/amazon/asin/live/advanced`

请求体: `application/json`

请求字段:
- `[].asin` — string，可选。product ID；required field；unique product identifier (ASIN) in Amazon；you can receive the asin parameter by making a separate request to the Amazon Products endpoint
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations with their location_name parameters by making a separate request to the https://api.seermartech.cn/v3/merchant/amazon/locations；example:；HA1,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations with their location_code parameters by making a separate request to the；https://api.seermartech.cn/v3/merchant/amazon/locations；example:；9045969
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 199.9；example:；53.476225,-2.243572,200
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages with their language_name parameters by making a separate request to the；https://api.seermartech.cn/v3/merchant/amazon/languages；example:；English (United Kingdom)
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code parameters by making a separate request to the https://api.seermartech.cn/v3/merchant/amazon/languages；example:；en_GB
- `[].se_domain` — string，可选。search engine domain；optional field；we choose the relevant search engine domain automatically according to the location and language you specify；however, you can set a custom search engine domain in this field；example:；amazon.com, amazon.co.uk, amazon.fr, etc.
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en_US",
    "location_code": "2840",
    "asin": "B0756FCPPN"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/merchant/amazon/asin/live/html

ID: `AmazonAsinLiveHtml`
用途: ‌‌ This endpoint will provide you with the results in the HTML format.
中文补充: **POST** `https://api.seermartech.cn/v3/merchant/amazon/asin/live/html`

请求体: `application/json`

请求字段:
- `[].asin` — string，可选。product ID；required field；unique product identifier (ASIN) in Amazon；you can receive the asin parameter by making a separate request to the Amazon Products endpoint
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations with their location_name parameters by making a separate request to the https://api.seermartech.cn/v3/merchant/amazon/locations；example:；HA1,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations with their location_code parameters by making a separate request to the；https://api.seermartech.cn/v3/merchant/amazon/locations；example:；9045969
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 199.9；example:；53.476225,-2.243572,200
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages with their language_name parameters by making a separate request to the；https://api.seermartech.cn/v3/merchant/amazon/languages；example:；English (United Kingdom)
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code parameters by making a separate request to the https://api.seermartech.cn/v3/merchant/amazon/languages；example:；en_GB
- `[].se_domain` — string，可选。search engine domain；optional field；we choose the relevant search engine domain automatically according to the location and language you specify；however, you can set a custom search engine domain in this field；example:；amazon.com, amazon.co.uk, amazon.fr, etc.
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en_US",
    "location_code": "2840",
    "asin": "B0756FCPPN"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/merchant/amazon/asin/task_get/advanced/{id}

ID: `AmazonAsinTaskGetAdvanced`
用途: This endpoint will provide you with information about the product and ASINs of all its modifications listed on Amazon.

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/merchant/amazon/asin/task_get/html/{id}

ID: `AmazonAsinTaskGetHtml`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 7 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/merchant/amazon/asin/task_post

ID: `AmazonAsinTaskPost`
用途: ‌‌ This endpoint will provide you with a full list of ASINs assigned to different modifications of a product.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].asin` — string，可选。product ID；required field；unique product identifier (ASIN) in Amazon；you can receive the asin parameter by making a separate request to the Amazon Products endpoint
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations with their location_name parameters by making a separate request to the https://api.seermartech.cn/v3/merchant/amazon/locations；example:；HA1,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name_or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations with their location_code parameters by making a separate request to the；https://api.seermartech.cn/v3/merchant/amazon/locations；example:；9045969n
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name_or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 199.9；example:；53.476225,-2.243572,200
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages with their language_name parameters by making a separate request to the；https://api.seermartech.cn/v3/merchant/amazon/languages；example:；English (United Kingdom)
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code_parameters by making a separate request to the https://api.seermartech.cn/v3/merchant/amazon/languages；example:；en_GB
- `[].se_domain` — string，可选。search engine domain；optional field；we choose the relevant search engine domain automatically according to the location and language you specify；however, you can set a custom search engine domain in this field；example:；amazon.com, amazon.co.uk, amazon.fr, etc.
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatype；required field if you specify postback_url；corresponds to the datatype that will be sent to your server；possible values:；advanced, html
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "language_code": "en_US",
    "location_code": "2840",
    "asin": "B0756FCPPN"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/merchant/amazon/asin/tasks_ready

ID: `AmazonAsinTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints.
中文补充: 本接口使用 **GET** 方法，路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/merchant/amazon/languages

ID: `AmazonLanguages`
用途: You will receive the list of supported Amazon languages by calling this API.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/merchant/amazon/locations

ID: `AmazonLocations`
用途: You will receive the list of supported Amazon locations by this API call. You can filter the list of locations by country when setting a task.
中文补充: 本接口提供 Amazon Merchant API 支持的地点列表，可按国家/地区筛选。

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/merchant/amazon/locations/{country}

ID: `AmazonLocationsCountry`
用途: You will receive the list of supported Amazon locations by this API call. You can filter the list of locations by country when setting a task.

路径与查询参数:
- `country` — path，string，必填。country ISO code；optional field；specify the ISO code if you want to filter the list of locations by country；example:；us

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/merchant/amazon/products/live/advanced

ID: `AmazonProductsLiveAdvanced`
用途: ‌‌ This endpoint provides results from Amazon product listings according to the specified keyword (product name), location, and language parameters.
中文补充: **POST** `https://api.seermartech.cn/v3/merchant/amazon/products/live/advanced`

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；you can specify up to 700 characters in this field；all %## will be decoded (plus character ‘+’ will be decoded to a space character)；if you need to use the “%” character for your keyword, please specify it as “%25”;learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].url` — string，可选。direct URL of the search query；optional field；you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.；example:；https://www.amazon.com/s/?field-keywords=shoes&amp;language=en_US
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations with their location_name parameters by making a separate request to the https://api.seermartech.cn/v3/merchant/amazon/locations；example:；HA1,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations with their location_code parameters by making a separate request to the；https://api.seermartech.cn/v3/merchant/amazon/locations；example:；9045969
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 199.9；example:；53.476225,-2.243572,200
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages with their language_name parameters by making a separate request to the；https://api.seermartech.cn/v3/merchant/amazon/languages；example:；English (United Kingdom)
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code parameters by making a separate request to the https://api.seermartech.cn/v3/merchant/amazon/languages；example:；en_GB
- `[].se_domain` — string，可选。search engine domain；optional field；we choose the relevant search engine domain automatically according to the location and language you specify；however, you can set a custom search engine domain in this field；example:；amazon.com, amazon.co.uk, amazon.fr, etc.
- `[].depth` — integer，可选。parsing depth；optional field；number of results to be retrieved from the Amazon results page；default value: 100；max value: 700；Your account will be billed per each SERP containing up to 100 results; ；Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;；The cost can be calculated on the Pricing page.
- `[].max_crawl_pages` — integer，可选。page crawl limit；optional field；number of search results pages to crawl；max value: 7；Note: the max_crawl_pages and depth parameters complement each other;；learn more at our help center
- `[].department` — string，可选。amazon product department；optional field；specify one of the following amazon departments for extracting product listings:；"Arts & Crafts", "Automotive", "Baby", "Beauty & Personal Care", "Books", "Computers", "Digital Music", "Electronics", "Kindle Store", "Prime Video", "Women's Fashion", "Men's Fashion", "Girls' Fashion", "Boys' Fashion", "Deals", "Health & Household", "Home & Kitchen", "Industrial & Scientific", "Luggage", "Movies & TV", "Music, CDs & Vinyl", "Pet Supplies", "Software", "Sports & Outdoors", "Tools & Home Improvement", "Toys & Games", "Video Games"
- `[].search_param` — string，可选。additional parameters of the search query；optional field；you can use the following Amazon search URL parameters for customizing the search；example:；&low-price=52 - search for products that cost more than 52 USD;；&high-price=45 - search for products that cost less than 45 USD;；&sort=relevancerank - sort results by relevance;；&sort=featured-rank - sort results by featured products;；&sort=price-asc-rank - sort by ascending price;；&sort=price-desc-rank - sort by descending price;；&sort=review-rank - sort by the average customer reviews value;；&sort=date-desc-rank - sort by the newest arrival；Note that search_param values will be ignored if any of the following parameters is used: price_min, price_max, sort_by
- `[].price_min` — integer，可选。minimum product price；optional field；minimum price of the returned products listed on Amazon for the specified query；example:；5；Note: if you specify price_min, the search_param parameter will be ignored
- `[].price_max` — integer，可选。maximum product price；optional field；maximum price of the returned products listed on Amazon for the specified query；example:；100；Note: if you specify price_max, the search_param parameter will be ignored
- `[].sort_by` — string，可选。results sorting rules；optional field；the following sorting rules are supported:；relevance, price_low_to_high, price_high_to_low, featured, avg_customer_review, newest_arrival；example:；sort_by:"relevance"；Note: if you specify sort_by, the search_param parameter will be ignored
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en_US",
    "location_code": "2840",
    "keyword": "shoes"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/merchant/amazon/products/live/html

ID: `AmazonProductsLiveHtml`
用途: ‌‌ This endpoint provides results in the HTML format.
中文补充: **请求方法：** `POST` **请求路径：** `/v3/merchant/amazon/products/live/html` **完整地址：** `https://api.seermartech.cn/v3/merchant/amazon/products/live/html`

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；you can specify up to 700 characters in this field；all %## will be decoded (plus character ‘+’ will be decoded to a space character)；if you need to use the “%” character for your keyword, please specify it as “%25”;learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].url` — string，可选。direct URL of the search query；optional field；you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.；example:；https://www.amazon.com/s/?field-keywords=shoes&amp;language=en_US
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations with their location_name parameters by making a separate request to the https://api.seermartech.cn/v3/merchant/amazon/locations；example:；HA1,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations with their location_code parameters by making a separate request to the；https://api.seermartech.cn/v3/merchant/amazon/locations；example:；9045969
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 199.9；example:；53.476225,-2.243572,200
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages with their language_name parameters by making a separate request to the；https://api.seermartech.cn/v3/merchant/amazon/languages；example:；English (United Kingdom)
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code parameters by making a separate request to the https://api.seermartech.cn/v3/merchant/amazon/languages；example:；en_GB
- `[].se_domain` — string，可选。search engine domain；optional field；we choose the relevant search engine domain automatically according to the location and language you specify；however, you can set a custom search engine domain in this field；example:；amazon.com, amazon.co.uk, amazon.fr, etc.
- `[].depth` — integer，可选。parsing depth；optional field；number of results to be retrieved from the Amazon results page；default value: 100；max value: 700；Your account will be billed per each SERP containing up to 100 results; ；Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;；The cost can be calculated on the Pricing page.
- `[].max_crawl_pages` — integer，可选。page crawl limit；optional field；number of search results pages to crawl；max value: 7；Note: the max_crawl_pages and depth parameters complement each other;；learn more at our help center
- `[].department` — string，可选。amazon product department；optional field；specify one of the following amazon departments for extracting product listings:；"Arts & Crafts", "Automotive", "Baby", "Beauty & Personal Care", "Books", "Computers", "Digital Music", "Electronics", "Kindle Store", "Prime Video", "Women's Fashion", "Men's Fashion", "Girls' Fashion", "Boys' Fashion", "Deals", "Health & Household", "Home & Kitchen", "Industrial & Scientific", "Luggage", "Movies & TV", "Music, CDs & Vinyl", "Pet Supplies", "Software", "Sports & Outdoors", "Tools & Home Improvement", "Toys & Games", "Video Games"
- `[].search_param` — string，可选。additional parameters of the search query；optional field；you can use the following Amazon search URL parameters for customizing the search；example:；&low-price=52 - search for products that cost more than 52 USD;；&high-price=45 - search for products that cost less than 45 USD;；&sort=relevancerank - sort results by relevance;；&sort=featured-rank - sort results by featured products;；&sort=price-asc-rank - sort by ascending price;；&sort=price-desc-rank - sort by descending price;；&sort=review-rank - sort by the average customer reviews value;；&sort=date-desc-rank - sort by the newest arrival；Note that search_param values will be ignored if any of the following parameters is used: price_min, price_max, sort_by
- `[].price_min` — integer，可选。minimum product price；optional field；minimum price of the returned products listed on Amazon for the specified query；example:；5；Note: if you specify price_min, the search_param parameter will be ignored
- `[].price_max` — integer，可选。maximum product price；optional field；maximum price of the returned products listed on Amazon for the specified query；example:；100；Note: if you specify price_max, the search_param parameter will be ignored
- `[].sort_by` — string，可选。results sorting rules；optional field；the following sorting rules are supported:；relevance, price_low_to_high, price_high_to_low, featured, avg_customer_review, newest_arrival；example:；sort_by:"relevance"；Note: if you specify sort_by, the search_param parameter will be ignored
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en_US",
    "location_code": "2840",
    "keyword": "shoes"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/merchant/amazon/products/task_get/advanced/{id}

ID: `AmazonProductsTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/merchant/amazon/products/task_get/html/{id}

ID: `AmazonProductsTaskGetHtml`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 7 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/merchant/amazon/products/task_post

ID: `AmazonProductsTaskPost`
用途: ‌‌ This endpoint provides results from Amazon product listings according to the specified keyword (product name), location, and language parameters.
中文补充: 本接口使用 **POST** 方法，通过路径 `/v3/merchant/amazon/products/task_post` 创建亚马逊商品查询任务。接口根据指定的、地区和语言，获取亚马逊商品搜索结果。

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；you can specify up to 700 characters in this field；all %## will be decoded (plus character ‘+’ will be decoded to a space character)；if you need to use the “%” character for your keyword, please specify it as “%25”;learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].url` — string，可选。direct URL of the search query；optional field；you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.；example:；https://www.amazon.com/s/?field-keywords=shoes&amp;language=en_US
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations with their location_name parameters by making a separate request to the https://api.seermartech.cn/v3/merchant/amazon/locations；example:；HA1,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name_or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations with their location_code parameters by making a separate request to the；https://api.seermartech.cn/v3/merchant/amazon/locations；example:；9045969
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name_or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 199.9；example:；53.476225,-2.243572,200
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages with their language_name parameters by making a separate request to the；https://api.seermartech.cn/v3/merchant/amazon/languages；example:；English (United Kingdom)
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages with their language_code_parameters by making a separate request to the https://api.seermartech.cn/v3/merchant/amazon/languages；example:；en_GB
- `[].se_domain` — string，可选。search engine domain；optional field；we choose the relevant search engine domain automatically according to the location and language you specify；however, you can set a custom search engine domain in this field；example:；amazon.com, amazon.co.uk, amazon.fr, etc.
- `[].depth` — integer，可选。parsing depth；optional field；number of results to be retrieved from the Amazon results page；default value: 100；max value: 700；Your account will be billed per each SERP containing up to 100 results; ；Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;；The cost can be calculated on the Pricing page.
- `[].max_crawl_pages` — integer，可选。page crawl limit；optional field；number of search results pages to crawl；max value: 7；Note: the max_crawl_pages and depth parameters complement each other;；learn more at our help center
- `[].department` — string，可选。amazon product department；optional field；specify one of the following amazon departments for extracting product listings:；"Arts & Crafts", "Automotive", "Baby", "Beauty & Personal Care", "Books", "Computers", "Digital Music", "Electronics", "Kindle Store", "Prime Video", "Women's Fashion", "Men's Fashion", "Girls' Fashion", "Boys' Fashion", "Deals", "Health & Household", "Home & Kitchen", "Industrial & Scientific", "Luggage", "Movies & TV", "Music, CDs & Vinyl", "Pet Supplies", "Software", "Sports & Outdoors", "Tools & Home Improvement", "Toys & Games", "Video Games"
- `[].search_param` — string，可选。additional parameters of the search query；optional field；you can use the following Amazon search URL parameters for customizing the search；example:；&low-price=52 - search for products that cost more than 52 USD;；&high-price=45 - search for products that cost less than 45 USD;；&sort=relevancerank - sort results by relevance;；&sort=featured-rank - sort results by featured products;；&sort=price-asc-rank - sort by ascending price;；&sort=price-desc-rank - sort by descending price;；&sort=review-rank - sort by the average customer reviews value;；&sort=date-desc-rank - sort by the newest arrival；Note that search_param values will be ignored if any of the following parameters is used: price_min, price_max, sort_by
- `[].price_min` — integer，可选。minimum product price；optional field；minimum price of the returned products listed on Amazon for the specified query；example:；5；Note: if you specify price_min, the search_param parameter will be ignored
- `[].price_max` — integer，可选。maximum product price；optional field；maximum price of the returned products listed on Amazon for the specified query；example:；100；Note: if you specify price_max, the search_param parameter will be ignored
- `[].sort_by` — string，可选。results sorting rules；optional field；the following sorting rules are supported:；relevance, price_low_to_high, price_high_to_low, featured, avg_customer_review, newest_arrival；example:；sort_by:"relevance"；Note: if you specify sort_by, the search_param parameter will be ignored
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatype；required field if you specify postback_url；corresponds to the datatype that will be sent to your server；possible values:；advanced, html
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "language_code": "en_US",
    "location_code": "2840",
    "keyword": "shoes"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/merchant/amazon/products/tasks_ready

ID: `AmazonProductsTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
中文补充: 本接口使用 **GET** 方法，路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/merchant/amazon/sellers/live/advanced

ID: `AmazonSellersLiveAdvanced`
用途: ‌‌ This endpoint provides a list of sellers of the specified product on Amazon. The data provided for each seller includes related product condition, pricing, shipment, and rating details. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].asin` — string，可选。unique product identifier on Amazon；required field；you can get this value making a separate request to the Amazon Products endpoint；note that there is no full list of possible values as the asin values is a dynamic value assigned by Amazon；example:；B085RFFC9Q；learn more about the identifier in this help center guide
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available Amazon locations with their location_name by making a separate request to the https://api.seermartech.cn/v3/merchant/amazon/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。location code；required field if you don't specify location_name or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available Amazon locations with their location_code by making a separate request to the https://api.seermartech.cn/v3/merchant/amazon/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 199.9；example:；53.476225,-2.243572,200
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available Amazon languages with their language_name by making a separate request to the https://api.seermartech.cn/v3/merchant/amazon/languages；example:；English (United States)
- `[].language_code` — string，可选。language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available Amazon languages with their language_code by making a separate request to the https://api.seermartech.cn/v3/merchant/amazon/languages；example:；en_US
- `[].se_domain` — string，可选。search engine domain；optional field；we choose the relevant search engine domain automatically according to the location and language you specify；however, you can set a custom search engine domain in this field；example:；amazon.co.uk, amazon.com.au, amazon.de, etc.
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en_US",
    "location_code": "2840",
    "asin": "B07D528W98"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/merchant/amazon/sellers/live/html

ID: `AmazonSellersLiveHtml`
用途: ‌‌ This endpoint provides results in the HTML format.
中文补充: 本接口通过 **POST** 请求调用：

请求体: `application/json`

请求字段:
- `[].asin` — string，可选。unique product identifier on Amazon；required field；you can get this value making a separate request to the Amazon Products endpoint；note that there is no full list of possible values as the asin values is a dynamic value assigned by Amazon；example:；B085RFFC9Q；learn more about the identifier in this help center guide
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available Amazon locations with their location_name by making a separate request to the https://api.seermartech.cn/v3/merchant/amazon/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。location code；required field if you don't specify location_name or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available Amazon locations with their location_code by making a separate request to the https://api.seermartech.cn/v3/merchant/amazon/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 199.9；example:；53.476225,-2.243572,200
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available Amazon languages with their language_name by making a separate request to the https://api.seermartech.cn/v3/merchant/amazon/languages；example:；English (United States)
- `[].language_code` — string，可选。language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available Amazon languages with their language_code by making a separate request to the https://api.seermartech.cn/v3/merchant/amazon/languages；example:；en_US
- `[].se_domain` — string，可选。search engine domain；optional field；we choose the relevant search engine domain automatically according to the location and language you specify；however, you can set a custom search engine domain in this field；example:；amazon.co.uk, amazon.com.au, amazon.de, etc.
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en_US",
    "location_code": "2840",
    "asin": "B085RFFC9Q"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/merchant/amazon/sellers/task_get/advanced/{id}

ID: `AmazonSellersTaskGetAdvanced`
用途: This endpoint provides a list of sellers of the specified product on Amazon. The data provided for each seller includes related product condition, pricing, shipment, and rating details.

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/merchant/amazon/sellers/task_get/html/{id}

ID: `AmazonSellersTaskGetHtml`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 7 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/merchant/amazon/sellers/task_post

ID: `AmazonSellersTaskPost`
用途: ‌‌ This endpoint provides a list of sellers of the specified product on Amazon. The data provided for each seller includes related product condition, pricing, shipment, and rating details. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
中文补充: **POST `/v3/merchant/amazon/sellers/task_post`**

请求体: `application/json`

请求字段:
- `[].asin` — string，可选。unique product identifier on Amazon；required field；you can get this value making a separate request to the Amazon Products endpoint；note that there is no full list of possible values as the asin values is a dynamic value assigned by Amazon；example:；B085RFFC9Q；learn more about the identifier in this help center guide
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available Amazon locations with their location_name by making a separate request to the https://api.seermartech.cn/v3/merchant/amazon/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。location code；required field if you don't specify location_name_or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available Amazon locations with their location_code by making a separate request to the https://api.seermartech.cn/v3/merchant/amazon/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name_or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 199.9；example:；53.476225,-2.243572,200
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available Amazon languages with their language_name by making a separate request to the https://api.seermartech.cn/v3/merchant/amazon/languages；example:；English (United States)
- `[].language_code` — string，可选。language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available Amazon languages with their language_code by making a separate request to the https://api.seermartech.cn/v3/merchant/amazon/languages；example:；en_US
- `[].se_domain` — string，可选。search engine domain；optional field；we choose the relevant search engine domain automatically according to the location and language you specify；however, you can set a custom search engine domain in this field；example:；amazon.co.uk, amazon.com.au, amazon.de, etc.
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatype；required field if you specify postback_url；corresponds to the datatype that will be sent to your server；possible values:；advanced, html
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "asin": "B085RFFC9Q"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/merchant/amazon/sellers/tasks_ready

ID: `AmazonSellersTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/merchant/errors

ID: `MerchantErrors`
用途: By calling this endpoint you will receive information about the Merchant API tasks that returned an error within the past 7 days.
中文补充: 本接口使用 **POST `/v3/merchant/errors`**，用于查询过去 7 天返回错误的商户 API 任务。

请求体: `application/json`

请求字段:
- `[].limit` — integer，可选。the maximum number of returned tasks that responded with an error；optional field；default value: 1000；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned tasks；optional field；default value: 0；if you specify the 10 value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks
- `[].filtered_function` — string，可选。return tasks with a certain function；use this field to obtain a list of tasks that returned an error filtered by a certain function；you can filter the results by the values you receive in the function fields of the API response；i.e., once you receive unfiltered results, you can call this API again to filter them by function ；example: sellers/ad_url, postback_url, pingback_url
- `[].datetime_from` — string，可选。start time for filtering results；optional field；allows filtering results by the datetime parameter within the range of the last 7 days;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2021-11-15 12:57:46 +00:00
- `[].datetime_to` — string，可选。finish time for filtering results；optional field；allows filtering results by the datetime parameter within the range of the last 7 days;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2021-11-15 13:57:46 +00:00

最小请求示例:

```json
[
  {
    "limit": "10",
    "offset": "0",
    "filtered_function": "pingback_url"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/merchant/google/languages

ID: `MerchantGoogleLanguages`
用途: You will receive the list of supported Google Shopping languages by calling this API.
中文补充: 本接口使用 **GET** 方法，通过 `GET /v3/merchant/google/languages` 获取 Google Shopping Merchant API 支持的语言列表。

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/merchant/google/locations

ID: `MerchantGoogleLocations`
中文补充: 本接口用于获取 Merchant API 支持的 Google Shopping 地区列表。支持以下请求方式和路径：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/merchant/google/locations/{country}

ID: `MerchantGoogleLocationsCountry`

路径与查询参数:
- `country` — path，string，必填。country ISO code；optional field；specify the ISO code if you want to filter the list of locations by country；example:；us

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/merchant/google/product_info/task_get/advanced/{id}

ID: `GoogleProductInfoTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/merchant/google/product_info/task_post

ID: `GoogleProductInfoTaskPost`
用途: ‌‌ This endpoint provides data on a product listed on Google Shopping, including product description, images, rating, variations, specifications and sellers. In order to set a task, you have to specify one of the following fields: product_id, data_docid, or gid.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].product_id` — string，可选。unique product identifier on Google Shopping；required field if data_docid or gid is not specified；we recommend specifying product_id together with data_docid and gid for optimal results;；you can get this value for a certain product by making a separate request to the Google Shopping Products endpoint；example:；4485466949985702538；learn more about the parameter in this help center guide
- `[].data_docid` — string，可选。unique identifier of the SERP data element；required field if product_id or gid is not specified；we recommend specifying data_docid together with product_id and gid for optimal results;；you can get this value for a certain element by making a separate request to the Google Shopping Products endpoint；example:；13071766526042404278
- `[].gid` — string，可选。global product identifier on Google Shopping；required field if product_id or data_docid is not specified；we recommend specifying gid together with product_id and data_docid for optimal results;；you can get this value for a certain product by making a separate request to the Google Shopping Products endpoint；example:；4702526954592161872；learn more about the parameter in this help center guide
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available Google Shopping locations with their location_name by making a separate request to the https://api.seermartech.cn/v3/merchant/google/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。location code；required field if you don't specify location_name_or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available Google Shopping locations with their location_code by making a separate request to the https://api.seermartech.cn/v3/merchant/google/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name_or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 199.9；example:；53.476225,-2.243572,200
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available Google Shopping languages with their language_name by making a separate request to the https://api.seermartech.cn/v3/merchant/google/languages；example:；English
- `[].language_code` — string，可选。language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available Google Shopping languages with their language_code_by making a separate request to the https://api.seermartech.cn/v3/merchant/google/languages；example:；en
- `[].se_domain` — string，可选。search engine domain；optional field；we choose the relevant search engine domain automatically according to the location and language you specify；however, you can set a custom search engine domain in this field；example:；google.co.uk, google.com.au, google.de, etc.
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatype；optional field；corresponds to the datatype that will be sent to your server；possible values:；advanced
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "product_id": "1113158713975221117"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/merchant/google/product_info/tasks_ready

ID: `GoogleProductInfoTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/merchant/google/products/task_get/advanced/{id}

ID: `GoogleProductsTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/merchant/google/products/task_get/html/{id}

ID: `GoogleProductsTaskGetHtml`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 7 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/merchant/google/products/task_post

ID: `GoogleProductsTaskPost`
用途: ‌‌ Google Shopping Products endpoint will provide you with the list of products found on Google Shopping for the specified query. The results include product title, description in Google Shopping SERP, product rank, price, reviews and rating as well as the related domain.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；you can specify up to 700 characters in the keyword filed；all %## will be decoded (plus character ‘+’ will be decoded to a space character)；if you need to use the “%” character for your keyword, please specify it as “%25”;learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].url` — string，可选。direct URL of the search query；optional field；you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.；example:；https://www.google.com/search?q=fish&hl=en&gl=US&gws_rd=cr&uule=w+CAIQIFISCQs2MuSEtepUEUK33kOSuTsc
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available Google Shopping locations with their location_name by making a separate request to the https://api.seermartech.cn/v3/merchant/google/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。location code；required field if you don't specify location_name_or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available Google Shopping locations with their location_code by making a separate request to the https://api.seermartech.cn/v3/merchant/google/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name_or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 199.9；example:；53.476225,-2.243572,200
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available Google Shopping languages with their language_name by making a separate request to the https://api.seermartech.cn/v3/merchant/google/languages；example:；English
- `[].language_code` — string，可选。language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available Google Shopping languages with their language_code_by making a separate request to the https://api.seermartech.cn/v3/merchant/google/languages；example:；en
- `[].se_domain` — string，可选。search engine domain；optional field；we choose the relevant search engine domain automatically according to the location and language you specify；however, you can set a custom search engine domain in this field；example:；google.co.uk, google.com.au, google.de, etc.
- `[].depth` — integer，可选。parsing depth；optional field；number of results to be retrieved from Google Shopping SERP；default value: 40；max value: 120；Your account will be billed per each SERP containing up to 40 results; ；Setting depth above 40 may result in additional charges if the search engine returns more than 40 results;；The cost can be calculated on the Pricing page.
- `[].max_crawl_pages` — integer，可选。page crawl limit；optional field；number of search results pages to crawl；max value: 7；Note: the max_crawl_pages and depth parameters complement each other;；learn more at our help center
- `[].search_param` — string，可选。additional parameters of the search query；optional field；you can use the following search URL parameters for customizing the search;；example:；&amp;tbs=ppr_min:45 – search for products that cost more than 45 USD;；&amp;tbs=ppr_max:50 – search for products that cost less than 50 USD;；&amp;tbs=p_ord:p – sort by ascending price;；&amp;tbs=p_ord:pd – sort by descending price;；&amp;tbs=p_ord:rv – sort by review score;；&amp;tbs=ppr_max:50,p_ord:rv – sort by review score with the maximum price of 50 USD.;；&udm=28 – use new Google Shopping markup with 40 SERP results returned by default (the cost for one SERP is deducted accordingly); the maximum depth is 200; this parameter must be specified without tbm=shop in the url;；&shoprs=$value – specify advanced filtering and sorting in the new Shopping markup; replace $value with a string in protobuf Base64 format; learn more on our help center.； ；Note that search_param values will be ignored if any of the following parameters are used: price_min, price_max, sort_by
- `[].price_min` — integer，可选。minimum product price；optional field；minimum price of the returned products listed on Google Shopping for the specified query；example:；5；Note: if you specify price_min, the search_param parameter will be ignored
- `[].price_max` — integer，可选。maximum product price；optional field；maximum price of the returned products listed on Google Shopping for the specified query；example:；100；Note: if you specify price_max, the search_param parameter will be ignored
- `[].sort_by` — string，可选。results sorting rules；optional field；the following sorting rules are supported:；review_score, price_low_to_high, price_high_to_low；example:；sort_by:"review_score"；Note: if you specify sort_by, the search_param parameter will be ignored
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatype；required field if you specify postback_url；corresponds to the datatype that will be sent to your server；possible values:；advanced, html
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "iphone",
    "price_min": "5"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/merchant/google/products/tasks_ready

ID: `GoogleProductsTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/merchant/google/sellers/ad_url/{shop_ad_aclk}

ID: `GoogleSellersAdUrl`
用途: Google Shopping Sellers Ad URL is designed to provide you with a full URL of the advertisement containing all additional parameters set by the seller.

路径与查询参数:
- `shop_ad_aclk` — path，string，必填。unique ad click referral parameter；you can obtain this parameter with Google Shopping Products or Google Shopping Sellers

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/merchant/google/sellers/task_get/advanced/{id}

ID: `GoogleSellersTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/merchant/google/sellers/task_post

ID: `GoogleSellersTaskPost`
用途: ‌‌ Google Shopping Sellers endpoint will provide you with the list of top 10 sellers that listed the specified product on Google Shopping. The provided data for each seller includes related product base and total price, shipment and purchase details and special offers. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
中文补充: 本接口使用 **POST `/v3/merchant/google/sellers/task_post`**，用于提交 Google Shopping 卖家查询任务。接口最多返回指定商品在 Google Shopping 中展示的前 10 个卖家，并提供每个卖家的商品基础价格、总价、与购买信息以及特殊优惠。结果会根据指定的地区和语言返回。

请求体: `application/json`

请求字段:
- `[].product_id` — string，可选。unique product identifier on Google Shopping；required field if data_docid or gid is not specified；we recommend specifying product_id together with data_docid and gid for optimal results;；you can get this value for a certain product by making a separate request to the Google Shopping Products endpoint；example:；4485466949985702538；learn more about the parameter in this help center guide
- `[].data_docid` — string，可选。unique identifier of the SERP data element；required field if product_id or gid is not specified；we recommend specifying data_docid together with product_id and gid for optimal results;；you can get this value for a certain element by making a separate request to the Google Shopping Products endpoint；example:；13071766526042404278
- `[].gid` — string，可选。global product identifier on Google Shopping；required field if product_id or data_docid is not specified；we recommend specifying gid together with product_id and data_docid for optimal results;；you can get this value for a certain product by making a separate request to the Google Shopping Products endpoint；example:；4702526954592161872；learn more about the parameter in this help center guide
- `[].pvf` — string，可选。product variant filter on Google Shopping；optional field；parameter in Google Shopping URL, setting optional product variant filtration;；example:；Eg4iBWNvbG9yKgV3aGl0ZRISIgxwYWNrYWdlIHNpemUqAjE0EgoiBHNpemUqAnhs
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].location_name` — string，可选。full name of the location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available Google Shopping locations with their location_name by making a separate request to the https://api.seermartech.cn/v3/merchant/google/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。location code；required field if you don't specify location_name_or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available Google Shopping locations with their location_code by making a separate request to the https://api.seermartech.cn/v3/merchant/google/locations；example:；2840
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name_or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 199.9；example:；53.476225,-2.243572,200
- `[].language_name` — string，可选。full name of the language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available Google Shopping languages with their language_name by making a separate request to the https://api.seermartech.cn/v3/merchant/google/languages；example:；English
- `[].language_code` — string，可选。language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available Google Shopping languages with their language_code_by making a separate request to the https://api.seermartech.cn/v3/merchant/google/languages；example:；en
- `[].depth` — integer，可选。parsing depth；optional field；number of results to be retrieved from Google Shopping SERP；default value: 10；max value: 200；your account will be billed per each SERP containing up to 10 results; ；setting depth above 10 may result in additional charges if the search engine returns more than 10 results;；the cost can be calculated on the Pricing page
- `[].se_domain` — string，可选。search engine domain；optional field；we choose the relevant search engine domain automatically according to the location and language you specify；however, you can set a custom search engine domain in this field；example:；google.co.uk, google.com.au, google.de, etc.
- `[].get_shops_on_google` — boolean，可选。include "buy on Google" shops；optional field；if set to true, the response will contain the list of sellers that allow to purchase a given product directly on Google；Note: if set to true, the cost of a task will be doubled
- `[].additional_specifications` — object，可选。object containing additional url parameters；you can get additional information about the product by using the "additional_specifications object, which you can get by making a separate request to the Google Shopping Products endpoint；example:；"additional_specifications": {；"eto": "16157121050167572763_0"；}
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].postback_data` — string，可选
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded; ；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "product_id": "1113158713975221117"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/merchant/google/sellers/tasks_ready

ID: `GoogleSellersTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
中文补充: 本接口使用 **GET** 方法，路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/merchant/id_list

ID: `MerchantIdList`
用途: This endpoint is designed to provide you with a list of IDs and metadata for all Merchant tasks created within the specified time period, including both successful and uncompleted tasks.
中文补充: 本接口使用 **POST** 方法，请求路径为 **`/v3/merchant/id_list`**。用于获取指定时间范围创建的商户任务 ID 及数据，结果已完成、成功、失败和未完成的任务。

请求体: `application/json`

请求字段:
- `[].datetime_from` — string，可选。start time for filtering results；required field；if include_metadata is set to true, maximum value: a month from current datetime;；if include_metadata is set to false, maximum value: six months from current datetime;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2023-01-15 12:57:46 +00:00
- `[].datetime_to` — string，可选。finish time for filtering results；required field；maximum value: current datetime;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2023-01-31 13:57:46 +00:00
- `[].limit` — integer，可选。the maximum number of returned task IDs；optional field；default value: 1000；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned task IDs；optional field；default value: 0；if you specify the 10 value, the first ten tasks in the results array will be omitted
- `[].sort` — string，可选。sorting by task execution time；optional field；possible values: "asc", "desc"；default value: "asc"
- `[].include_metadata` — boolean，可选。include task metadata in the respond；optional field；default value: false

最小请求示例:

```json
[
  {
    "datetime_from": "2026-08-01 17:42:44",
    "datetime_to": "2026-08-11 17:42:44",
    "limit": "10",
    "include_metadata": "true"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/merchant/tasks_ready

ID: `MerchantTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/on_page/available_filters

ID: `OnPageAvailableFilters`
用途: OnPage API supports plenty of customizable crawling parameters that allow you to adapt the extraction of website data to your requirements and modify the thresholds for various performance indicators. ‌‌ Here you will find all the necessary information about filters and thresholds that can be used with DataForSEO OnPage API endpoints.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results；contains the full list of available parameters that can be used for data filtration；the parameters are grouped by the endpoint they can be used with

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/on_page/content_parsing

ID: `ContentParsing`
用途: ‌‌ This endpoint allows parsing the content on any page you specify and will return the structured content of the target page, including link URLs, anchors, headings, and textual content.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].url` — string，可选。URL of the content to parse；required field；URL of the page to parse；example:；`https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api`
- `[].id` — string，可选。ID of the task；required field；you can get this ID in the response of the Task POST endpoint；note: the enable_content_parsing parameter in the POST request must be set to true；example:；"07131248-1535-0216-1000-17384017ad04"
- `[].markdown_view` — boolean，可选。return page content as markdown；optional field；if set to true, the markdown-formatted content of the page will be returned in the page_as_markdown field of the response;；default value: false

最小请求示例:

```json
[
  {
    "url": "https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api",
    "id": "11161551-1535-0216-0000-500b3f307f92"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/on_page/content_parsing/live

ID: `ContentParsingLive`
用途: ‌‌ This endpoint allows parsing the content on any page you specify and will return the structured content of the target page, including link URLs, anchors, headings, and textual content.
中文补充: **POST** `https://api.seermartech.cn/v3/on_page/content_parsing/live`

请求体: `application/json`

请求字段:
- `[].url` — string，可选。URL of the content to parse；required field；URL of the page to parse；example:；`https://www.fujielectric.com/`
- `[].custom_user_agent` — string，可选。custom user agent；optional field；custom user agent for crawling a website；example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36；；default value: Mozilla/5.0 (compatible; RSiteAuditor)
- `[].browser_preset` — string，可选。preset for browser screen parameters；optional field；if you use this field, you don't need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factor possible values:；desktop, mobile, tablet desktop preset will apply the following values: browser_screen_width: 1920；browser_screen_height: 1080；browser_screen_scale_factor: 1 mobile preset will apply the following values: browser_screen_width: 390；browser_screen_height: 844；browser_screen_scale_factor: 3 tablet preset will apply the following values: browser_screen_width: 1024；browser_screen_height: 1366；browser_screen_scale_factor: 2 Note: to use this parameter, set enable_javascript or enable_browser_rendering to true
- `[].browser_screen_width` — integer，可选。browser screen width；optional field；you can set a custom browser screen width to perform audit for a particular device;；if you use this field, you don't need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to true minimum value, in pixels: 240；maximum value, in pixels: 9999
- `[].browser_screen_height` — integer，可选。browser screen height；optional field；you can set a custom browser screen height to perform audit for a particular device;；if you use this field, you don't need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to true minimum value, in pixels: 240；maximum value, in pixels: 9999
- `[].browser_screen_scale_factor` — number，可选。browser screen scale factor；optional field；you can set a custom browser screen resolution ratio to perform audit for a particular device;；if you use this field, you don't need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to true minimum value: 0.5；maximum value: 3
- `[].store_raw_html` — boolean，可选。store HTML of a crawled page；optional field；set to true if you want to get the HTML of the page using the OnPage Raw HTML endpoint；default value: false
- `[].disable_cookie_popup` — boolean，可选。disable the cookie popup ；optional field；set to true if you want to disable the popup requesting cookie consent from the user;；default value:；false
- `[].accept_language` — string，可选。language header for accessing the website；optional field；all locale formats are supported (xx, xx-XX, xxx-XX, etc.)；Note: if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the "type":"broken in the response array
- `[].enable_javascript` — boolean，可选。load javascript on a page；optional field；set to true if you want to load the scripts available on a page；default value: false；Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page
- `[].enable_browser_rendering` — boolean，可选。emulate browser rendering to measure Core Web Vitals；optional field；by using this parameter you will be able to emulate a browser when loading a web page;；enable_browser_rendering loads styles, images, fonts, animations, videos, and other resources on a page;；default value: false；set to true to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response;；if you use this field, enable_javascript, and load_resources parameters must be set to true；Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page
- `[].enable_xhr` — boolean，可选。enable XMLHttpRequest on a page；optional field；set to true if you want our crawler to request data from a web server using the XMLHttpRequest object；default value:；false if you use this field, enable_javascript must be set to true;
- `[].switch_pool` — boolean，可选。switch proxy pool；optional field；if true, additional proxy pools will be used to obtain the requested data;；the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors
- `[].ip_pool_for_scan` — string，可选。proxy pool；optional field；you can choose a location of the proxy pool that will be used to obtain the requested data;；the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional site_unreachable errors；possible values: us, de
- `[].markdown_view` — boolean，可选。return page content as markdown；optional field；if set to true, the markdown-formatted content of the page will be returned in the page_as_markdown field of the response;；default value: false

最小请求示例:

```json
[
  {
    "url": "https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/on_page/duplicate_content

ID: `DuplicateContent`
用途: ‌‌ This endpoint returns a list of pages that have content similar to the page specified in the request. The response also contains data related to page performance and the similarity index that indicates how similar the compared pages are.
中文补充: 本接口使用 **POST `/v3/on_page/duplicate_content`**，根据指定页面返回相似的页面列表，同时提供页面性能、质量和 SEO 检查数据。

请求体: `application/json`

请求字段:
- `[].id` — string，可选。ID of the task；required field；you can get this ID in the response of the Task POST endpoint；example:；"07131248-1535-0216-1000-17384017ad04"
- `[].url` — string，可选。page URL；required field；specify the initial page you want to receive duplicate content for
- `[].similarity` — integer，可选。content similarity score；by default, the content is considered duplicate if the value is greater than or equals 6；you can specify any similarity score in the 0-to-10 range
- `[].limit` — integer，可选。the maximum number of returned pages；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned pages；optional field；default value: 0；maximum value: 2000000；if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "id": "07281559-0695-0216-0000-c269be8b7592",
    "url": "https://www.etsy.com/"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/on_page/duplicate_tags

ID: `DuplicateTags`
用途: ‌‌ This endpoint returns a list of pages that contain duplicate title or description tags. The response also contains data related to page performance.
中文补充: 本接口使用 **POST** 方法，路径为 **`/v3/on_page/duplicate_tags`**：

请求体: `application/json`

请求字段:
- `[].id` — string，可选。ID of the task；required field；you can get this ID in the response of the Task POST endpoint；example:；"07131248-1535-0216-1000-17384017ad04"
- `[].type` — string，可选。type of element
- `[].accumulator` — string，可选。tag value；optional field；specify a title or description here if you want to receive a list of duplicate pages that contains this tag
- `[].limit` — integer，可选。the maximum number of returned pages；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned pages；optional field；default value: 0；maximum value: 2000000；if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "id": "07281559-0695-0216-0000-c269be8b7592",
    "type": "duplicate_description",
    "limit": "10"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/on_page/errors

ID: `OnPageErrors`
用途: By calling this endpoint you will receive information about the OnPage API tasks that returned an error within the past 7 days.
中文补充: 本接口使用 **POST `/v3/on_page/errors`**，用于查询过去 7 天返回错误的 OnPage API 任务。

请求体: `application/json`

请求字段:
- `[].limit` — integer，可选。the maximum number of returned tasks that responded with an error；optional field；default value: 1000；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned tasks；optional field；default value: 0；if you specify the 10 value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks
- `[].filtered_function` — string，可选。return tasks with a certain function；use this field to obtain a list of tasks that returned an error filtered by a certain function；you can filter the results by the values you receive in the function fields of the API response；i.e., once you receive unfiltered results, you can call this API again to filter them by function ；example: on_page/task_post, postback_url, pingback_url
- `[].datetime_from` — string，可选。start time for filtering results；optional field；allows filtering results by the datetime parameter within the range of the last 7 days;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2021-11-15 12:57:46 +00:00
- `[].datetime_to` — string，可选。finish time for filtering results；optional field；allows filtering results by the datetime parameter within the range of the last 7 days;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2021-11-15 13:57:46 +00:00

最小请求示例:

```json
[
  {
    "limit": "10",
    "offset": "0",
    "filtered_function": "pingback_url"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/on_page/force_stop

ID: `ForceStop`
用途: ‌‌ This endpoint is designed to force stop the crawl process of websites you specified in a task. The execution of all the tasks associated with the IDs indicated in your request to this endpoint will be stopped. You will still be able to obtain the data on pages that have been scanned until the crawling process was stopped.
中文补充: 本接口用于获取网站扫描任务的整体摘要，并汇总已发现的页面级 SEO 问题。通过返回结果中的问题统计字段，可以进一步调用对应的 OnPage 接口获取 URL 和问题。

请求体: `application/json`

请求字段:
- `[].id` — string，可选。ID of the task；required field；you can get this ID in the response of the Task POST endpoint；example:；"07131248-1535-0216-1000-17384017ad04"note: you can set up to 1000 id values as separate objects in the POST array

最小请求示例:

```json
[
  {
    "id": "08121600-1535-0216-0000-37b4c7a34453"
  },
  {
    "id": "08121600-1535-0216-0000-d6a5000b6897"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/on_page/id_list

ID: `OnPageIdList`
用途: This endpoint is designed to provide you with a list of IDs and metadata for all On-Page tasks created within the specified time period, including both successful and uncompleted tasks.
中文补充: 本接口使用 **POST** 方法，请求路径为 **`/v3/on_page/id_list`**。用于查询指定时间范围创建的 On Page 任务 ID 及数据已完成和未完成的任务。

请求体: `application/json`

请求字段:
- `[].datetime_from` — string，可选。start time for filtering results；required field；if include_metadata is set to true, maximum value: a month from current datetime;；if include_metadata is set to false, maximum value: six months from current datetime;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2023-01-15 12:57:46 +00:00
- `[].datetime_to` — string，可选。finish time for filtering results；required field；maximum value: current datetime;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；example:；2023-01-31 13:57:46 +00:00
- `[].limit` — integer，可选。the maximum number of returned task IDs；optional field；default value: 1000；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned task IDs；optional field；default value: 0；if you specify the 10 value, the first ten tasks in the results array will be omitted
- `[].sort` — string，可选。sorting by task execution time；optional field；possible values: "asc", "desc"；default value: "asc"
- `[].include_metadata` — boolean，可选。include task metadata in the respond；optional field；default value: false

最小请求示例:

```json
[
  {
    "datetime_from": "2026-08-01 17:42:44",
    "datetime_to": "2026-08-11 17:42:44",
    "limit": "10",
    "include_metadata": "true"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/on_page/instant_pages

ID: `InstantPages`
用途: ‌‌ Using this function you will get page-specific data with detailed information on how well a particular page is optimized for organic search.
中文补充: 本接口用于即时获取指定页面的 OnPage SEO 分析数据页面、数据、链接、资源、加载性能、结构化数据、拼写以及页面优化评分等信息。

请求体: `application/json`

请求字段:
- `[].url` — string，可选。target page url；required field；absolute URL of the target page;；Note #1: results will be returned for the specified URL only;；Note #2: to prevent denial-of-service events, tasks that contain a duplicate crawl host will be returned with a 40501 error;；to prevent this error from occurring, avoid setting tasks with the same domain if at least one of your previous tasks with this domain (including a page URL on the domain) is still in a crawling queue
- `[].custom_user_agent` — string，可选。custom user agent；optional field；custom user agent for crawling a website；example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36；；default value: Mozilla/5.0 (compatible; RSiteAuditor)
- `[].browser_preset` — string，可选。preset for browser screen parameters；optional field；if you use this field, you don't need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factorpossible values:；desktop, mobile, tabletdesktop preset will apply the following values:browser_screen_width: 1920；browser_screen_height: 1080；browser_screen_scale_factor: 1mobile preset will apply the following values:browser_screen_width: 390；browser_screen_height: 844；browser_screen_scale_factor: 3tablet preset will apply the following values:browser_screen_width: 1024；browser_screen_height: 1366；browser_screen_scale_factor: 2Note: to use this parameter, set enable_javascript or enable_browser_rendering to true
- `[].browser_screen_width` — integer，可选。browser screen width；optional field；you can set a custom browser screen width to perform audit for a particular device;；if you use this field, you don't need to indicate browser_preset as it will be ignored;Note: to use this parameter, set enable_javascript or enable_browser_rendering to trueminimum value, in pixels: 240；maximum value, in pixels: 9999
- `[].browser_screen_height` — integer，可选。browser screen height；optional field；you can set a custom browser screen height to perform audit for a particular device;；if you use this field, you don't need to indicate browser_preset as it will be ignored;Note: to use this parameter, set enable_javascript or enable_browser_rendering to trueminimum value, in pixels: 240；maximum value, in pixels: 9999
- `[].browser_screen_scale_factor` — number，可选。browser screen scale factor；optional field；you can set a custom browser screen resolution ratio to perform audit for a particular device;；if you use this field, you don't need to indicate browser_preset as it will be ignored;Note: to use this parameter, set enable_javascript or enable_browser_rendering to trueminimum value: 0.5；maximum value: 3
- `[].store_raw_html` — boolean，可选。store HTML of a crawled page；optional field；set to true if you want get the HTML of the page using the OnPage Raw HTML endpoint；default value: false
- `[].accept_language` — string，可选。language header for accessing the website；optional field；all locale formats are supported (xx, xx-XX, xxx-XX, etc.)；Note: if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the "type":"broken in the response array
- `[].load_resources` — boolean，可选。load resources；optional field；set to true if you want to load image, stylesheets, scripts, and broken resources；default value: false；Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page
- `[].enable_browser_rendering` — boolean，可选。emulate browser rendering to measure Core Web Vitals；optional field；by using this parameter you will be able to emulate a browser when loading a web page;；enable_browser_rendering loads styles, images, fonts, animations, videos, and other resources on a page;；default value: false；set to true to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response;；if you use this field, parameters enable_javascript, and load_resources are enabled automatically;；Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page
- `[].disable_cookie_popup` — boolean，可选。disable the cookie popup ；optional field；set to true if you want to disable the popup requesting cookie consent from the user;；default value:；false
- `[].return_despite_timeout` — boolean，可选。return data on pages despite the timeout error；optional field；if true, the data will be provided on pages that failed to load within 120 seconds and responded with a timeout error;；default value: false
- `[].enable_xhr` — boolean，可选。enable XMLHttpRequest on a page；optional field；set to true if you want our crawler to request data from a web server using the XMLHttpRequest object；default value:；falseif you use this field, enable_javascript must be set to true;
- `[].custom_js` — string，可选。custom javascript；optional fieldNote that the execution time for the script you enter here should be 700 ms maximum;；for example, you can use the following JS snippet to check if the website contains Google Tag Manager as a scr attribute:；let meta = { haveGoogleAnalytics: false, haveTagManager: false };rnfor (var i = 0; i &lt; document.scripts.length; i++) {rn let src = document.scripts[i].getAttribute("src");rn if (src != undefined) {rn if (src.indexOf("analytics.js") &gt;= 0)rn meta.haveGoogleAnalytics = true;rntif (src.indexOf("gtm.js") &gt;= 0)rn meta.haveTagManager = true;rn }rn}rnmeta;the returned value depends on what you specified in this field. For instance, if you specify the following script:；meta = {}; meta.url = document.URL; meta.test = 'test'; meta;；as a response you will receive the following data:；"custom_js_response": {；"url": "https://dataforseo.com/",；"test": "test"；}
- `[].validate_micromarkup` — boolean，可选。enable microdata validation；optional field；if set to true, you can use the OnPage API Microdata endpoint with the id of the task;；default value: false
- `[].check_spell` — boolean，可选。check spelling；optional field；set to true to check spelling on a website using Hunspell library；default value: false
- `[].checks_threshold` — object，可选。custom threshold values for checks；optional field；you can specify custom threshold values for the parameters included in the checks array of OnPage API responses;；Note: only integer threshold values can be modified;
- `[].switch_pool` — boolean，可选。switch proxy pool；optional field；if true, additional proxy pools will be used to obtain the requested data;；the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors
- `[].ip_pool_for_scan` — string，可选。proxy pool；optional field；you can choose a location of the proxy pool that will be used to obtain the requested data;；the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional site_unreachable errors；possible values: us, de

最小请求示例:

```json
[
  {
    "url": "https://dataforseo.com/blog",
    "enable_javascript": "true",
    "custom_js": "meta = {}; meta.url = document.URL; meta;"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/on_page/keyword_density

ID: `KeywordDensity`
用途: ‌‌ This endpoint will provide you with keyword density and keyword frequency data for terms appearing on the specified website or web page. You can filter and sort the data that will be retrieved with this API call.
中文补充: **POST `/v3/on_page/keyword_density`**

请求体: `application/json`

请求字段:
- `[].id` — string，可选。ID of the task；required field；you can get this ID in the response of the Task POST endpoint；example:；"07131248-1535-0216-1000-17384017ad04"
- `[].keyword_length` — integer，可选。number of words for a keyword；required field；possible values:；1, 2, 3, 4, 5
- `[].url` — string，可选。page URL；optional field；if you do not specify a page here, the results will be provided for the whole website；if you use this field, the API response will contain only keywords from the specified page；a page should be specified with absolute URL (including http:// or https://)
- `[].limit` — integer，可选。the maximum number of returned keywords；optional field；default value: 100；maximum value: 1000
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, =, &lt;&gt;, in, not_in, like, not_like；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["keyword","=","%seo%"][["keyword","=","%seo%"],；"and",；["frequency","&lt;","6"]][["keyword","not_like","%seo%"],；"and",；[["frequency","&gt;","6"],"or",["density","&gt;","0.02"]]]The full list of possible filters is available by this link.
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["frequency,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["keyword,asc","frequency,desc"]
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "id": "09101923-1535-0216-0000-2389a8854b70",
    "url": "https://dataforseo.com/",
    "keyword_length": "2",
    "filters": [
      "frequency",
      ">",
      "5"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/on_page/lighthouse/audits

ID: `LighthouseAudits`
用途: The OnPage Lighthouse API is based on Google’s open-source Lighthouse project and provides data on the quality of web pages.
中文补充: **GET `/v3/on_page/lighthouse/audits`**

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/on_page/lighthouse/languages

ID: `LighthouseLanguages`
用途: You will receive the list of languages by calling this API. As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
中文补充: 本接口使用 **GET** 方法，请求路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/on_page/lighthouse/live/json

ID: `LighthouseLiveJson`
用途: ‌The OnPage Lighthouse API is based on Google’s open-source Lighthouse project for measuring the quality of web pages and web apps.
中文补充: 本接口基于 Google 开源的 Lighthouse 项目，用于评估网页质量、性能及 Web 应用体验。提交任务使用 `POST /v3/on_page/lighthouse/task_post/`，获取任务结果使用 `GET /v3/on_page/lighthouse/task_get/json`；如需同步获取结果，可使用 `GET /v3/on_page/lighthouse/live/json`。

请求体: `application/json`

请求字段:
- `[].url` — string，可选。target URL；required field；target page should be specified with its absolute URL (including http:// or https://)；example:；https://dataforseo.com/
- `[].for_mobile` — boolean，可选。applies mobile emulation；optional field；if set to true, Lighthouse will use mobile device and screen emulation to test the page against mobile environment；if set to false, the results will be provided for desktop；default value: false
- `[].categories` — array<string>，可选。categories of Lighthouse audits；optional field；each category is a collection of audits and audit groups that applies weighting and scoring to the section (see official definition)if you ignore this field, we will return data for all categories unless you specify audits；use this field to get data for specific categories you indicate herepossible values:；seo, performance, best_practices, accessibility
- `[].audits` — array<string>，可选。Lighthouse audits；optional field；audits are individual tests Lighthouse runs for each specific feature/optimization/metric to produce a numeric score (see official definition); if you ignore this field, we will return data for all audits;；use this field to get data for specific audits you indicate here;Note: that some audits do not belong to a specific category and are stand-alone page quality measurements;in general, there can be several use cases:1. if you ignore categories, you can use this field to get data for the specified audits only；for example, if you ignore "categories" and specify "audits": ["metrics/cumulative-layout-shift","metrics/largest-contentful-paint","metrics/total-blocking-time"], you will get data only for these audits2. if you specify a category, you can use this field to additionally receive audits that do not belong to the category(-ies) you specified；for example, if you specify "categories": ["seo"] and "audits": ["metrics/cumulative-layout-shift","metrics/largest-contentful-paint","metrics/total-blocking-time"], you will get only these audits under "performance" and all audits under "seo"you can get the full list of possible audits here
- `[].version` — string，可选。lighthouse version；optional field；you can obtain the results specific to a certain Lighthouse version by specifying its number；the list of available versions is available through the Lighthouse Versions endpoint
- `[].language_name` — string，可选。lighthouse language name；optional field；you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.seermartech.cn/v3/on_page/lighthouse/languages；default value:；English
- `[].language_code` — string，可选。lighthouse language code；optional field；you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.seermartech.cn/v3/on_page/lighthouse/languages；default value:；en
- `[].custom_user_agent` — string，可选。custom user agent；optional field；specify the custom user agent used by the browser when running the Lighthouse audit;；can be specified with up to 254 characters;
- `[].browser_screen_width` — integer，可选。browser screen width；optional field；set the screen width of the browser used for the Lighthouse audit to emulate a specific device;；can be specified within the following range: 240–9999;
- `[].browser_screen_height` — integer，可选。browser screen height；optional field；set the screen height of the browser used for the Lighthouse audit to emulate a specific device;；can be specified within the following range: 240–9999;
- `[].browser_screen_scale_factor` — number，可选。browser screen scale factor；optional field；set the device pixel ratio of the browser used for the Lighthouse audit;；can be specified within the following range: 0.5–3;
- `[].browser_network_throttling_method` — string，可选。browser network throttling method；optional field；defines the method used to apply throttling during the Lighthouse audit;；possible vaules:；simulate - calculates estimated performance metrics without applying explicit throttling;；devtools - applies the throttling settings specified in browser_network_throttling and browser_cpu_throttling_multiplier;；provided - uses the network conditions of the crawling environment;
- `[].browser_cpu_throttling_multiplier` — number，可选。browser CPU throttling multiplier；required if browser_network_throttling_method is set to devtools;；set the CPU throttling multiplier to simulate device performance conditions during the Lighthouse audit;；can be specified within the following range: 1–4;；Note: this parameter is applied only when browser_network_throttling_method is set to devtools;
- `[].browser_network_throttling` — string，可选。browser network throttling；required if browser_network_throttling_method is set to devtools;；set the network throttling profile to simulate connection speed conditions during the Lighthouse audit;；possible values: no_throttling, fast_4g, slow_4g, regular_3g, pc;；Note: this parameter is applied only when browser_network_throttling_method is set to devtools;
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "url": "https://dataforseo.com",
    "for_mobile": "true",
    "tag": "some_string_123"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。results of Lighthouse audit；this array will include data according to the parameters you specified when setting a task;all fields and their descriptions are available in the official documentation by this link.

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/on_page/lighthouse/task_get/json/{id}

ID: `LighthouseTaskGetJson`
用途: ‌ The OnPage Lighthouse API is based on Google’s open-source Lighthouse project for measuring the quality of web pages and web apps. This endpoint will provide you with the results of Lighthouse Audit. Use the id received in the response of your Task POST request to get the results. The response will include data about all categories and audits specified in the Task POST. By default, the response will include all available data about the webpage including its performance, accessibility, progressive web apps, SEO, and compliance with best practices.

路径与查询参数:
- `id` — path，string，必填。task identifier；required field；you can get this ID in the response of the Task POST endpoint；example:；“07131248-1535-0216-1000-17384017ad04”

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/on_page/lighthouse/task_post

ID: `LighthouseTaskPost`
用途: ‌The OnPage Lighthouse API is based on Google’s open-source Lighthouse project for measuring the quality of web pages and web apps.
中文补充: 本接口使用 **POST** 方法创建 Lighthouse 检测任务：

请求体: `application/json`

请求字段:
- `[].url` — string，可选。target URL；required field；target page should be specified with its absolute URL (including http:// or https://)；example:；https://dataforseo.com/
- `[].for_mobile` — boolean，可选。applies mobile emulation；optional field；if set to true, Lighthouse will use mobile device and screen emulation to test the page against mobile environment；if set to false, the results will be provided for desktop；default value: false
- `[].categories` — array<string>，可选。categories of Lighthouse audits；optional field；each category is a collection of audits and audit groups that applies weighting and scoring to the section (see official definition)if you ignore this field, we will return data for all categories unless you specify audits；use this field to get data for specific categories you indicate herepossible values:；seo, performance, best_practices, accessibility
- `[].audits` — array<string>，可选。Lighthouse audits；optional field；audits are individual tests Lighthouse runs for each specific feature/optimization/metric to produce a numeric score (see official definition)if you ignore this field, we will return data for all audits；use this field to get data for specific audits you indicate herenote that some audits do not belong to a specific category and are stand-alone page quality measurementsin general, there can be several use cases:1. if you ignore categories, you can use this field to get data for the specified audits only；for example, if you ignore "categories" and specify "audits": ["metrics/cumulative-layout-shift","metrics/largest-contentful-paint","metrics/total-blocking-time"], you will get data only for these audits2. if you specify a category, you can use this field to additionally receive audits that do not belong to the category(-ies) you specified；for example, if you specify "categories": ["seo"] and "audits": ["metrics/cumulative-layout-shift","metrics/largest-contentful-paint","metrics/total-blocking-time"], you will get only these audits under "performance" and all audits under "seo"you can get the full list of possible audits here
- `[].version` — string，可选。lighthouse version；optional field；you can obtain the results specific to a certain Lighthouse version by specifying its number；the list of available versions is available through the Lighthouse Versions endpoint
- `[].language_name` — string，可选。lighthouse language name；optional field；you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.seermartech.cn/v3/on_page/lighthouse/languages；default value:；English
- `[].language_code` — string，可选。lighthouse language code；optional field；you can receive the list of available languages of the search engine with their language_code by making a separate request to https://api.seermartech.cn/v3/on_page/lighthouse/languages；default value:；en
- `[].custom_user_agent` — string，可选。custom user agent；optional field；specify the custom user agent used by the browser when running the Lighthouse audit;；can be specified with up to 254 characters;
- `[].browser_screen_width` — integer，可选。browser screen width；optional field；set the screen width of the browser used for the Lighthouse audit to emulate a specific device;；can be specified within the following range: 240–9999;
- `[].browser_screen_height` — integer，可选。browser screen height；optional field；set the screen height of the browser used for the Lighthouse audit to emulate a specific device;；can be specified within the following range: 240–9999;
- `[].browser_screen_scale_factor` — number，可选。browser screen scale factor；optional field；set the device pixel ratio of the browser used for the Lighthouse audit;；can be specified within the following range: 0.5–3;
- `[].browser_network_throttling_method` — string，可选。browser network throttling method；optional field；defines the method used to apply throttling during the Lighthouse audit;；possible vaules:；simulate - calculates estimated performance metrics without applying explicit throttling;；devtools - applies the throttling settings specified in browser_network_throttling and browser_cpu_throttling_multiplier;；provided - uses the network conditions of the crawling environment;
- `[].browser_cpu_throttling_multiplier` — number，可选。browser CPU throttling multiplier；required if browser_network_throttling_method is set to devtools;；set the CPU throttling multiplier to simulate device performance conditions during the Lighthouse audit;；can be specified within the following range: 1–4;；Note: this parameter is applied only when browser_network_throttling_method is set to devtools;
- `[].browser_network_throttling` — string，可选。browser network throttling；required if browser_network_throttling_method is set to devtools;；set the network throttling profile to simulate connection speed conditions during the Lighthouse audit;；possible values: no_throttling, fast_4g, slow_4g, regular_3g, pc;；Note: this parameter is applied only when browser_network_throttling_method is set to devtools;
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "url": "https://dataforseo.com",
    "for_mobile": "true",
    "tag": "some_string_123",
    "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/on_page/lighthouse/tasks_ready

ID: `LighthouseTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
中文补充: 本接口使用 **GET** 方法，路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/on_page/lighthouse/versions

ID: `LighthouseVersions`
用途: OnPage Lighthouse API is based on Google’s open-source Lighthouse project and provides data on the quality of web pages.
中文补充: 本接口用于查询 OnPage Lighthouse API 当前支持的 Lighthouse 版本列表。请求方式与路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/on_page/links

ID: `Links`
用途: ‌‌ This endpoint will provide you with a list of internal and external links detected on a target website. The following link types are supported: anchor – links that point to a specific portion of a webpage; image – links that point to an image; canonical – links that point to a canonical page; meta – links with meta http-equiv=refresh ; alternate – links with link rel="alternate" pointing to an alternative version of a webpage ; redirect – links with redirect status.
中文补充: **POST `/v3/on_page/links`**

请求体: `application/json`

请求字段:
- `[].id` — string，可选。ID of the task；required field；you can get this ID in the response of the Task POST endpoint；example:；"07131248-1535-0216-1000-17384017ad04"
- `[].page_from` — string，可选。relative page URL；optional field；if you use this field, the API response will contain only links from the specified page；note that in this field you can specify relative URLs only
- `[].page_to` — string，可选。relative page URL；optional field；if you use this field, the API response will contain only internal links pointing to the specified page；note that in this field you can specify relative URLs only
- `[].limit` — integer，可选。the maximum number of returned links；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned links；optional field；default value: 0；maximum value: 2000000；if you specify the 10 value, the first ten links in the results array will be omitted and the data will be provided for the successive links
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, =, &lt;&gt;, in, not_in, like, not_like；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["direction","=","external"][["domain_to","&lt;&gt;","example.com"],；"and",；["link_from","not_like","%example.com/blog%"]][["direction","=","external"],；"and",；[["link_from","like","%example.com/blog%"],"or",["link_from","like","%example.com/help%"]]]The full list of possible filters is available by this link.
- `[].search_after_token` — string，可选。token for subsequent requests；optional field；provided in the identical filed of the response to each request;；use this parameter to avoid timeouts while trying to obtain over 20,000 results in a single request;；by specifying the unique search_after_token value from the response array, you will get the subsequent results of the initial task;；search_after_token values are unique for each subsequent task ;；Note: if the search_after_token is specified in the request, all other parameters should be identical to the previous request
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "id": "07281559-0695-0216-0000-c269be8b7592",
    "page_from": "/apis/google-trends-api",
    "filters": [
      [
        "dofollow",
        "=",
        "true"
      ],
      "and",
      [
        "direction",
        "=",
        "external"
      ]
    ],
    "limit": "10"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/on_page/microdata

ID: `Microdata`
用途: ‌‌ This endpoint is designed to validate structured JSON-LD data and Microdata. Using this function you will obtain microdata available on the specified page of the target website and detailed results of its validation. To use this endpoint, set the validate_micromarkup parameter to true in the POST request to OnPage API.
中文补充: 本接口使用 **POST `/v3/on_page/microdata`**，用于获取指定页面中的 JSON-LD 与 Microdata 结构化数据，并返回详细的验证结果。使用前，需要在 OnPage API 的任务创建请求中将 `validate_micromarkup` 设置为 `true`，再通过任务创建接口返回的任务 ID 和页面 URL 请求本接口。

请求体: `application/json`

请求字段:
- `[].id` — string，可选。ID of the task；required field；you can get this ID in the response of the Task POST endpoint；example:；"07131248-1535-0216-1000-17384017ad04"
- `[].url` — string，可选。resource URL；required field；you can get this URL in the response of the Pages endpoint；example:；https://dataforseo.com/apis
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "id": "02241700-1535-0216-0000-034137259bc1",
    "url": "https://dataforseo.com/apis"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/on_page/non_indexable

ID: `NonIndexable`
用途: ‌‌ This endpoint returns a list of pages that are blocked from being indexed by Google and other search engines through robots.txt, HTTP headers, or meta tags settings.
中文补充: 本接口用于获取无法被 Google 及搜索引擎索引的页面列表。页面被判定为不可索引的原因可能 `robots.txt`、HTTP 响应头、Meta 标签或页面属性设置。

请求体: `application/json`

请求字段:
- `[].id` — string，可选。ID of the task；required field；you can get this ID in the response of the Task POST endpoint；example:；"07131248-1535-0216-1000-17384017ad04"
- `[].limit` — integer，可选。the maximum number of returned pages；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned pages；optional field；default value: 0；maximum value: 2000000；if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, like, not_like；you can use the % operator with like and not_like to match any string of zero or more characters；example:；[["reason","&lt;&gt;","robots_txt"],；"and",；["url","not_like","%/wp-admin/%"]][["url","not_like","%/wp-admin/%"],；"and",；[["reason","&lt;&gt;","meta_tag"],"or",["reason","&lt;&gt;","http_header"]]]The full list of possible filters is available by this link.

最小请求示例:

```json
[
  {
    "id": "07281559-0695-0216-0000-c269be8b7592",
    "filters": [
      [
        "reason",
        "=",
        "robots_txt"
      ],
      "and",
      [
        "url",
        "like",
        "%go%"
      ]
    ],
    "limit": "10"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/on_page/page_screenshot

ID: `PageScreenshot`
用途: ‌‌ Using this endpoint, you can capture a full high-quality screenshot of any webpage. In this way, you can review the target page as the DataForSEO crawler and Googlebot see it.
中文补充: 本接口通过浏览器渲染指定网页，并返回页面截图。截图效果可用于检查目标页面在爬虫和搜索引擎抓取环境中的呈现结果。

请求体: `application/json`

请求字段:
- `[].url` — string，可选。page url；required field；absolute URL of the page to snap；note: if the URL you indicate here returns a 404 status code or the indicated value is not a valid URL, you will obtain "error_message":"Screenshot is empty" in the response array
- `[].accept_language` — string，可选。language header for accessing the website；optional field；all locale formats are supported (xx, xx-XX, xxx-XX, etc.)；note: if you do not specify this parameter, some websites may deny access; in this case, you will obtain "error_message":"Screenshot is empty" in the response array
- `[].custom_user_agent` — string，可选。custom user agent；optional field；custom user agent for crawling a website；example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36；；default value: Mozilla/5.0 (compatible; RSiteAuditor)
- `[].browser_preset` — string，可选。preset for browser screen parameters；optional field；if you use this field, you don't need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factorpossible values:；desktop, mobile, tabletdesktop preset will apply the following values:browser_screen_width: 1920；browser_screen_height: 1080；browser_screen_scale_factor: 1mobile preset will apply the following values:browser_screen_width: 390；browser_screen_height: 844；browser_screen_scale_factor: 3tablet preset will apply the following values:browser_screen_width: 1024；browser_screen_height: 1366；browser_screen_scale_factor: 2Note: in this endpoint, the enable_browser_rendering, enable_javascript, load_resources, and enable_xhr parameters are always enabled.
- `[].browser_screen_width` — integer，可选。browser screen width；optional field；you can set a custom browser screen width to perform audit for a particular device;；if you use this field, you don't need to indicate browser_preset as it will be ignored;minimum value, in pixels: 240 ；maximum value, in pixels: 9999
- `[].browser_screen_height` — integer，可选。browser screen height；optional field；you can set a custom browser screen height to perform audit for a particular device;；if you use this field, you don't need to indicate browser_preset as it will be ignored;minimum value, in pixels: 240 ；maximum value, in pixels: 9999
- `[].browser_screen_scale_factor` — number，可选。browser screen scale factor；optional field；you can set a custom browser screen resolution ratio to perform audit for a particular device;；if you use this field, you don't need to indicate browser_preset as it will be ignored;minimum value: 0.5 ；maximum value: 3
- `[].full_page_screenshot` — boolean，可选。take a screenshot of the full page；optional field；set to false if you want to capture only the part of the page displayed before scrolling；default value: true
- `[].disable_cookie_popup` — boolean，可选。disable the cookie popup ；optional field；set to true if you want to disable the popup requesting cookie consent from the user;；default value: ；false
- `[].switch_pool` — boolean，可选。switch proxy pool；optional field；if true, additional proxy pools will be used to obtain the requested data;；the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors
- `[].ip_pool_for_scan` — string，可选。proxy pool；optional field；you can choose a location of the proxy pool that will be used to obtain the requested data;；the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional site_unreachable errors；possible values: us, de

最小请求示例:

```json
[
  {
    "url": "https://dataforseo.com/apis"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/on_page/pages

ID: `Pages`
用途: ‌‌ This endpoint returns a list of crawled pages with on-page check-ups and other metrics related to the page performance. Using this function you will get page-specific data with detailed information on how well your pages are optimized for search.
中文补充: 本接口使用 **POST** 方法，通过 `/v3/on_page/pages` 获取指定爬取任务中的页面列表、页面级 SEO 检查结果、性能指标、分析、资源错误及重定向信息。

请求体: `application/json`

请求字段:
- `[].id` — string，可选。ID of the task；required field；you can get this ID in the response of the Task POST endpoint；example:；"07131248-1535-0216-1000-17384017ad04"
- `[].limit` — integer，可选。the maximum number of returned pages；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned pages；optional field；default value: 0；maximum value: 2000000；if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, like, not_like；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["meta.external_links_count","&lt;=",50]["url","like","https://dataforseo.com/apis/dataforseo-labs-api"][["checks.high_waiting_time","=",false],；"and",["resource_type","=","html"]][["page_timing.duration_time","&lt;",100],"and",[["checks.large_page_size","=",false],"or",["checks.high_waiting_time","=",false]]]The full list of possible filters is available by this link.
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["meta.external_links_count,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["page_timing.dom_complete,asc","size,desc"]
- `[].search_after_token` — string，可选。token for subsequent requests；optional field；provided in the identical filed of the response to each request;；use this parameter to avoid timeouts while trying to obtain over 20,000 results in a single request;；by specifying the unique search_after_token value from the response array, you will get the subsequent results of the initial task;；search_after_token values are unique for each subsequent task ;；Note: if the search_after_token is specified in the request, all other parameters should be identical to the previous request
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "id": "07281559-0695-0216-0000-c269be8b7592",
    "filters": [
      [
        "resource_type",
        "=",
        "html"
      ],
      "and",
      [
        "meta.scripts_count",
        ">",
        "40"
      ]
    ],
    "order_by": [
      "meta.content.plain_text_word_count,desc"
    ],
    "limit": "10"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/on_page/pages_by_resource

ID: `PagesByResource`
用途: ‌‌ This endpoint will return the list of pages where a specific resource is located. Using this function you will also get the data related to the pages that contain a specified resource. You can get the URL of a resource using the Resources endpoint.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].id` — string，可选。ID of the task；required field；you can get this ID in the response of the Task POST endpoint；example:；"07131248-1535-0216-1000-17384017ad04"
- `[].url` — string，可选。resource URL；required field；you can get this URL in the response of the Resources endpoint；example:；https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js
- `[].limit` — integer，可选。the maximum number of returned pages；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned pages；optional field；default value: 0；maximum value: 2000000；if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, like, not_like；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["meta.external_links_count","&lt;=",50]["url","like","https://dataforseo.com/apis/dataforseo-labs-api"][["checks.high_waiting_time","=",false],；"and",["resource_type","=","html"]][["page_timing.duration_time","&lt;",100],"and",[["checks.large_page_size","=",false],"or",["checks.high_waiting_time","=",false]]]The full list of possible filters is available by this link.
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["meta.external_links_count,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["page_timing.dom_complete,asc","size,desc"]
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "id": "02241700-1535-0216-0000-034137259bc1",
    "url": "https://www.etsy.com/about/jobs.workco2018.js?"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/on_page/raw_html

ID: `RawHtml`
用途: ‌‌ This endpoint returns the HTML of a page you indicate in the request.
中文补充: 本接口使用 **POST** 方法，通过 `POST https://api.seermartech.cn/v3/on_page/raw_html` 获取指定页面的原始 HTML。

请求体: `application/json`

请求字段:
- `[].id` — string，可选。ID of the task；required field；you can get this ID in the response of the Task POST endpoint；example:；"07131248-1535-0216-1000-17384017ad04"
- `[].url` — string，可选。page url；required field；the absolute URL of a page to request HTML；Note: this field is optional if the task was set using the Instant Pages endpoint

最小请求示例:

```json
[
  {
    "id": "07281559-0695-0216-0000-c269be8b7592",
    "url": "https://dataforseo.com/apis"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/on_page/redirect_chains

ID: `RedirectChains`
用途: ‌‌ Redirect chains occur when there are at least two redirects between the initial URL and the destination URL. For example, if page A redirects to page B which redirects to page C, such a series of redirects is considered a redirect chain. Sometimes, if page B redirects back to page A, the redirect chain becomes closed and is considered a redirect loop.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].id` — string，可选。ID of the task；required field；you can get this ID in the response of the Task POST endpoint；example:；"07131248-1535-0216-1000-17384017ad04"
- `[].url` — string，可选。page URL；optional field；absolute URL of the target page；if you use this field, the API response will return only redirect chains which contain the specified URL
- `[].limit` — integer，可选。the maximum number of returned redirect chains；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned redirect chains；optional field；default value: 0；maximum value: 2000000；if you specify the 10 value, the first ten redirect chains in the results array will be omitted and the data will be provided for the successive redirect chains
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can use only one filtering parameter with this endpointthe following filtering parameter is supported:；is_redirect_loop；the following operators are supported:；regex, not_regex, =, &lt;&gt;examples:；["is_redirect_loop","=","true"]["is_redirect_loop","&lt;&gt;","false"]
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "id": "03051327-4536-0216-1000-3b458a2cfcca",
    "url": "https://test_rdr.dataforseo.com/a/"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/on_page/resources

ID: `Resources`
用途: ‌‌ This endpoint will provide you with a list of resources, including images, scripts, stylesheets, and broken elements. You will get a detailed overview of every resource found on the crawled pages.
中文补充: `POST /v3/on_page/resources` 用于获取网站爬取页面中的资源列表图片、脚本、样式表及失效资源，并返回每个资源的详细信息。如需查询指定资源的页面，请使用 Pages By Resource 接口。

请求体: `application/json`

请求字段:
- `[].id` — string，可选。ID of the task；required field；you can get this ID in the response of the Task POST endpoint；example:；"07131248-1535-0216-1000-17384017ad04"
- `[].url` — string，可选。page URL；optional field；specify this field if you want to get the resources for a specific page；note that to obtain resource's meta from a particular URL, you should specify the URL in this field;；if you do not indicate a url when setting a task, resource's meta in the results will be returned based on the data from the page where our crawler first saw the resource
- `[].limit` — integer，可选。the maximum number of returned resources；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned resources；optional field；default value: 0；maximum value: 2000000；if you specify the 10 value, the first ten resources in the results array will be omitted and the data will be provided for the successive resources
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, like, not_like；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["resource_type","=","stylesheet"][["resource_type","=","image"],；"and",["checks.is_https","=",false]][["fetch_timing.duration_time",">",1],"and",[["total_transfer_size","&gt;",100],"or",["checks.high_loading_time","=",true]]]The full list of possible filters is available by this link.
- `[].relevant_pages_filters` — array<string>，可选。filter the resources by relevant pages；optional field；you can use this field to obtain resources from pages matching to the defined parameters；you can apply the same filters here as available for the pages endpoint；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, like, not_like；you can use the % operator with like and not_like to match any string of zero or more characters；example:；["checks.no_image_title","=",true]
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["size,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["size,desc","fetch_timing.fetch_end,desc"]
- `[].search_after_token` — string，可选。token for subsequent requests；optional field；provided in the identical filed of the response to each request;；use this parameter to avoid timeouts while trying to obtain over 20,000 results in a single request;；by specifying the unique search_after_token value from the response array, you will get the subsequent results of the initial task;；search_after_token values are unique for each subsequent task ;；Note: if the search_after_token is specified in the request, all other parameters should be identical to the previous request
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "id": "07281559-0695-0216-0000-c269be8b7592",
    "filters": [
      [
        "resource_type",
        "=",
        "image"
      ],
      "and",
      [
        "size",
        ">",
        "100000"
      ]
    ],
    "order_by": [
      "size,desc"
    ],
    "limit": "10"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/on_page/summary/{id}

ID: `Summary`
用途: ‌ Using this function, you can get the overall information on a website as well as drill down into exact on-page issues of a website that has been scanned. As a result, you will know what functions to use for receiving detailed data for each of the found issues.

路径与查询参数:
- `id` — path，string，必填。task identifier；required field；you can get this ID in the response of the Task POST endpoint；example:；“07131248-1535-0216-1000-17384017ad04”

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/on_page/task_post

ID: `TaskPost`
用途: ‌ OnPage API checks websites for 60+ customizable on-page parameters defines and displays all found flaws and opportunities for optimization so that you can easily fix them. It checks meta tags, duplicate content, image tags, response codes, and other parameters on every page. You can find the full list of OnPage API check-up parameters in the Pages section.
中文补充: 本接口使用 **POST** 方法，路径为 **`/v3/on_page/task_post`**，用于创建 OnPage 网站审计任务。本平台会检查网站页面中的 60 多项可参数标签、重复、图片标签、HTTP 响应码及页面 SEO 问题，并返回可用于优化的检测结果。完整检测项请参考 `/v3/on_page/pages`。

请求体: `application/json`

请求字段:
- `[].target` — string，可选。target domain；required field；domain name should be specified without https:// and www.；if you specify the page URL, the results will be returned for the domain included in the URL
- `[].max_crawl_pages` — integer，可选。crawled pages limit；required field；the number of pages to crawl on the specified domain；Note:；if you set max_crawl_pages to 1 and do not specify start_url or set a homepage in it, the following sitewide checks will be disabled:；test_canonicalization, enable_www_redirect_check, test_hidden_server_signature, test_page_not_found, test_directory_browsing, test_https_redirect；to enable them anyway, set force_sitewide_checks to trueif you set max_crawl_pages to 1 and specify start_url other than a homepage, all sitewide checks will be disabled;；to enable them anyway, set force_sitewide_checks to true
- `[].start_url` — string，可选。the first url to crawl ；optional field；Note: you should specify an absolute URL；if you want to crawl a single page, specify its URL in this field and additionally set the max_crawl_pages parameter to 1；you can also use the live Instant Pages endpoint to get page-specific data
- `[].force_sitewide_checks` — boolean，可选。enable sitewide checks when crawling a single page；optional field；set to true to get data on sitewide checks when crawling a single page;；default value: false
- `[].priority_urls` — array<string>，可选。urls to be crawled bypassing the queue；optional field；URLs specified in this array will be crawled in the first instance, bypassing the crawling queue;；Note: you should specify the absolute URL;；you can specify up to 20 URLs;；all URLs in the array must belong to the target domain;；subdomains will be ignored unless the allow_subdomains parameter is set to trueexample:；`"priority_urls": [；"https://dataforseo.com/apis/serp-api",；"https://dataforseo.com/contact"；]`
- `[].max_crawl_depth` — integer，可选。crawl depth；optional field；the linking depth of the pages to crawl;；for example, starting page of the crawl is level 0, pages that have links from that page are level 1, etc.
- `[].crawl_delay` — integer，可选。delay between hits, ms；optional field；the custom delay between crawler hits to the server；default value: 2000
- `[].store_raw_html` — boolean，可选。store HTML of crawled pages；optional field；set to true if you want to get the HTML of the page using the OnPage Raw HTML endpoint；default value: false
- `[].enable_content_parsing` — boolean，可选。parse content on crawled pages；optional field；set to true to use the OnPage Content Parsing endpoint；default value: false
- `[].support_cookies` — boolean，可选。support cookies on crawled pages；optional field；set to true to support cookies when crawling the pages；default value: false
- `[].accept_language` — string，可选。language header for accessing the website；optional field；all locale formats are supported (xx, xx-XX, xxx-XX, etc.)；Note: if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the "type":"broken in the response array
- `[].custom_robots_txt` — string，可选。custom robots.txt settings；optional field；example: Disallow: /directory1/
- `[].robots_txt_merge_mode` — string，可选。merge with or override robots.txt settings；optional field；possible values: merge, override;；set to override if you want to ignore website crawling restrictions and other robots.txt settings；default value: merge;；Note: if set to override, specify the custom_robots_txt parameter
- `[].custom_user_agent` — string，可选。custom user agent；optional field；custom user agent for crawling a website；example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36；；default value: Mozilla/5.0 (compatible; RSiteAuditor)
- `[].browser_preset` — string，可选。preset for browser screen parameters；optional field；if you use this field, you don't need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factorpossible values:；desktop, mobile, tabletdesktop preset will apply the following values:browser_screen_width: 1920；browser_screen_height: 1080；browser_screen_scale_factor: 1mobile preset will apply the following values:browser_screen_width: 390；browser_screen_height: 844；browser_screen_scale_factor: 3tablet preset will apply the following values:browser_screen_width: 1024；browser_screen_height: 1366；browser_screen_scale_factor: 2；Note: to use this parameter, set enable_javascript or enable_browser_rendering to true
- `[].browser_screen_width` — integer，可选。browser screen width；optional field；you can set a custom browser screen width to perform audit for a particular device;；if you use this field, you don't need to indicate browser_preset as it will be ignored;；Note: to use this parameter, set enable_javascript or enable_browser_rendering to trueminimum value, in pixels: 240；maximum value, in pixels: 9999
- `[].browser_screen_height` — integer，可选。browser screen height；optional field；you can set a custom browser screen height to perform an audit for a particular device;；if you use this field, you don't need to indicate browser_preset as it will be ignored;；Note: to use this parameter, set enable_javascript or enable_browser_rendering to trueminimum value, in pixels: 240；maximum value, in pixels: 9999
- `[].browser_screen_scale_factor` — number，可选。browser screen scale factor；optional field；you can set a custom browser screen resolution ratio to perform audit for a particular device;；if you use this field, you don't need to indicate browser_preset as it will be ignored;；Note: to use this parameter, set enable_javascript or enable_browser_rendering to trueminimum value: 0.5；maximum value: 3
- `[].respect_sitemap` — boolean，可选。respect sitemap when crawling；optional field；set to true if you want to follow the order of pages indicated in the primary sitemap when crawling;；default value: false；Note: if set to true, the click_depth value in the API response will equal 0;；the max_crawl_depth field of the request will be ignored, you can specify the number of pages to crawl using the max_crawl_pages parameter
- `[].custom_sitemap` — string，可选。custom sitemap url；optional field；the URL of the page where the alternative sitemap is located；Note: if you want to use this parameter, respect_sitemap should be true
- `[].crawl_sitemap_only` — boolean，可选。crawl only pages indicated in the sitemap；optional field；set to true if you want to crawl only the pages indicated in the sitemap；if you set this parameter to true and do not specify custom_sitemap, we will crawl the default sitemap；default value: false；Note: if you want to use this parameter, respect_sitemap should be true
- `[].load_resources` — boolean，可选。load resources；optional field；set to true if you want to load image, stylesheets, scripts, and broken resources；default value: false；Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page
- `[].enable_www_redirect_check` — boolean，可选。check if the domain implemented the www redirection；optional field；set to true if you want to check if the requested domain implemented the www to non-www or non-www to www redirect;；default value: false
- `[].enable_javascript` — boolean，可选。load javascript on a page；optional field；set to true if you want to load the scripts available on a page；default value: false；Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page
- `[].enable_xhr` — boolean，可选。enable XMLHttpRequest on a page；optional field；set to true if you want our crawler to request data from a web server using the XMLHttpRequest object；default value: false;if you use this field, enable_javascript must be set to true;
- `[].enable_browser_rendering` — boolean，可选。emulate browser rendering to measure Core Web Vitals；optional field；by using this parameter you will be able to emulate a browser when loading a web page;；enable_browser_rendering loads styles, images, fonts, animations, videos, and other resources on a page;；default value: false；set to true to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response;；if you use this field, enable_javascript, and load_resources parameters must be set to true；Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page
- `[].disable_cookie_popup` — boolean，可选。disable the cookie popup；optional field；set to true if you want to disable the popup requesting cookie consent from the user;；default value:；false
- `[].custom_js` — string，可选。custom javascript；optional field；Note that the execution time for the script you enter here should be 700 ms maximum, for example, you can use the following JS snippet to check if the website contains Google Tag Manager as a scr attribute:；let meta = { haveGoogleAnalytics: false, haveTagManager: false };rnfor (var i = 0; i &lt; document.scripts.length; i++) {rn let src = document.scripts[i].getAttribute("src");rn if (src != undefined) {rn if (src.indexOf("analytics.js") &gt;= 0)rn meta.haveGoogleAnalytics = true;rntif (src.indexOf("gtm.js") &gt;= 0)rn meta.haveTagManager = true;rn }rn}rnmeta;the returned value depends on what you specified in this field. For instance, if you specify the following script:；`meta = {}; meta.url = document.URL; meta.test = 'test'; meta;`；as a response you will receive the following data:；`"custom_js_response": {；"url": "https://dataforseo.com/",；"test": "test"；}`；Note: the length of the script you enter must be no more than 2000 characters
- `[].validate_micromarkup` — boolean，可选。enable microdata validation；optional field；set to true if you want to use the OnPage API Microdata endpoint；default value: false
- `[].allow_subdomains` — boolean，可选。include pages on subdomains；optional field；set to true if you want to crawl all subdomains of a target website；default value: false
- `[].allowed_subdomains` — array<string>，可选。subdomains to crawl；optional field；specify subdomains that you want to crawl；example: ["blog.site.com", "my.site.com", "shop.site.com"]；Note: to use this parameter, the allow_subdomains parameter should be set to false;；otherwise, the content of allowed_subdomains field will be ignored and the results will be returned for all subdomains
- `[].disallowed_subdomains` — array<string>，可选。subdomains not to crawl；optional field；specify subdomains that you don't want to crawl；example: ["status.site.com", "docs.site.com"]；Note: to use this parameter, the allow_subdomains parameter should be set to true
- `[].check_spell` — boolean，可选。check spelling；optional field；set to true to check spelling on a website using Hunspell library；default value: false
- `[].check_spell_language` — string，可选。language of the spell check；optional field；supported languages: 'hy', 'eu', 'bg', 'ca', 'hr', 'cs', 'da', 'nl', 'en', 'eo', 'et', 'fo', 'fa', 'fr', 'fy', 'gl', 'ka', 'de', 'el', 'he', 'hu', 'is', 'ia', 'ga', 'it', 'rw', 'la', 'lv', 'lt', 'mk', 'mn', 'ne', 'nb', 'nn', 'pl', 'pt', 'ro', 'gd', 'sr', 'sk', 'sl', 'es', 'sv', 'tr', 'tk', 'uk', 'vi'；Note: if no language is specified, it will be set automatically based on page content
- `[].check_spell_exceptions` — array<string>，可选。words excluded from spell check；optional field；specify the words that you want to exclude from spell check；maximum word length: 100 characters；maximum amount of words: 1000；example: "SERP", "minifiers", "JavaScript"
- `[].calculate_keyword_density` — boolean，可选。calculate keyword density for the target domain；optional field；set to true if you want to calculate keyword density for website pages；default value: false；Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article；once the crawl is completed, you can obtain keyword density values with the Keyword Density endpoint
- `[].checks_threshold` — object，可选。custom threshold values for checks；optional field；you can specify custom threshold values for the parameters included in the checks object of OnPage API responses;；Note: only integer threshold values can be modified;；for example, the high_loading_time and large_page_size parameters are set to 3 seconds and 1 megabyte respectively by default;；if you want to change these thresholds to 1 second and 1000 kbytes, use the following snippet:；`"checks_threshold": {；"high_loading_time": 1,；"large_page_size": 1000；}`；available customizable parameters with default values:；`"title_too_short", default value: 30, type: "int"；"title_too_long", default value: 65, type: "int"；"small_page_size", default value: 1024, type: "int"；"large_page_size", default value: 1048576 (1024 * 1024), type: "int"；"low_character_count", default value: 1024, type: "int"；"high_character_count", default value: 256000 (250 * 1024), type: "int"；"low_content_rate", default value: 0.1, type: "float"；"high_content_rate", default value: 0.9, type: "float"；"high_loading_time", default value: 3000, type: "int"；"high_waiting_time", default value: 1500, type: "int"；"low_readability_rate", default value: 15.0, type: "float"；"irrelevant_description", default value: 0.2, type: "float"；"irrelevant_title", default value: 0.3, type: "float"；"irrelevant_meta_keywords", default value: 0.6, type: "float"`
- `[].disable_sitewide_checks` — array<string>，可选。prevent certain sitewide checks from running；optional field；specify the following checks to prevent them from running on the target website:；"test_page_not_found"；"test_canonicalization"；"test_https_redirect"；"test_directory_browsing"example:；"disable_sitewide_checks": ["test_directory_browsing", "test_page_not_found"]learn more on our help center
- `[].disable_page_checks` — array<string>，可选。prevent certain page checks from running；optional field；specify certain checks to prevent them from running and impacting the onpage_scoreexample:；"disable_page_checks": ["is_5xx_code", "is_4xx_code"]
- `[].switch_pool` — boolean，可选。switch proxy pool；optional field；if true, additional proxy pools will be used to obtain the requested data;；the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors
- `[].return_despite_timeout` — boolean，可选。return data on pages despite the timeout error；optional field；if true, the data will be provided on pages that failed to load within 120 seconds and responded with a timeout error;；default value: false
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "target": "dataforseo.com",
    "max_crawl_pages": "10",
    "load_resources": "true",
    "enable_javascript": "true",
    "custom_js": "meta = {}; meta.url = document.URL; meta;",
    "tag": "some_string_123",
    "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/on_page/tasks_ready

ID: `OnPageTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks, which results haven’t been collected yet.
中文补充: 本接口使用 **GET `/v3/on_page/tasks_ready`**，用于获取已完成但尚未拉取结果的 On-Page 任务列表。

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/on_page/uncrawlable_resources

ID: `UncrawlableResources`
用途: ‌‌This endpoint returns a list of resources detected on the target website that could not be crawled due to a content type inconsistency. A resource is considered uncrawlable when the content type returned in the server response does not match the content type expected based on how the resource is referenced in the page HTML.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].id` — string，可选。ID of the task；required field；you can get this ID in the response of the Task POST endpoint；example:；"07131248-1535-0216-1000-17384017ad04"
- `[].limit` — integer，可选。the maximum number of returned uncrawlable resources；optional field；default value: 100；maximum value: 1000
- `[].offset` — integer，可选。offset in the results array of returned uncrawlable resources；optional field；default value: 0； maximum value: 2000000；if you specify the 10 value, the first ten invalid resources in the results array will be omitted and the data will be provided for the successive invalid resources
- `[].order_by` — array<string>，可选。results sorting rules；optional field；you can use the same values as in the filters array to sort the results；possible sorting types:；asc - results will be sorted in the ascending order；desc - results will be sorted in the descending order；you should use a comma to set up a sorting type；example:；["meta.content_type,desc"]；note that you can set no more than three sorting rules in a single request；you should use a comma to separate several sorting rules；example:；["meta.content_type,asc","fetch_time,desc"]
- `[].filters` — array<object>，可选。array of results filtering parameters；optional field；you can add several filters at once (8 filters maximum)；you should set a logical operator and, or between the conditions；the following operators are supported:；regex, not_regex, &lt;, &lt;=, &gt;, &gt;=, =, &lt;&gt;, in, not_in, like, not_like；you can use the % operator with like and not_like to match any string of zero or more characters；example:； [["meta.content_type","=","image/jpeg"],；"and",；["url","not_like","%/help-center/%"]]The full list of possible filters is available by this link.

最小请求示例:

```json
[
  {
    "id": "07281559-0695-0216-0000-c269be8b7592",
    "filters": [
      [
        "meta.content_type",
        "=",
        "image/jpeg"
      ],
      "and",
      [
        "url",
        "like",
        "%go%"
      ]
    ],
    "limit": "10"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/on_page/waterfall

ID: `Waterfall`
用途: ‌‌ This endpoint is designed to provide you with the page speed insights. Using this function you can get detailed information about the page loading time, time to secure connection, the time it takes to load page resources, and so on.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].id` — string，可选。ID of the task；required field；you can get this ID in the response of the Task POST endpoint；example:；"07131248-1535-0216-1000-17384017ad04"
- `[].url` — string，可选。page URL；required field；specify the pages you want to receive timing for
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "id": "08101204-0696-0216-0000-644a7b21a48a",
    "url": "https://dataforseo.com/tag/broken-links"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/ai_summary

ID: `AiSummary`
用途: ‌‌ The purpose of the Live SERP API AI Summary endpoint is to provide a summary of the content found on any SERP and generate a response based on the user’s specified prompt. To obtain results, you have to specify task_id, which you can find in the response to the POST request. Learn more in our Help Center.
中文补充: 本接口用于分析指定 SERP 中的，并根据用户提供的提示词生成摘要或回答。调用时提供 `task_id`，该参数可从 SERP API 提交任务后的响应中获取。

请求体: `application/json`

请求字段:
- `[].task_id` — string，可选。task identifier；required field；unique identifier of the associated task in the UUID format；you will be able to use it within 30 days to request the results of the task at any time
- `[].prompt` — string，可选。AI prompt；optional field；additional task for AI summariser;；any form of text, question or information that communicates to AI what response you're looking for;；max number of symbols or characters you can specify: 2000;；note: your prompt has to be relevant to the keyword specified in the POST request to SERP API
- `[].support_extra` — boolean，可选。support extra SERP features；optional field；if set to true, the AI model will consider the following extra SERP features, in addition to organic results: answer_box, knowledge_graph, featured_snippet;；default value: true
- `[].fetch_content` — boolean，可选。fetch content from pages in SERPs；optional field；if set to true, the API will fetch the content from pages featured in SERP results, and the AI model will consider this content when generating the summary in the result;；default value: false
- `[].include_links` — boolean，可选。include source links in the summary；optional field；if set to true, the summary field in the API response will contain links to sources of the generated summary;；default value: false

最小请求示例:

```json
[
  {
    "task_id": "07031739-1535-0139-0000-9d1e639a5b7d",
    "prompt": "explain what DataForSEO is",
    "include_links": "true",
    "fetch_content": "true"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/baidu/languages

ID: `BaiduLanguages`
用途: You will receive the list of languages by calling this API. You can also download the full list of supported languages in the CSV format (last updated 2026-04-06).
中文补充: 本接口使用 **GET** 方法，路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/baidu/locations

ID: `BaiduLocations`
用途: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
中文补充: 本接口用于获取百度 SERP 支持的地点列表，可按国家或地区 ISO 代码筛选。

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/baidu/locations/{country}

ID: `BaiduLocationsCountry`
用途: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.

路径与查询参数:
- `country` — path，string，必填。country ISO code；optional field；specify the ISO code if you want to filter the list of locations by country；example:；us

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/baidu/organic/task_get/advanced/{id}

ID: `BaiduOrganicTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/baidu/organic/task_get/html/{id}

ID: `BaiduOrganicTaskGetHtml`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 7 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/baidu/organic/task_get/regular/{id}

ID: `BaiduOrganicTaskGetRegular`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/baidu/organic/task_post

ID: `BaiduOrganicTaskPost`
用途: Baidu SERP API provides top 10 search engine results. These results are specific to the selected location (see the List of Locations) and other settings.
中文补充: 百度 SERP API 用于获取指定、地区、设备类型和操作系统下的百度搜索结果。

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；you can specify up to 700 characters in the keyword field；all %## will be decoded (plus character ‘+’ will be decoded to a space character)；if you need to use the “%” character for your keyword, please specify it as “%25”;；if you need to use the “+” character for your keyword, please specify it as “%2B”learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priority；You will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].depth` — integer，可选。parsing depth；optional field；number of results in SERP；default value: 10；max value: 700；Your account will be billed per each SERP containing up to 10 results; ；Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;；The cost can be calculated on the Pricing page.
- `[].max_crawl_pages` — integer，可选。page crawl limit；optional field；number of search results pages to crawl；default value: 1；max value: 100；Note: the max_crawl_pages and depth parameters complement each other;；learn more at our help center
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesnote that the only language supported in Baidu search engine is Chinese (Simplified). However, Baidu may as well return results for queries in other languages, so specifying keyword in Chinese is not mandatoryexample:；Chinese (Simplified)
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesnote that the only language supported in Baidu search engine is Chinese (Simplified) with the zh_CN language code. However, Baidu may as well return results for queries in other languages, so specifying keyword in Chinese is not mandatoryexample:；zh_CN
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locations；example:；New York,New York,United States
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locations；example:；2156
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 199.9 (mm)；the maximum value for "radius": 199999 (mm)if you use this field, the returned results will be based on the closest city found for your coordinates. Thus, we don't recommend using this field as the results might not be relevant to the specified coordinates；example:；53.476225,-2.243572,200
- `[].device` — string，可选。device type；optional field；return results for a specific device type；can take the values: desktop, mobile, tablet；default value: desktop
- `[].os` — string，可选。device operating system；optional field；if you specify desktop in the device field, choose from the following values: windows, macos；default value: windows；if you specify mobile in the device field, choose from the following values: android, ios；default value: android；if you specify tablet in the device field, choose from the following values: android, ios；default value: android
- `[].get_website_url` — boolean，可选。include direct URL for each ranked result；optional field；if set to true, the returned results will contain direct URLs of the ranked websites；by default, the URLs in Baidu results are encoded by the search engine,；for example:；http://www.baidu.com/link?url=KQt6LSwU5OHnPtB8210R8flBP40grY6lTPxH_0UO7S2kgiZMTmw3ztV0hCo5c1kLdefault value: false；Note: if set to true, the charge per task will be multiplied by 10 as our system runs a separate request for each ranked website to return its direct URL
- `[].stop_crawl_on_match` — array<object>，可选。array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: "stop_crawl_on_match":[{"match_value":"dataforseo.com","match_type":"with_subdomains"}] learn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api Your account will be billed per each SERP crawled through the specified targets
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatype；required field if you specify postback_url；corresponds to the datatype that will be sent to your server；possible values:；regular, html
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "location_code": "2156",
    "keyword": "best iphone ever",
    "tag": "some_string_123",
    "priority": "2"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/baidu/organic/tasks_fixed

ID: `BaiduOrganicTasksFixed`
用途: ‌ The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/baidu/organic/tasks_ready

ID: `BaiduOrganicTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/bing/languages

ID: `BingLanguages`
用途: You will receive the list of languages by calling this API.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/bing/locations

ID: `BingLocations`
用途: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/bing/locations/{country}

ID: `BingLocationsCountry`
用途: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.

路径与查询参数:
- `country` — path，string，必填。country ISO code；optional field；specify the ISO code if you want to filter the list of locations by country；example:；us

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/bing/organic/live/advanced

ID: `BingOrganicLiveAdvanced`
用途: Live SERP provides real-time data on top 100 search engine results for the specified keyword, search engine, and location. This endpoint will supply a complete overview of featured snippets and other extra elements of SERPs.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character '+' will be decoded to a space character)if you need to use the "%" character for your keyword, please specify it as "%25";if you need to use the “+” character for your keyword, please specify it as “%2B”;；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name&nbsp;or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:en
- `[].depth` — integer，可选。parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 200；Your account will be billed per each SERP containing up to 10 results;Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;The cost can be calculated on the Pricing page.
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].target` — string，可选。target domain, subdomain, or webpage to get results foroptional fielda domain or a subdomain should be specified without https:// and www.note that the results of target-specific tasks will only include SERP elements that contain a url string;you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;examples:example.com - returns results for the website's home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;example.com* - returns results for the domain, including all its pages;*example.com* - returns results for the entire domain, including all its pages and subdomains;*example.com - returns results for the home page regardless of the subdomain, such as https://en.example.com;example.com/example-page - returns results for the exact URL;example.com/example-page* - returns results for all domain's URLs that start with the specified string
- `[].stop_crawl_on_match` — array<object>，可选。array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: "stop_crawl_on_match":[{"match_value":"dataforseo.com","match_type":"with_subdomains"}] learn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api Your account will be billed per each SERP crawled through the specified targets
- `[].match_type` — string，可选。target match typerequired field if stop_crawl_on_match is specifiedtype of match for the match_valuepossible values:domain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard – wildcard pattern
- `[].match_value` — string，可选。target domain, subdomain, or wildcard valuerequired field if stop_crawl_on_match is specifiedspecify a target domain, subdomain, or wildcard value;Note: domain or subdomain must be specified without a request protocol;example: "match_value": "dataforseo.com","match_value": "/blog/post-*"
- `[].max_crawl_pages` — integer，可选。page crawl limitoptional fieldnumber of search results pages to crawldefault value: 1max value: 100Note: the max_crawl_pages and depth parameters complement each other;learn more at our help center
- `[].search_param` — string，可选。additional parameters of the search queryoptional fieldget the list of available parameters and additional details here
- `[].calculate_rectangles` — boolean，可选。calculate pixel rankings for SERP elements in advanced resultsoptional fieldpixel ranking refers to the distance between the result snippet and top left corner of the screen;Visit Help Center to learn more&gt;&gt;by default, the parameter is set to falseNote: you will be charged extra $0.002 for using this parameter
- `[].browser_screen_width` — integer，可选。browser screen widthoptional fieldyou can set a custom browser screen width to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1920 for desktop;360 for mobile on android;375 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true
- `[].browser_screen_height` — integer，可选。browser screen heightoptional fieldyou can set a custom browser screen height to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1080 for desktop;640 for mobile on android;812 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true
- `[].browser_screen_resolution_ratio` — integer，可选。browser screen resolution ratiooptional fieldyou can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;can be specified within the following range: 0.5-3;by default, the parameter is set to:1 for desktop;3 for mobile on android;3 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true
- `[].url` — string，可选。direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://www.bing.com/search?q=rank%20checker&amp;count=50&amp;first=1&amp;setlang=en&amp;cc=US&amp;safesearch=Moderate&amp;FORM=SEPAGE
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude" formatthe maximum number of decimal digits for "latitude" and "longitude": 7example:53.476225,-2.243572

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "flight ticket new york san francisco"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/bing/organic/live/html

ID: `BingOrganicLiveHtml`
用途: Live SERP HTML provides a raw HTML page of search engine results for the specified keyword, search engine, and location.

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character '+' will be decoded to a space character)if you need to use the "%" character for your keyword, please specify it as "%25";if you need to use the “+” character for your keyword, please specify it as “%2B”;；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name&nbsp;or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:en
- `[].depth` — integer，可选。parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 200；Your account will be billed per each SERP containing up to 10 results;Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;The cost can be calculated on the Pricing page.
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].stop_crawl_on_match` — array<object>，可选。array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: "stop_crawl_on_match":[{"match_value":"dataforseo.com","match_type":"with_subdomains"}] learn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api Your account will be billed per each SERP crawled through the specified targets
- `[].match_type` — string，可选。target match typerequired field if stop_crawl_on_match is specifiedtype of match for the match_valuepossible values:domain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard – wildcard pattern
- `[].match_value` — string，可选。target domain, subdomain, or wildcard valuerequired field if stop_crawl_on_match is specifiedspecify a target domain, subdomain, or wildcard value;Note: domain or subdomain must be specified without a request protocol;example: "match_value": "dataforseo.com","match_value": "/blog/post-*"
- `[].max_crawl_pages` — integer，可选。page crawl limitoptional fieldnumber of search results pages to crawldefault value: 1max value: 100Note: the max_crawl_pages and depth parameters complement each other;learn more at our help center
- `[].search_param` — string，可选。additional parameters of the search queryoptional fieldget the list of available parameters and additional details here
- `[].url` — string，可选。direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://www.bing.com/search?q=rank%20checker&amp;count=50&amp;first=1&amp;setlang=en&amp;cc=US&amp;safesearch=Moderate&amp;FORM=SEPAGE
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude" formatthe maximum number of decimal digits for "latitude" and "longitude": 7example:53.476225,-2.243572

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/bing/organic/live/regular

ID: `BingOrganicLiveRegular`
用途: Live SERP provides real-time data on search engine results for the specified keyword, search engine, and location.

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character '+' will be decoded to a space character)if you need to use the "%" character for your keyword, please specify it as "%25";if you need to use the “+” character for your keyword, please specify it as “%2B”;；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name&nbsp;or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:en
- `[].depth` — integer，可选。parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 200；Your account will be billed per each SERP containing up to 10 results;Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;The cost can be calculated on the Pricing page.
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].target` — string，可选。target domain, subdomain, or webpage to get results foroptional fielda domain or a subdomain should be specified without https:// and www.note that the results of target-specific tasks will only include SERP elements that contain a url string;you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;examples:example.com - returns results for the website's home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;example.com* - returns results for the domain, including all its pages;*example.com* - returns results for the entire domain, including all its pages and subdomains;*example.com - returns results for the home page regardless of the subdomain, such as https://en.example.com;example.com/example-page - returns results for the exact URL;example.com/example-page* - returns results for all domain's URLs that start with the specified string
- `[].stop_crawl_on_match` — array<object>，可选。array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: "stop_crawl_on_match":[{"match_value":"dataforseo.com","match_type":"with_subdomains"}] learn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api Your account will be billed per each SERP crawled through the specified targets
- `[].match_type` — string，可选。target match typerequired field if stop_crawl_on_match is specifiedtype of match for the match_valuepossible values:domain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard – wildcard pattern
- `[].match_value` — string，可选。target domain, subdomain, or wildcard valuerequired field if stop_crawl_on_match is specifiedspecify a target domain, subdomain, or wildcard value;Note: domain or subdomain must be specified without a request protocol;example: "match_value": "dataforseo.com","match_value": "/blog/post-*"
- `[].max_crawl_pages` — integer，可选。page crawl limitoptional fieldnumber of search results pages to crawldefault value: 1max value: 100Note: the max_crawl_pages and depth parameters complement each other;learn more at our help center
- `[].search_param` — string，可选。additional parameters of the search queryoptional fieldget the list of available parameters and additional details here
- `[].url` — string，可选。direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://www.bing.com/search?q=rank%20checker&amp;count=50&amp;first=1&amp;setlang=en&amp;cc=US&amp;safesearch=Moderate&amp;FORM=SEPAGE
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude" formatthe maximum number of decimal digits for "latitude" and "longitude": 7example:53.476225,-2.243572

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/bing/organic/task_get/advanced/{id}

ID: `BingOrganicTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/bing/organic/task_get/html/{id}

ID: `BingOrganicTaskGetHtml`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 7 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/bing/organic/task_get/regular/{id}

ID: `BingOrganicTaskGetRegular`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/bing/organic/task_post

ID: `BingOrganicTaskPost`
用途: SERP API provides search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character '+' will be decoded to a space character)if you need to use the "%" character for your keyword, please specify it as "%25";if you need to use the “+” character for your keyword, please specify it as “%2B”；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name&nbsp;or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:en
- `[].depth` — integer，可选。parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 700；Your account will be billed per each SERP containing up to 10 results;Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;The cost can be calculated on the Pricing page.
- `[].priority` — integer，可选。task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default)2 – high execution priority；You will be additionally charged for the tasks with high execution priority.The cost can be calculated on the Pricing page.
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop
- `[].pingback_url` — string，可选。notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&amp;tag=$tagNote: special characters in pingback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_url` — string，可选。URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&amp;tag=$tagNote: special characters in postback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatyperequired field if you specify postback_urlcorresponds to the datatype that will be sent to your serverpossible values:regular, advanced, html
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].stop_crawl_on_match` — array<object>，可选。array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: "stop_crawl_on_match":[{"match_value":"dataforseo.com","match_type":"with_subdomains"}] learn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api Your account will be billed per each SERP crawled through the specified targets
- `[].match_type` — string，可选。target match typerequired field if stop_crawl_on_match is specifiedtype of match for the match_valuepossible values:domain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard – wildcard pattern
- `[].match_value` — string，可选。target domain, subdomain, or wildcard valuerequired field if stop_crawl_on_match is specifiedspecify a target domain, subdomain, or wildcard value;Note: domain or subdomain must be specified without a request protocol;example: "match_value": "dataforseo.com","match_value": "/blog/post-*"
- `[].max_crawl_pages` — integer，可选。page crawl limitoptional fieldnumber of search results pages to crawldefault value: 1max value: 100Note: the max_crawl_pages and depth parameters complement each other;learn more at our help center
- `[].search_param` — string，可选。additional parameters of the search queryoptional fieldget the list of available parameters and additional details here
- `[].calculate_rectangles` — boolean，可选。calcualte pixel rankings for SERP elements in advanced resultsoptional fieldpixel ranking refers to the distance between the result snippet and top left corner of the screen;Visit Help Center to learn more&gt;&gt;by default, the parameter is set to falseNote: you will be charged extra $0.0006 for using this parameter
- `[].browser_screen_width` — integer，可选。browser screen widthoptional fieldyou can set a custom browser screen width to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1920 for desktop;360 for mobile on android;375 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true
- `[].browser_screen_height` — integer，可选。browser screen heightoptional fieldyou can set a custom browser screen height to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1080 for desktop;640 for mobile on android;812 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true
- `[].browser_screen_resolution_ratio` — integer，可选。browser screen resolution ratiooptional fieldyou can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;can be specified within the following range: 0.5-3;by default, the parameter is set to:1 for desktop;3 for mobile on android;3 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true
- `[].url` — string，可选。direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://www.bing.com/search?q=rank%20checker&amp;count=50&amp;first=1&amp;setlang=en&amp;cc=US&amp;safesearch=Moderate&amp;FORM=SEPAGE
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude" formatthe maximum number of decimal digits for "latitude" and "longitude": 7example:53.476225,-2.243572

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/bing/organic/tasks_fixed

ID: `BingOrganicTasksFixed`
用途: ‌ The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/bing/organic/tasks_ready

ID: `BingOrganicTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/errors

ID: `Errors`
用途: By calling this endpoint you will receive information about the SERP API tasks that returned an error within the past 7 days.
中文补充: 本接口使用 **POST** 方法，路径为 **`/v3/serp/errors`**。用于查询过去 7 天返回错误的 SERP API 任务。

请求体: `application/json`

请求字段:
- `[].limit` — integer，可选。the maximum number of returned tasks that responded with an error；optional field；default value: 1000；maximum value: 1000；minimum value: 1
- `[].offset` — integer，可选。offset in the results array of returned tasks；optional field；if you specify the 10 value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks；default and minimum value: 0；maximum value: 100M (100 million)
- `[].filtered_function` — string，可选。return tasks with a certain function；use this field to obtain a list of tasks that returned an error filtered by the certain endpoint's URL, as well as pingback_url or postback_url specified in the API request;；you can filter the results by the values you receive in the function fields of the API response;；i.e., once you receive unfiltered results, you can call this API again to filter them by function; ；example: serp/task_get/advanced
- `[].datetime_from` — string，可选。start time for filtering results；optional field；allows filtering results by the datetime parameter within the range of the last 7 days;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00";；minimum value: 7 days from the current datetime；maximum value: current datetime；example:；2021-11-15 12:57:46 +00:00
- `[].datetime_to` — string，可选。finish time for filtering results；optional field；allows filtering results by the datetime parameter within the range of the last 7 days;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00"；minimum value: 7 days from the current datetime；maximum value: current datetime；Note datetime_to must be greater than datetime_from if both parameters are used;；example:；2021-11-15 13:57:46 +00:00

最小请求示例:

```json
[
  {
    "limit": "10",
    "offset": "0",
    "filtered_function": "pingback_url"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/ads_advertisers/locations

ID: `GoogleAdsAdvertisersLocations`
用途: ‌ ‌‌As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
中文补充: **GET `/v3/serp/google/ads_advertisers/locations`**

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/ads_advertisers/task_get/advanced/{id}

ID: `GoogleAdsAdvertisersTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/ads_advertisers/task_post

ID: `GoogleAdsAdvertisersTaskPost`
用途: Google Ads Advertisers provides information on advertisers that run campaigns on Google Ads based on the Ads Transparency platform. ‌‌
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”;if you need to use the “+” character for your keyword, please specify it as “%2B”；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].priority` — integer，可选。task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default)2 – high execution priority；You will be additionally charged for the tasks with high execution priority.The cost can be calculated on the Pricing page.
- `[].location_code` — integer，可选。search engine location codeoptional fieldif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/google/ads_advertisers/locationsexample:2840；Note: if you don't specify location_name, location_code, or location_coordinate, advertisers will be searched across all the available locations
- `[].pingback_url` — string，可选。notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&amp;tag=$tagNote: special characters in pingback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_url` — string，可选。URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&amp;tag=$tagNote: special characters in postback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatyperequired field if you specify postback_urlcorresponds to the function you used for setting a taskpossible values:advanced
- `[].location_name` — string，可选。full name of search engine locationoptional fieldif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/ads_advertisers/locationsexample:London,England,United Kingdom；Note: if you don't specify location_name, location_code, or location_coordinate, advertisers will be searched across all the available locations
- `[].location_coordinate` — string，可选。GPS coordinates of a locationoptional fieldif you use this field, you don't need to specify location_name or location_codeexample:52.6178549,-155.352142；Note: if you don't specify location_name, location_code, or location_coordinate, advertisers will be searched across all the available locations
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "location_code": "2840",
    "keyword": "apple"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/ads_advertisers/tasks_ready

ID: `GoogleAdsAdvertisersTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/ads_search/locations

ID: `GoogleAdsSearchLocations`
中文补充: 本接口使用 **GET** 方法，路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/ads_search/task_get/advanced/{id}

ID: `GoogleAdsSearchTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/ads_search/task_post

ID: `GoogleAdsSearchTaskPost`
用途: Google Ads Search provides information on ads that are run by advertisers on Google Ads. Information is based on the Ads Transparency platform and adapted for the convenience of DataForSEO users. ‌‌
中文补充: 本接口使用 **POST** 方法，通过 `/v3/serp/google/ads_search/task_post` 创建 Google Ads 搜索广告 SERP 任务。接口基于广告透明度数据，并指定的广告主、域名、位置、平台及时间范围返回广告信息。

请求体: `application/json`

请求字段:
- `[].advertiser_ids` — array<string>，可选。advertiser identifiersrequired field if target is not specified；you can specify the maximum of 25 values in this array;advertiser_ids values for this parameter can be found in the Google Ads Advertisers endpoint;
- `[].target` — string，可选。domain namerequired field if advertiser_ids is not specifieddomain name associated with an advertiser account
- `[].location_code` — integer，可选。search engine location codeoptional fieldif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/google/ads_search/locationsexample:2840；Note: if you don't specify location_name, location_code, or location_coordinate, the ads will be searched across all the available locations
- `[].depth` — integer，可选。parsing depthoptional fieldnumber of results in SERPdefault value: 40max value: 700；Your account will be billed per each SERP containing up to 40 results;Setting depth above 40 may result in additional charges if the search engine returns more than 40 results;The cost can be calculated on the Pricing page.
- `[].priority` — integer，可选。task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default)2 – high execution priority；You will be additionally charged for the tasks with high execution priority.The cost can be calculated on the Pricing page.
- `[].pingback_url` — string，可选。notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&amp;tag=$tagNote: special characters in pingback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_url` — string，可选。URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&amp;tag=$tagNote: special characters in postback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatyperequired field if you specify postback_urlcorresponds to the function you used for setting a taskpossible values:advanced
- `[].location_name` — string，可选。full name of search engine locationoptional fieldif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/ads_search/locationsexample:London,England,United Kingdom；Note: if you don't specify location_name, location_code, or location_coordinate, the ads will be searched across all the available locations
- `[].location_coordinate` — string，可选。GPS coordinates of a locationoptional fieldif you use this field, you don't need to specify location_name or location_codeexample:52.6178549,-155.352142；Note: if you don't specify location_name, location_code, or location_coordinate, the ads will be searched across all the available locations
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].platform` — string，可选。advertising platformoptional fieldpossible values: all, google_play, google_maps, google_search, google_shopping, youtubedefault value: all
- `[].format` — string，可选。ad formatoptional fieldpossible values: all, text, image, video
- `[].date_from` — string，可选。starting date of the time rangeoptional fieldrequired field if date_to is specified; ；date format: "yyyy-mm-dd"minimum value: 2018-05-31maximum value: today's dateexample:"2020-01-01"
- `[].date_to` — string，可选。ending date of the time rangeoptional fieldrequired field if date_from is specified; ；date format: "yyyy-mm-dd"minimum value: 2018-05-31maximum value: today's dateexample:"2020-01-01"

最小请求示例:

```json
[
  {
    "location_code": "2840",
    "platform": "google_search",
    "advertiser_ids": [
      "AR13752565271262920705",
      "AR02439908557932462081"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/ads_search/tasks_ready

ID: `GoogleAdsSearchTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/ai_mode/languages

ID: `GoogleAiModeLanguages`
用途: You will receive the list of languages by calling this API. As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
中文补充: **GET `/v3/serp/google/ai_mode/languages`**

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/ai_mode/live/advanced

ID: `GoogleAiModeLiveAdvanced`
用途: ‌‌ Google AI Mode SERP API provides search results from the AI Mode feature of Google Search.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”;if you need to use the “+” character for your keyword, please specify it as “%2B”；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name&nbsp;or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/google/locationsNote: check Google Search Help for the list of countries where AI Mode is currently available
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_name;if you use this field, you don't need to specify language_name;you can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/google/ai_mode/languages
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/locationsNote: check Google Search Help for the list of countries where AI Mode is currently available
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_code;if you use this field, you don't need to specify language_code;you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/ai_mode/languages;
- `[].os` — string，可选。device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].calculate_rectangles` — boolean，可选。calculate pixel rankings for SERP elements in advanced resultsoptional fieldpixel ranking refers to the distance between the result snippet and top left corner of the screen;Visit Help Center to learn more&gt;&gt;by default, the parameter is set to falseNote: if set to true, the charge per task will be multiplied by 2
- `[].browser_screen_width` — integer，可选。browser screen widthoptional fieldyou can set a custom browser screen width to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1920 for desktop;360 for mobile on android;375 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true
- `[].browser_screen_height` — integer，可选。browser screen heightoptional fieldyou can set a custom browser screen height to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1080 for desktop;640 for mobile on android;812 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true
- `[].browser_screen_resolution_ratio` — integer，可选。browser screen resolution ratiooptional fieldyou can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;can be specified within the following range: 0.5-3;by default, the parameter is set to:1 for desktop;3 for mobile on android;3 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude,zoom" formatif "zoom" is not specified, 9z will be applied as a default valuethe maximum number of decimal digits for "latitude" and "longitude": 7the minimum value for "zoom": 4zthe maximum value for "zoom": 18zexample:52.6178549,-155.352142,18z

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "what is google ai mode"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/ai_mode/live/html

ID: `GoogleAiModeLiveHtml`
用途: ‌ Live SERP HTML provides a raw HTML page of 100 search engine results for the specified keyword, search engine, and location.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；you can specify up to 700 characters in the keyword field；all %## will be decoded (plus character '+' will be decoded to a space character)；if you need to use the "%" character for your keyword, please specify it as "%25";；if you need to use the “+” character for your keyword, please specify it as “%2B”;
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name_or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locations；example:；2840n
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name_or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 199.9 (mm)；the maximum value for "radius": 199999 (mm)；example:；53.476225,-2.243572,200n
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code;；if you use this field, you don't need to specify language_code;；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/ai_mode/languages;
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name;；if you use this field, you don't need to specify language_name;；you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.seermartech.cn/v3/serp/google/ai_mode/languagesn
- `[].device` — string，可选。device type；optional field；return results for a specific device type；can take the values:desktop, mobile；default value: desktop
- `[].os` — string，可选。device operating system；optional field；if you specify desktop in the device field, choose from the following values: windows, macos；default value: windows；if you specify mobile in the device field, choose from the following values: android, ios；default value: android
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/ai_mode/task_get/advanced/{id}

ID: `GoogleAiModeTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；a universally unique identifier (UUID)；unique task identifier in our system；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/ai_mode/task_get/html/{id}

ID: `GoogleAiModeTaskGetHtml`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 7 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/ai_mode/task_post

ID: `GoogleAiModeTaskPost`
用途: ‌ Google AI Mode SERP API provides search results from the AI Mode feature of Google Search.
中文补充: 本接口使用 **POST** 方法，通过 `/v3/serp/google/ai_mode/task_post` 提交 Google AI Mode 搜索结果采集任务。

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”;if you need to use the “+” character for your keyword, please specify it as “%2B”；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name&nbsp;or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/google/locationsNote: check Google Search Help for the list of countries where AI Mode is currently available
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_name;if you use this field, you don't need to specify language_name;you can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/google/ai_mode/languages
- `[].priority` — integer，可选。task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default)2 – high execution priority；You will be additionally charged for the tasks with high execution priority.The cost can be calculated on the Pricing page.
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop
- `[].pingback_url` — string，可选。notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&amp;tag=$tagNote: special characters in pingback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_url` — string，可选。URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&amp;tag=$tagNote: special characters in postback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatyperequired field if you specify postback_urlcorresponds to the function you used for setting a taskpossible values:advanced, html
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/locationsNote: check Google Search Help for the list of countries where AI Mode is currently available
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_code;if you use this field, you don't need to specify language_code;you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/ai_mode/languages;
- `[].os` — string，可选。device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].calculate_rectangles` — boolean，可选。calculate pixel rankings for SERP elements in advanced resultsoptional fieldpixel ranking refers to the distance between the result snippet and top left corner of the screen;Visit Help Center to learn more&gt;&gt;by default, the parameter is set to falseNote: if set to true, the charge per task will be multiplied by 2
- `[].browser_screen_width` — integer，可选。browser screen widthoptional fieldyou can set a custom browser screen width to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1920 for desktop;360 for mobile on android;375 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true
- `[].browser_screen_height` — integer，可选。browser screen heightoptional fieldyou can set a custom browser screen height to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1080 for desktop;640 for mobile on android;812 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true
- `[].browser_screen_resolution_ratio` — integer，可选。browser screen resolution ratiooptional fieldyou can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;can be specified within the following range: 0.5-3;by default, the parameter is set to:1 for desktop;3 for mobile on android;3 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude,zoom" formatif "zoom" is not specified, 9z will be applied as a default valuethe maximum number of decimal digits for "latitude" and "longitude": 7the minimum value for "zoom": 4zthe maximum value for "zoom": 18zexample:52.6178549,-155.352142,18z

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "what is google ai mode"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/ai_mode/tasks_fixed

ID: `GoogleAiModeTasksFixed`
用途: ‌ The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/ai_mode/tasks_ready

ID: `GoogleAiModeTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.
中文补充: 本接口使用 **GET** 方法，通过任务 ID 获取 Google AI Mode 高级搜索结果：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/autocomplete/live/advanced

ID: `GoogleAutocompleteLiveAdvanced`
用途: ‌‌ Google Autocomplete is a feature within Google Search that improves the search experience by allowing users to complete searches they started to type. DataForSEO SERP API will provide you with all the suggestions Google Autocomplete offers for a particular keyword, the position of the cursor pointer, and the search client.
中文补充: **POST** `https://api.seermartech.cn/v3/serp/google/autocomplete/live/advanced`

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”;if you need to use the “+” character for your keyword, please specify it as “%2B”;；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name;you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/serp/google/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_name;you can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:en
- `[].cursor_pointer` — integer，可选。search bar cursor pointeroptional fieldthe horizontal numerical position of the cursor pointer within the keyword in the search bar;by modifying the position of the cursor pointer, you will obtain different autocomplete suggestions for the same seed keyword;minimal value: 0default value: the number of the last character of the specified keywordexample:|which query are s - "cursor_pointer": 0which query is s| - "cursor_pointer": 16which que|ry is s - "cursor_pointer": 9
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_codeif you use this field, you don't need to specify location_code;you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/serp/google/autocomplete/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_code;you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.seermartech.cn/v3/serp/google/languagesexample:English
- `[].client` — string，可选。search client for autocompleteoptional fieldautocomplete results may differ depending on the search client;possible values:chrome — used when google search is opened in google chrome;chrome-omni — used in the address bar in chrome;gws-wiz — used in google search home page;gws-wiz-serp — used in google search engine results page;safari — used when google search is opened in safari browser;firefox — used when google search is opened in firefox browser;psy-ab — may be used when google search is opened in google chrome browser;toolbar — returns XML;youtube — returns JSONP;gws-wiz-local — used in google local;img — used in google's image search;products-cc — used in google shopping search
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein",
    "client": "gws-wiz-serp"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/autocomplete/task_get/advanced/{id}

ID: `GoogleAutocompleteTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/autocomplete/task_post

ID: `GoogleAutocompleteTaskPost`
用途: ‌‌ Google Autocomplete is a feature within Google Search that improves the search experience by allowing users to complete searches they started to type. DataForSEO SERP API will provide you with all the suggestions Google Autocomplete offers for a particular keyword, the position of the cursor pointer, and the search client.
中文补充: 本接口使用 **POST** 方法，路径为 `/v3/serp/google/autocomplete/task_post`。用于提交 Google Autocomplete（搜索自动补）查询任务，获取指定、标位置、搜索客户端对应的自动补建议。

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”;if you need to use the “+” character for your keyword, please specify it as “%2B”;；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name;you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/serp/google/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_name;you can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:en
- `[].cursor_pointer` — integer，可选。search bar cursor pointeroptional fieldthe horizontal numerical position of the cursor pointer within the keyword in the search bar;by modifying the position of the cursor pointer, you will obtain different autocomplete suggestions for the same seed keyword;minimal value: 0default value: the number of the last character of the specified keywordexample:|which query are s - "cursor_pointer": 0which query is s| - "cursor_pointer": 16which que|ry is s - "cursor_pointer": 9
- `[].priority` — integer，可选。task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default);2 – high execution priority；You will be additionally charged for the tasks with high execution priority;The cost can be calculated on the Pricing page
- `[].pingback_url` — string，可选。notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&amp;tag=$tagNote: special characters in pingback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_url` — string，可选。URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the requestexample:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&amp;tag=$tagNote: special characters in postback_url will be url-encoded;i.e., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatyperequired field if you specify postback_urlcorresponds to the datatype that will be sent to your serverpossible values:advanced
- `[].client` — string，可选。search client for autocompleteoptional fieldautocomplete results may differ depending on the search client;possible values:chrome — used when google search is opened in google chrome;chrome-omni — used in the address bar in chrome;gws-wiz — used in google search home page;gws-wiz-serp — used in google search engine results page;safari — used when google search is opened in safari browser;firefox — used when google search is opened in firefox browser;psy-ab — may be used when google search is opened in google chrome browser;toolbar — returns XML;youtube — returns JSONP;gws-wiz-local — used in google local;img — used in google's image search;products-cc — used in google shopping search
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_codeif you use this field, you don't need to specify location_code;you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/serp/google/autocomplete/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_code;you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.seermartech.cn/v3/serp/google/languagesexample:English
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein",
    "cursor_pointer": "6"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/autocomplete/tasks_fixed

ID: `GoogleAutocompleteTasksFixed`
用途: ‌ The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/autocomplete/tasks_ready

ID: `GoogleAutocompleteTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/dataset_info/live/advanced

ID: `GoogleDatasetInfoLiveAdvanced`
用途: ‌ Live Google Dataset Info provides real-time data on the dataset you specify in the request. You will get data from a page of the dataset displayed separately from the SERP. It contains information about dataset content, authors, licenses, and description on the SERP.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].dataset_id` — string，可选。ID of the datasetrequired fieldyou can find dataset ID in the dataset URL or dataset item of Google Dataset Search resultexample:L2cvMTFqbl85ZHN6MQ==
- `[].language_code` — string，可选。search engine language codeoptional fieldif you use this field, you don't need to specify language_namepossible value:en
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typepossible value: desktop
- `[].language_name` — string，可选。full name of search engine languageoptional fieldif you use this field, you don't need to specify language_codepossible value:English
- `[].os` — string，可选。device operating systemoptional fieldpossible values: windows, macosdefault value: windows
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "dataset_id": "L2cvMTFqbl85ZHN6MQ=="
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/dataset_info/task_get/advanced/{id}

ID: `GoogleDatasetInfoTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/dataset_info/task_post

ID: `GoogleDatasetInfoTaskPost`
用途: ‌‌ Google Dataset Info API provides detailed information about the dataset you specify in the POST request. You will get data from a page of the dataset displayed separately from the SERP. It contains information about dataset content, authors, licenses, and description on the SERP.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].dataset_id` — string，可选。ID of the datasetrequired fieldyou can find dataset ID in the dataset URL or dataset item of Google Dataset Search resultexample:L2cvMTFqbl85ZHN6MQ==
- `[].language_code` — string，可选。search engine language codeoptional fieldif you use this field, you don't need to specify language_namepossible value:en
- `[].priority` — integer，可选。task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default)2 – high execution priority；You will be additionally charged for the tasks with high execution priority.The cost can be calculated on the Pricing page.
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typepossible value: desktop
- `[].pingback_url` — string，可选。notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&amp;tag=$tagNote: special characters in pingback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_url` — string，可选。URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the requestexample:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&amp;tag=$tagNote: special characters in postback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatyperequired field if you specify postback_urlcorresponds to the datatype that will be sent to your serverpossible value: advanced
- `[].language_name` — string，可选。full name of search engine languageoptional fieldif you use this field, you don't need to specify language_codepossible value:English
- `[].os` — string，可选。device operating systemoptional fieldchoose from the following values: windows, macosdefault value: windows
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "dataset_id": "L2cvMTFqbl85ZHN6MQ=="
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/dataset_info/tasks_fixed

ID: `GoogleDatasetInfoTasksFixed`
用途: ‌ The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/dataset_info/tasks_ready

ID: `GoogleDatasetInfoTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/dataset_search/live/advanced

ID: `GoogleDatasetSearchLiveAdvanced`
用途: ‌ Live Google Dataset Search provides real-time data on the top 20 Google Dataset search engine results. These results are specific to the indicated keyword. You can specify other parameters optionally.
中文补充: 本接口通过实时检索获取 Google Dataset Search 针对指定的结果，默认返回前 20 条数据集结果，并支持按更新时间、文件格式、使用权利、是否及主题等条件筛选。

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”;if you need to use the “+” character for your keyword, please specify it as “%2B”;；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].language_code` — string，可选。search engine language codeoptional field if you don't specify language_nameif you use this field, you don't need to specify language_namepossible value:en
- `[].depth` — integer，可选。parsing depthoptional fieldnumber of results in SERPdefault value: 20max value: 200；Your account will be billed per each SERP containing up to 20 results;Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically.
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typepossible value: desktop
- `[].language_name` — string，可选。full name of search engine languageoptional fieldif you use this field, you don't need to specify language_codepossible value:English
- `[].os` — string，可选。device operating systemoptional fieldchoose from the following values: windows, macosdefault value: windows
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].last_updated` — string，可选。last time the dataset was updatedoptional fieldpossible values: 1m, 1y, 3y
- `[].file_formats` — array<string>，可选。file formats of the datasetoptional fieldpossible values: other, archive, text, image, document, tabular
- `[].usage_rights` — string，可选。usage rights of the datasetoptional fieldpossible values: commercial, noncommercial
- `[].is_free` — boolean，可选。indicates whether displayed datasets are freeoptional fieldpossible values: true, false
- `[].topics` — array<string>，可选。dataset topicsoptional fieldpossible values: humanities, social_sciences, life_sciences, agriculture, natural_sciences, geo, computer, architecture_and_urban_planning, engineering

最小请求示例:

```json
[
  {
    "keyword": "water quality",
    "last_updated": "1m",
    "file_formats": [
      "archive",
      "image"
    ],
    "usage_rights": "noncommercial",
    "is_free": "true",
    "topics": [
      "natural_sciences",
      "geo"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/dataset_search/task_get/advanced/{id}

ID: `GoogleDatasetSearchTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/dataset_search/task_post

ID: `GoogleDatasetSearchTaskPost`
用途: ‌‌ Google Dataset Search API provides top 20 Google Dataset search engine results. These results are specific to the indicated keyword. You can specify other parameters optionally.
中文补充: 本接口通过 **POST `/v3/serp/google/dataset_search/task_post`** 创建 Google Dataset Search 任务，返回与指定的 Google Dataset Search 前 20 条结果的任务标识。可通过 `depth`、数据集更新时间、文件格式、使用权限等参数进一步筛选结果。

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”;if you need to use the “+” character for your keyword, please specify it as “%2B”.；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].language_code` — string，可选。search engine language codeoptional fieldpossible value:en
- `[].depth` — integer，可选。parsing depthoptional fieldnumber of results in SERPdefault value: 20max value: 700；Your account will be billed per each SERP containing up to 20 results;Setting depth above 20 may result in additional charges if the search engine returns more than 20 results;If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;
- `[].priority` — integer，可选。task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default)2 – high execution priority；You will be additionally charged for the tasks with high execution priority.The cost can be calculated on the Pricing page.
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typepossible value: desktop
- `[].pingback_url` — string，可选。notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&amp;tag=$tagNote: special characters in pingback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_url` — string，可选。URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the requestexample:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&amp;tag=$tagNote: special characters in postback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatyperequired field if you specify postback_urlcorresponds to the datatype that will be sent to your serveronly value: advanced
- `[].language_name` — string，可选。full name of search engine languageoptional fieldif you use this field, you don't need to specify language_codepossible value:English
- `[].os` — string，可选。device operating systemoptional fieldpossible values: windows, macosdefault value: windows
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].last_updated` — string，可选。last time the dataset was updatedoptional fieldpossible values: 1m, 1y, 3y
- `[].file_formats` — array<string>，可选。file formats of the datasetoptional fieldpossible values: other, archive, text, image, document, tabular
- `[].usage_rights` — string，可选。usage rights of the datasetoptional fieldpossible values: commercial, noncommercial
- `[].is_free` — boolean，可选。indicates whether displayed datasets are freeoptional fieldpossible values: true, false
- `[].topics` — array<string>，可选。dataset topicsoptional fieldpossible values: humanities, social_sciences, life_sciences, agriculture, natural_sciences, geo, computer, architecture_and_urban_planning, engineering

最小请求示例:

```json
[
  {
    "keyword": "water quality",
    "last_updated": "1m",
    "file_formats": [
      "archive",
      "image"
    ],
    "usage_rights": "noncommercial",
    "is_free": "true",
    "topics": [
      "natural_sciences",
      "geo"
    ]
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/dataset_search/tasks_fixed

ID: `GoogleDatasetSearchTasksFixed`
用途: ‌ The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/dataset_search/tasks_ready

ID: `GoogleDatasetSearchTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/events/live/advanced

ID: `GoogleEventsLiveAdvanced`
用途: ‌‌ Live Google Events SERP provides real-time data from Google Events Search for the specified keyword and location. Note that Google Events SERP API works for the English language only.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character '+' will be decoded to a space character)if you need to use the "%" character for your keyword, please specify it as "%25";if you need to use the “+” character for your keyword, please specify it as “%2B”；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name&nbsp;or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/google/events/locationsexample:2840
- `[].language_code` — string，可选。search engine language codeoptional fieldif you use this field, you don't need to specify language_nameby default, language settings correspond to one of the local official languages of the specified locationyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:en
- `[].depth` — integer，可选。parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 200；Your account will be billed per each SERP containing up to 10 results;Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;The cost can be calculated on the Pricing page.
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/events/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languageoptional fieldif you use this field, you don't need to specify language_codeby default, language settings correspond to one of the local official languages of the specified locationyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldnote that this API provides results for desktop onlychoose from the following values: windows, macosdefault value: windows
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].max_crawl_pages` — integer，可选。page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: the max_crawl_pages and depth parameters complement each other;learn more at our help center
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude,radius" formatdata will be provided for the country the specified coordinates belong tothe maximum number of decimal digits for "latitude" and "longitude": 7the minimum value for "radius": 199.9 (mm)the maximum value for "radius": 199999 (mm)example:53.476225,-2.243572,200
- `[].date_range` — string，可选。date range to get events foroptional fieldif you do not use this field, we will return all eventspossible values: today, tomorrow, week, weekend, next_week, month, next_month
- `[].se_domain` — string，可选。search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de, etc.

最小请求示例:

```json
[
  {
    "keyword": "concerts",
    "location_name": "Los Angeles,California,United States",
    "date_range": "today"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/events/task_get/advanced/{id}

ID: `GoogleEventsTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/events/task_post

ID: `GoogleEventsTaskPost`
用途: ‌‌ Google Events SERP provides data from Google Events Search for the specified keyword and location (see the List of Locations). Note that Google Events SERP API works for the English language only.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character '+' will be decoded to a space character)if you need to use the "%" character for your keyword, please specify it as "%25";if you need to use the “+” character for your keyword, please specify it as “%2B”；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name&nbsp;or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/google/events/locationsexample:2840
- `[].language_code` — string，可选。search engine language codeoptional fieldif you use this field, you don't need to specify language_nameby default, language settings correspond to one of the local official languages of the specified locationyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:en
- `[].depth` — integer，可选。parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 700；Your account will be billed per each SERP containing up to 10 results;Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;The cost can be calculated on the Pricing page.
- `[].priority` — integer，可选。task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default);2 – high execution priority；You will be additionally charged for the tasks with high execution priority;The cost can be calculated on the Pricing page
- `[].pingback_url` — string，可选。notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&amp;tag=$tagNote: special characters in pingback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_url` — string，可选。URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&amp;tag=$tagNote: special characters in postback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatyperequired field if you specify postback_urlcorresponds to the datatype that will be sent to your serverpossible values:advanced
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/events/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languageoptional fieldif you use this field, you don't need to specify language_codeby default, language settings correspond to one of the local official languages of the specified locationyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldnote that this API provides results for desktop onlychoose from the following values: windows, macosdefault value: windows
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].max_crawl_pages` — integer，可选。page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: the max_crawl_pages and depth parameters complement each other;learn more at our help center
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude,radius" formatdata will be provided for the country the specified coordinates belong tothe maximum number of decimal digits for "latitude" and "longitude": 7the minimum value for "radius": 199.9 (mm)the maximum value for "radius": 199999 (mm)example:53.476225,-2.243572,200
- `[].date_range` — string，可选。date range to get events foroptional fieldif you do not use this field, we will return all eventspossible values: today, tomorrow, week, weekend, next_week, month, next_month
- `[].se_domain` — string，可选。search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de, etc.

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/events/tasks_fixed

ID: `GoogleEventsTasksFixed`
用途: ‌ The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/events/tasks_ready

ID: `GoogleEventsTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/finance_explore/live/advanced

ID: `GoogleFinanceExploreLiveAdvanced`
用途: ‌ Live Google Finance Explore provides real-time data from the ‘Explore’ tab of Google Finance. These results are specific to the parameters you specify in the request: location and language.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_nameif you use this field, you don't need to specify location_nameyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/serp/google/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:en
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typepossible value: desktop
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_codeif you use this field, you don't need to specify location_codeyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/serp/google/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldpossible values: windows
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].news_type` — string，可选。financial news filtersoptional fieldpossible values: top_stories, local_market, world_marketsdefault value: top_storiesNote: if you specify local_market or world_markets, the charge per task will be multiplied by 2

最小请求示例:

```json
[
  {
    "location_code": "2840",
    "language_name": "English"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/finance_explore/live/html

ID: `GoogleFinanceExploreLiveHtml`
用途: ‌ Live SERP HTML provides raw HTML page from the ‘Explore’ tab of Google Finance. These results are specific to the parameters you specify in the request: location and language.
中文补充: 本接口用于实时获取 Google Finance「Explore（探索）」页的原始 HTML。返回结果取决于请求中指定的地区和语言参数。

请求体: `application/json`

请求字段:
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_nameif you use this field, you don't need to specify location_nameyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/serp/google/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:en
- `[].device` — string，可选。device typeoptional fieldpossible value: desktop
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_codeif you use this field, you don't need to specify location_codeyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/serp/google/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_code if you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldpossible values: windows
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].news_type` — string，可选。financial news filtersoptional fieldpossible values: top_stories, local_market, world_marketsdefault value: top_stories

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/finance_explore/task_get/advanced/{id}

ID: `GoogleFinanceExploreTaskGetAdvanced`
用途: ‌ Live Google Finance Explore provides real-time data from the ‘Explore’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language.

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/finance_explore/task_get/html/{id}

ID: `GoogleFinanceExploreTaskGetHtml`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 7 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/finance_explore/task_post

ID: `GoogleFinanceExploreTaskPost`
用途: ‌ Google Finance Explore API provides real-time data from the ‘Explore’ tab of Google Finance. These results are specific to the parameters you specify in the request: location and language.
中文补充: 本接口使用 **POST** 方法设置 Google Finance Explore SERP 任务：

请求体: `application/json`

请求字段:
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_nameif you use this field, you don't need to specify location_nameyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/serp/google/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:en
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typepossible value: desktop
- `[].pingback_url` — string，可选。notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&amp;tag=$tagNote: special characters in pingback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_url` — string，可选。URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the requestexample:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&amp;tag=$tagNote: special characters in postback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatyperequired field if you specify postback_urlcorresponds to the datatype that will be sent to your serverpossible values:: advanced, html
- `[].priority` — integer，可选。task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default);2 – high execution priority；You will be additionally charged for the tasks with high execution priority;The cost can be calculated on the Pricing page
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_codeif you use this field, you don't need to specify location_codeyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/serp/google/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_code if you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldpossible values: windows
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].news_type` — string，可选。financial news filtersoptional fieldpossible values: top_stories, local_market, world_marketsdefault value: top_storiesNote: if you specify local_market or world_markets, the charge per task will be multiplied by 2

最小请求示例:

```json
[
  {
    "location_code": "2840",
    "language_name": "English"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/finance_explore/tasks_ready

ID: `GoogleFinanceExploreTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/finance_markets/live/advanced

ID: `GoogleFinanceMarketsLiveAdvanced`
用途: ‌ Live Google Finance Markets provides real-time data from the ‘Markets’ tab of Google Finance. These results are specific to the parameters you specify in the request: location, language, and market_type.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_nameif you use this field, you don't need to specify location_nameyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/serp/google/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:en
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typepossible value: desktop
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_codeif you use this field, you don't need to specify location_codeyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/serp/google/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_code if you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldpossible values: windows
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].market_type` — string，可选。type of google finance marketoptional fieldpossible values: most-active, indexes, indexes/americas, indexes/europe-middle-east-africa, indexes/asia-pacific, gainers, losers, climate-leaders, cryptocurrencies, currenciesdefault value: most-active

最小请求示例:

```json
[
  {
    "location_code": "2840",
    "language_name": "English"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/finance_markets/live/html

ID: `GoogleFinanceMarketsLiveHtml`
用途: ‌ Live SERP HTML provides raw HTML from the ‘Markets’ tab of Google Finance. These results are specific to the parameters you specify in the request: location and language.
中文补充: 本接口通过实时请求获取 Google Finance「Markets」标签页的原始 HTML。返回取决于请求中指定的搜索位置、语言、设备及市场类型等参数。

请求体: `application/json`

请求字段:
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_nameif you use this field, you don't need to specify location_nameyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/serp/google/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:en
- `[].device` — string，可选。device typeoptional fieldpossible value: desktop
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_codeif you use this field, you don't need to specify location_codeyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/serp/google/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_code if you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldpossible values: windows
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].market_type` — string，可选。type of google finance marketoptional fieldpossible values: most-active, indexes, indexes/americas, indexes/europe-middle-east-africa, indexes/asia-pacific, gainers, losers, climate-leaders, cryptocurrencies, currenciesdefault value: most-active

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/finance_markets/task_get/advanced/{id}

ID: `GoogleFinanceMarketsTaskGetAdvanced`
用途: ‌ Google Finance Markets API provides real-time data from the ‘Markets’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language.

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/finance_markets/task_get/html/{id}

ID: `GoogleFinanceMarketsTaskGetHtml`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 7 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/finance_markets/task_post

ID: `GoogleFinanceMarketsTaskPost`
用途: ‌ Google Finance Markets API provides real-time data from the ‘Markets’ tab of Google Finance. These results are specific to the parameters you specify in the request: location, language, and market_type.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_nameif you use this field, you don't need to specify location_nameyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/serp/google/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:en
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typepossible value: desktop
- `[].pingback_url` — string，可选。notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&amp;tag=$tagNote: special characters in pingback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_url` — string，可选。URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the requestexample:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&amp;tag=$tagNote: special characters in postback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatyperequired field if you specify postback_urlcorresponds to the datatype that will be sent to your serverpossible values:: advanced, html
- `[].priority` — integer，可选。task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default);2 – high execution priority；You will be additionally charged for the tasks with high execution priority;The cost can be calculated on the Pricing page
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_codeif you use this field, you don't need to specify location_codeyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/serp/google/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_code if you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldpossible values: windows
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].market_type` — string，可选。type of google finance marketoptional fieldpossible values: most-active, indexes, indexes/americas, indexes/europe-middle-east-africa, indexes/asia-pacific, gainers, losers, climate-leaders, cryptocurrencies, currenciesdefault value: most-active

最小请求示例:

```json
[
  {
    "location_code": "2840",
    "language_name": "English"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/finance_markets/tasks_ready

ID: `GoogleFinanceMarketsTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/finance_quote/live/advanced

ID: `GoogleFinanceQuoteLiveAdvanced`
用途: ‌ Live Google Finance Quote provides real-time data from the ‘Quote’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language.
中文补充: 本接口使用 **POST `/v3/serp/google/finance_quote/live/advanced`**，实时获取 Google Finance「报价」页中的数据。返回结果由请求中的股票或金融产品代码、地区和语言决定。

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。ticker or stock symbolrequired fieldin this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange;you can specify up to 700 characters in the keyword field;all %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”;if you need to use the “+” character for your keyword, please specify it as “%2B”;；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_nameif you use this field, you don't need to specify location_nameyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/serp/google/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:en
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typepossible value: desktop
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_codeif you use this field, you don't need to specify location_codeyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/serp/google/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_code if you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldpossible values: windows
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].window` — string，可选。time window for google_finance_quote graphoptional fieldpossible values: 1D, 5D, 1M, 6M, YTD, 1Y, 5Y, MAXdefault value: 1DNote: if you specify a value that is different from 1D, the charge per task will be multiplied by 2

最小请求示例:

```json
[
  {
    "keyword": "CLW00:NYMEX",
    "location_code": "2840",
    "language_name": "English"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/finance_quote/live/html

ID: `GoogleFinanceQuoteLiveHtml`
用途: ‌ Live SERP HTML provides raw HTML from the ‘Quote’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language.
中文补充: 本接口通过实时请求获取 Google Finance「Quote」标签页的原始 HTML。查询结果由请求参数决定股票代码（`keyword`）、地区和语言。

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。ticker or stock symbolrequired fieldin this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange;you can specify up to 700 characters in the keyword field;all %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”;if you need to use the “+” character for your keyword, please specify it as “%2B”;；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_nameif you use this field, you don't need to specify location_nameyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/serp/google/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:en
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typepossible value: desktop
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_codeif you use this field, you don't need to specify location_codeyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/serp/google/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_code if you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldpossible values: windows
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].window` — string，可选。time window for google_finance_quote graphoptional fieldpossible values: 1D, 5D, 1M, 6M, YTD, 1Y, 5Y, MAXdefault value: 1D

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "NASDAQ-100"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/finance_quote/task_get/advanced/{id}

ID: `GoogleFinanceQuoteTaskGetAdvanced`
用途: ‌ Live Google Finance Quote provides real-time data from the ‘Quote’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language.

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/finance_quote/task_get/html/{id}

ID: `GoogleFinanceQuoteTaskGetHtml`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 7 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/finance_quote/task_post

ID: `GoogleFinanceQuoteTaskPost`
用途: ‌ Google Finance Quote provides real-time data from the ‘Quote’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language.
中文补充: 本接口通过 **POST `/v3/serp/google/finance_quote/task_post`** 创建 Google Finance Quote 行查询任务，返回 Google Finance「Quote」标签页中的实时数据。查询结果由请求中的股票代码（`keyword`）、地区和语言决定。

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。ticker or stock symbolrequired fieldin this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange;you can specify up to 700 characters in the keyword field;all %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”;if you need to use the “+” character for your keyword, please specify it as “%2B”;；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_nameif you use this field, you don't need to specify location_nameyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/serp/google/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:en
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typepossible value: desktop
- `[].pingback_url` — string，可选。notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&amp;tag=$tagNote: special characters in pingback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_url` — string，可选。URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the requestexample:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&amp;tag=$tagNote: special characters in postback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatyperequired field if you specify postback_urlcorresponds to the datatype that will be sent to your serverpossible values:: advanced, html
- `[].priority` — integer，可选。task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default);2 – high execution priority；You will be additionally charged for the tasks with high execution priority;The cost can be calculated on the Pricing page
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_codeif you use this field, you don't need to specify location_codeyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/serp/google/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_code if you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldpossible values: windows
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].window` — string，可选。time window for google_finance_quote graphoptional fieldpossible values: 1D, 5D, 1M, 6M, YTD, 1Y, 5Y, MAXdefault value: 1DNote: if you specify a value that is different from 1D, the charge per task will be multiplied by 2

最小请求示例:

```json
[
  {
    "keyword": ".DJI:INDEXDJX",
    "location_code": "2840",
    "language_name": "English"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/finance_quote/tasks_ready

ID: `GoogleFinanceQuoteTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.
中文补充: 本接口使用 **GET** 方法，通过任务 ID 获取 Google Finance 行高级结果：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/finance_ticker_search/live/advanced

ID: `GoogleFinanceTickerSearchLiveAdvanced`
用途: ‌ Live Google Finance Ticker Search allows you to search for financial instruments available on Google Finance along with additional information. The result is specific to the parameters you specify in the request: keyword (name of a company or financial instrument) in the keyword field, location and language.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。company or financial instrument namerequired fieldin this field, you can enter the name of a company or financial instrument to search for relevant tickers;you can specify up to 700 characters in the keyword field;all %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”;if you need to use the “+” character for your keyword, please specify it as “%2B”;；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_nameif you use this field, you don't need to specify location_nameyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/serp/google/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:en
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_codeif you use this field, you don't need to specify location_codeyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/serp/google/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_code if you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:English
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].category` — string，可选。category of financial instruments to search foroptional fieldpossible values: all, stock, index, mutual_fund, currency, futuresdefault value: all

最小请求示例:

```json
[
  {
    "language_name": "English",
    "location_code": "2840",
    "category": "all",
    "keyword": "DJ"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/finance_ticker_search/task_get/advanced/{id}

ID: `GoogleFinanceTickerSearchTaskGetAdvanced`
用途: ‌ Google Finance Ticker Search allows you to search for financial instruments available on Google Finance along with additional information. The result is specific to the parameters you specify in the request: keyword (name of a company or financial instrument) in the keyword field, location and language.

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/finance_ticker_search/task_post

ID: `GoogleFinanceTickerSearchTaskPost`
用途: ‌ Google Finance Ticker Search allows you to search for financial instruments available on Google Finance along with additional information. The result is specific to the parameters you specify in the request: keyword (name of a company or financial instrument) in the keyword field, location and language.
中文补充: 本接口使用 **POST** 方法，通过以下路径创建 Google Finance Ticker Search 任务：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。company or financial instrument namerequired fieldin this field, you can enter the name of a company or financial instrument to search for relevant tickers;you can specify up to 700 characters in the keyword field;all %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”;if you need to use the “+” character for your keyword, please specify it as “%2B”;；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_nameif you use this field, you don't need to specify location_nameyou can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/serp/google/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:en
- `[].pingback_url` — string，可选。notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&amp;tag=$tagNote: special characters in pingback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_url` — string，可选。URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the requestexample:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&amp;tag=$tagNote: special characters in postback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatyperequired field if you specify postback_urlcorresponds to the datatype that will be sent to your serverpossible values:: advanced, html
- `[].priority` — integer，可选。task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default);2 – high execution priority；You will be additionally charged for the tasks with high execution priority;The cost can be calculated on the Pricing page
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_codeif you use this field, you don't need to specify location_codeyou can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/serp/google/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_code if you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:English
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].category` — string，可选。category of financial instruments to search foroptional fieldpossible values: all, stock, index, mutual_fund, currency, futuresdefault value: all

最小请求示例:

```json
[
  {
    "language_name": "English",
    "location_code": "2840",
    "category": "all",
    "keyword": "DJ",
    "priority": "2"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/finance_ticker_search/tasks_ready

ID: `GoogleFinanceTickerSearchTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.
中文补充: 本接口使用 **GET** 方法，通过以下路径获取指定任务的 Google Finance Ticker Search 高级结果：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/images/live/advanced

ID: `GoogleImagesLiveAdvanced`
用途: ‌ Live Google Images SERP provides real-time data on top 100 images results for the specified keyword, search engine, and location.

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character '+' will be decoded to a space character)if you need to use the "%" character for your keyword, please specify it as "%25";if you need to use the “+” character for your keyword, please specify it as “%2B”;if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name&nbsp;or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/google/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:en
- `[].depth` — integer，可选。parsing depthoptional fieldnumber of results in SERPdefault value: 100max value: 200；Your account will be billed per each SERP containing up to 100 results;Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;The cost can be calculated on the Pricing page.
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldnote that this API provides results for desktop onlychoose from the following values: windows, macosdefault value: windows
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].max_crawl_pages` — integer，可选。page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: the max_crawl_pages and depth parameters complement each other;learn more at our help center
- `[].search_param` — string，可选。additional parameters of the search queryoptional fieldGet the list of available parameters and additional details here.
- `[].url` — string，可选。direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://www.google.co.uk/search?q=%20rank%20tracker%20api&amp;hl=en&amp;gl=GB&amp;uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude,radius" formatthe maximum number of decimal digits for "latitude" and "longitude": 7the minimum value for "radius": 199.9 (mm)the maximum value for "radius": 199999 (mm)example:53.476225,-2.243572,200
- `[].se_domain` — string，可选。search engine domainoptional fieldWe choose the relevant search engine domain automatically according to the location and language you specify. However, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de, etc.

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/images/live/html

ID: `GoogleImagesLiveHtml`
用途: ‌ Live SERP HTML provides a raw HTML page of 100 search engine results for the specified keyword, search engine, and location.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character '+' will be decoded to a space character)if you need to use the "%" character for your keyword, please specify it as "%25";if you need to use the “+” character for your keyword, please specify it as “%2B”;if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name&nbsp;or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/google/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:en
- `[].depth` — integer，可选。parsing depthoptional fieldnumber of results in SERPdefault value: 100max value: 200；Your account will be billed per each SERP containing up to 100 results;Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;The cost can be calculated on the Pricing page.
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldnote that this API provides results for desktop onlychoose from the following values: windows, macosdefault value: windows
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].max_crawl_pages` — integer，可选。page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: the max_crawl_pages and depth parameters complement each other;learn more at our help center
- `[].search_param` — string，可选。additional parameters of the search queryoptional fieldget the list of available parameters and additional details here
- `[].url` — string，可选。direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://www.google.co.uk/search?q=%20rank%20tracker%20api&amp;hl=en&amp;gl=GB&amp;uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude,radius" formatthe maximum number of decimal digits for "latitude" and "longitude": 7the minimum value for "radius": 199.9 (mm)the maximum value for "radius": 199999 (mm)example:53.476225,-2.243572,200
- `[].se_domain` — string，可选。search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de, etc.

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/images/task_get/advanced/{id}

ID: `GoogleImagesTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/images/task_get/html/{id}

ID: `GoogleImagesTaskGetHtml`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 7 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/images/task_post

ID: `GoogleImagesTaskPost`
用途: ‌‌ SERP API provides top 100 search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
中文补充: **POST `/v3/serp/google/images/task_post`**

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”;if you need to use the “+” character for your keyword, please specify it as “%2B”;if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, the charge per task will be multiplied by 5Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name&nbsp;or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:en
- `[].depth` — integer，可选。parsing depthoptional fieldnumber of results in SERPdefault value: 100max value: 700；Your account will be billed per each SERP containing up to 100 results;Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;The cost can be calculated on the Pricing page.
- `[].priority` — integer，可选。task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default)2 – high execution priority；You will be additionally charged for the tasks with high execution priority.The cost can be calculated on the Pricing page.
- `[].pingback_url` — string，可选。notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&amp;tag=$tagNote: special characters in pingback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_url` — string，可选。URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&amp;tag=$tagNote: special characters in postback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatyperequired field if you specify postback_urlcorresponds to the datatype that will be sent to your serverpossible values:advanced, html
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldnote that this API provides results for desktop onlychoose from the following values: windows, macosdefault value: windows
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].max_crawl_pages` — integer，可选。page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: the max_crawl_pages and depth parameters complement each other;learn more at our help center
- `[].search_param` — string，可选。additional parameters of the search queryoptional fieldget the list of available parameters and additional details here
- `[].url` — string，可选。direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://www.google.co.uk/search?q=%20rank%20tracker%20api&amp;hl=en&amp;gl=GB&amp;uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude,radius" formatthe maximum number of decimal digits for "latitude" and "longitude": 7the minimum value for "radius": 199.9 (mm)the maximum value for "radius": 199999 (mm)example:53.476225,-2.243572,200
- `[].se_domain` — string，可选。search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de, etc.

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/images/tasks_fixed

ID: `GoogleImagesTasksFixed`
用途: ‌ The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/images/tasks_ready

ID: `GoogleImagesTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/jobs/task_get/advanced/{id}

ID: `GoogleJobsTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/jobs/task_get/html/{id}

ID: `GoogleJobsTaskGetHtml`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 7 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/jobs/task_post

ID: `GoogleJobsTaskPost`
用途: ‌‌ This endpoint will provide you with SERP data from the Google Jobs search engine. The returned results are specific to the keyword as well as the language and location parameters of the POST request.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”;if you need to use the “+” character for your keyword, please specify it as “%2B”;Note: the keyword you specify must indicate the job title;example: .net developer；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name;you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.seermartech.cn/v3/serp/google/jobs/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_name;you can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:en
- `[].depth` — integer，可选。parsing depthoptional fieldnumber of results in SERP;default value: 10max value: 200；Your account will be billed per each SERP containing up to 10 results;Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;The cost can be calculated on the Pricing page.
- `[].priority` — integer，可选。task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default);2 – high execution priority；You will be additionally charged for the tasks with high execution priority;The cost can be calculated on the Pricing page
- `[].pingback_url` — string，可选。notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&amp;tag=$tagNote: special characters in pingback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_url` — string，可选。URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the requestexample:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&amp;tag=$tagNote: special characters in postback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatyperequired field if you specify postback_urlcorresponds to the datatype that will be sent to your serverpossible values:regular, advanced, html
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_codeif you use this field, you don't need to specify location_code;you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.seermartech.cn/v3/serp/google/jobs/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_code;you can receive the list of available languages of the search engine with their language_name by making a separate request to https://api.seermartech.cn/v3/serp/google/languagesexample:English
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].location_radius` — string，可选。location search radiusoptional fieldlocation search radius in kilometers;Note: for countries that use the imperial system of units, you will need to convert miles to kilometers by multiplying the value in miles by 1.609;if value is not specified, search is executed anywhere within the specified location;maximal value: 300minimal value: &gt; 0
- `[].employment_type` — array<string>，可选。employment contract typeoptional fieldtype of employment contract for which the search results will be returned;possible values:fulltime, partime, contractor, intern

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": ".net developer"
  },
  {
    "language_name": "English",
    "location_name": "United States",
    "keyword": ".net developer",
    "tag": "some_string_123",
    "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/jobs/tasks_fixed

ID: `GoogleJobsTasksFixed`
用途: ‌ The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/jobs/tasks_ready

ID: `GoogleJobsTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/languages

ID: `GoogleLanguages`
用途: You will receive the list of languages by calling this API.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/local_finder/live/advanced

ID: `GoogleLocalFinderLiveAdvanced`
用途: ‌‌ Live Google Local_finder SERP provides real-time search engine results for the specified keyword and location. By default, you can get up to 20 results for desktop and up to 10 results for mobile.
中文补充: 本接口使用 **POST `/v3/serp/wp/v2/live/advanced`**，实时获取指定、语言和地理位置下的本地搜索结果。默认返回桌面端最多 20 条结果、移动端最多 10 条结果。平台限流以认证说明中的 30/60/120 次/分钟规则为准。

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”;if you need to use the “+” character for your keyword, please specify it as “%2B”；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name&nbsp;or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:en
- `[].depth` — integer，可选。parsing depthoptional fieldnumber of results in SERPdefault value for desktop: 20max value for desktop: 100；default value for mobile: 10max value for mobile: 100；Your account will be billed per each SERP containing up to 20 results for desktop or up to 10 results for a mobile device;Setting depth above 20 for desktop or above 10 for mobile may result in additional charges if the search engine returns more than 20 or 10 results respectively;;If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automaticallyThe cost can be calculated on the Pricing page.
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].priority` — integer，可选。task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default)2 – high execution priority；You will be additionally charged for the tasks with high execution priority.The cost can be calculated on the Pricing page.
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude,zoom" formatif "zoom" is not specified, 9z will be applied as a default valuethe maximum number of decimal digits for "latitude" and "longitude": 7the minimum value for "zoom": 4zthe maximum value for "zoom": 18zexample:52.6178549,-155.352142,20z
- `[].min_rating` — number，可选。filter results by minimum ratingoptional fieldpossible values for desktop: 3.5, 4, 4.5;possible values for mobile: 2, 2.5, 3, 3.5, 4, 4.5
- `[].time_filter` — string，可选。filter results by open hoursoptional fieldusing this field, you can filter places in the results by the time a place is open for visitorsnote that Google may also provide results that do not match this filterpossible values: "open_now", "24_hours", "$day_value", "$day_value;$time_value";instead of $day_value use one of these values: "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday";instead of $time_value use one of these values: "00", "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23"example: "tuesday;18"

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "local nail services",
    "min_rating": "4.5",
    "time_filter": "monday"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/local_finder/live/html

ID: `GoogleLocalFinderLiveHtml`
用途: ‌ Live Google Local Finder SERP HTML provides a raw HTML page of the search engine results for the specified keyword, search engine, and location.
中文补充: `POST /v3/serp/wp/v2/live/html`

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”;if you need to use the “+” character for your keyword, please specify it as “%2B”
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name&nbsp;or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:en
- `[].depth` — integer，可选。parsing depthoptional fieldnumber of results in SERPdefault value for desktop: 20max value for desktop: 100；default value for mobile: 10max value for mobile: 100；Your account will be billed per each SERP containing up to 20 results for desktop or up to 10 results for a mobile device;Setting depth above 20 for desktop or above 10 for mobile may result in additional charges if the search engine returns more than 20 or 10 results respectively;If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automaticallyThe cost can be calculated on the Pricing page.
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude,zoom" formatif "zoom" is not specified, 9z will be applied as a default valuethe maximum number of decimal digits for "latitude" and "longitude": 7the minimum value for "zoom": 4zthe maximum value for "zoom": 18zexample:52.6178549,-155.352142,20z
- `[].min_rating` — string，可选。filter results by minimum ratingoptional fieldpossible values for desktop: 3.5, 4, 4.5;possible values for mobile: 2, 2.5, 3, 3.5, 4, 4.5
- `[].time_filter` — string，可选。filter results by open hoursoptional fieldusing this field, you can filter places in the results by the time a place is open for visitorsnote that Google may also provide results that do not match this filterpossible values: "open_now", "24_hours", "$day_value", "$day_value;$time_value";instead of $day_value use one of these values: "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday";instead of $time_value use one of these values: "00", "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23"example: "tuesday;18"

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/local_finder/task_get/advanced/{id}

ID: `GoogleLocalFinderTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；a universally unique identifier (UUID)；unique task identifier in our system；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/local_finder/task_get/html/{id}

ID: `GoogleLocalFinderTaskGetHtml`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 7 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/local_finder/task_post

ID: `GoogleLocalFinderTaskPost`
用途: ‌‌ Google Local Finder SERP API provides top search engine results specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”;if you need to use the “+” character for your keyword, please specify it as “%2B”；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name&nbsp;or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:en
- `[].depth` — integer，可选。parsing depthoptional fieldnumber of results in SERPdefault value for desktop: 20max value for desktop: 500default value for mobile: 10max value for mobile: 350；Your account will be billed per each SERP containing up to 20 results for desktop or up to 10 results for a mobile device;Setting depth above 20 for desktop or above 10 for mobile may result in additional charges if the search engine returns more than 20 or 10 results respectively;If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automaticallyThe cost can be calculated on the Pricing page.
- `[].priority` — integer，可选。task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default)2 – high execution priority；You will be additionally charged for the tasks with high execution priority.The cost can be calculated on the Pricing page.
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop
- `[].pingback_url` — string，可选。notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&amp;tag=$tagNote: special characters in pingback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_url` — string，可选。URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&amp;tag=$tagNote: special characters in postback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatyperequired field if you specify postback_urlcorresponds to the function you used for setting a taskpossible values:advanced, html
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude,zoom" formatif "zoom" is not specified, 9z will be applied as a default valuethe maximum number of decimal digits for "latitude" and "longitude": 7the minimum value for "zoom": 4zthe maximum value for "zoom": 18zexample:52.6178549,-155.352142,18z
- `[].min_rating` — number，可选。filter results by minimum ratingoptional fieldpossible values for desktop: 3.5, 4, 4.5;possible values for mobile: 2, 2.5, 3, 3.5, 4, 4.5
- `[].time_filter` — string，可选。filter results by open hoursoptional fieldusing this field, you can filter places in the results by the time a place is open for visitorsnote that Google may also provide results that do not match this filterpossible values: "open_now", "24_hours", "$day_value", "$day_value;$time_value";instead of $day_value use one of these values: "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday";instead of $time_value use one of these values: "00", "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23"example: "tuesday;18"

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "local nail services",
    "min_rating": "4.5",
    "time_filter": "monday"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/local_finder/tasks_fixed

ID: `GoogleLocalFinderTasksFixed`
用途: ‌ The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/local_finder/tasks_ready

ID: `GoogleLocalFinderTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/locations

ID: `GoogleLocations`
用途: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/locations/{country}

ID: `GoogleLocationsCountry`
用途: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.

路径与查询参数:
- `country` — path，string，必填。country ISO code；optional field；specify the ISO code if you want to filter the list of locations by country；example:；us

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/maps/live/advanced

ID: `GoogleMapsLiveAdvanced`
用途: ‌‌ Live Google Maps SERP provides real-time data on top 100 search engine results for the specified keyword, search engine, and location.

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character '+' will be decoded to a space character)if you need to use the "%" character for your keyword, please specify it as "%25";if you need to use the “+” character for your keyword, please specify it as “%2B”;learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name&nbsp;or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/google/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:en
- `[].depth` — integer，可选。parsing depthoptional fieldnumber of results in SERPdefault value: 100max value: 700；Your account will be billed per each SERP containing up to 100 results;Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;The cost can be calculated on the Pricing page.
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktopnote: for mobile device, only 20 results are returned for every SERP
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].max_crawl_pages` — integer，可选。page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: the max_crawl_pages and depth parameters complement each other;learn more at our help center
- `[].url` — string，可选。direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://google.com/maps/search/pizza/@37.09024,-95.712891,4z；Note: the following search engine parameters are not supported and will be automatically unset if specified in the URL: allinanchor:, allintext:, allintitle:, allinurl:, cache:, define:, definition:, filetype:, id:, inanchor:, info:, intext:, intitle:, inurl:, link:, site:.
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude,zoom" formatif "zoom" is not specified, 17z will be applied as a default valuethe maximum number of decimal digits for "latitude" and "longitude": 7the minimum value for "zoom": 3zthe maximum value for "zoom": 21zexample:52.6178549,-155.352142,20z
- `[].se_domain` — string，可选。search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de, etc.
- `[].search_this_area` — boolean，可选。show results from the displayed areaoptional fieldcan take the values:true, falsedefault value: true；if set to false, the search_this_area mode will be turned off；Note: if the search_this_area mode is turned off, Google Maps listings might contain results beyond the displayed area
- `[].search_places` — boolean，可选。search places modeoptional fieldthe search places mode allows to obtain Google Maps results on a certain place (e.g., Apple Store in New York)however, due to the pecularities of our data mining algorithm, this mode might interfere with some local-intent queries - and display results for a location that is different from that specified in the request;to prevent this interference and obtain correct results for keywords with local intent you may set this parameter to false;；default value: trueNote: if the search_places mode is turned off and no results were found in the search area, the results array will be empty

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/maps/task_get/advanced/{id}

ID: `GoogleMapsTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；a universally unique identifier (UUID)；unique task identifier in our system；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/maps/task_post

ID: `GoogleMapsTaskPost`
用途: ‌‌ SERP API provides top 100 search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
中文补充: 使用 `POST /v3/serp/google/maps/task_post` 创建 Google Maps 搜索结果采集任务。本接口按指定、地区、语言和设备类型获取本地搜索结果，单个任务最多可解析 700 条结果。任务创建成功后，可通过任务 `id` 查询结果，也可以通过 `pingback_url` 或 `postback_url` 接收完成通知或结果回调。

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”;if you need to use the “+” character for your keyword, please specify it as “%2B”;learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name&nbsp;or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:en
- `[].depth` — integer，可选。parsing depthoptional fieldnumber of results in SERPdefault value: 100max value: 700；Your account will be billed per each SERP containing up to 100 results;Setting depth above 100 may result in additional charges if the search engine returns more than 100 results;The cost can be calculated on the Pricing page.
- `[].priority` — integer，可选。task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default)2 – high execution priority；You will be additionally charged for the tasks with high execution priority.The cost can be calculated on the Pricing page.
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktopnote: for mobile device, only 20 results are returned for every SERP
- `[].pingback_url` — string，可选。notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&amp;tag=$tagNote: special characters in pingback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_url` — string，可选。URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&amp;tag=$tagNote: special characters in postback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatyperequired field if you specify postback_urlcorresponds to the function you used for setting a taskpossible values:advanced
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android
- `[].max_crawl_pages` — integer，可选。page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: the max_crawl_pages and depth parameters complement each other;learn more at our help center
- `[].url` — string，可选。direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://google.com/maps/search/pizza/@37.09024,-95.712891,4z；Note: the following search engine parameters are not supported and will be automatically unset if specified in the URL: allinanchor:, allintext:, allintitle:, allinurl:, cache:, define:, definition:, filetype:, id:, inanchor:, info:, intext:, intitle:, inurl:, link:, site:.
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude,zoom" formatif "zoom" is not specified, 17z will be applied as a default valuethe maximum number of decimal digits for "latitude" and "longitude": 7the minimum value for "zoom": 3zthe maximum value for "zoom": 21zexample:52.6178549,-155.352142,20z
- `[].se_domain` — string，可选。search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk
- `[].search_this_area` — boolean，可选。show results from the displayed areaoptional fieldcan take the values:true, falsedefault value: trueif set to false, the search_this_area mode will be turned offNote: if the search_this_area mode is turned off, Google Maps listings might contain results beyond the displayed area
- `[].search_places` — boolean，可选。search places modeoptional fieldthe search places mode allows to obtain Google Maps results on a certain place (e.g., Apple Store in New York)however, due to the pecularities of our data mining algorithm, this mode might interfere with some local-intent queries - and display results for a location that is different from that specified in the request;to prevent this interference and obtain correct results for keywords with local intent you may set this parameter to false;default value: trueNote: if the search_places mode is turned off and no results were found in the search area, the results array will be empty
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/maps/tasks_fixed

ID: `GoogleMapsTasksFixed`
用途: ‌ The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/maps/tasks_ready

ID: `GoogleMapsTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/news/live/advanced

ID: `GoogleNewsLiveAdvanced`
用途: ‌‌ Live Google News SERP provides real-time data on top search engine results for the specified keyword, search engine, and location.

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character '+' will be decoded to a space character)if you need to use the "%" character for your keyword, please specify it as "%25";if you need to use the “+” character for your keyword, please specify it as “%2B”;if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name&nbsp;or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:en
- `[].depth` — integer，可选。parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 200；Your account will be billed per each SERP containing up to 10 results;Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automaticallyThe cost can be calculated on the Pricing page.
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldnote that this API provides results for desktop onlychoose from the following values: windows, macosdefault value: windows
- `[].max_crawl_pages` — integer，可选。page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: the max_crawl_pages and depth parameters complement each other;learn more at our help center
- `[].search_param` — string，可选。additional parameters of the search queryoptional fieldGet the list of available parameters and additional details here.
- `[].calculate_rectangles` — boolean，可选。calculate pixel rankings for SERP elements in advanced resultsoptional fieldpixel ranking refers to the distance between the result snippet and top left corner of the screen;Visit Help Center to learn more&gt;&gt;by default, the parameter is set to falseNote: if set to true, the charge per task will be multiplied by 2
- `[].browser_screen_width` — integer，可选。browser screen widthoptional fieldyou can set a custom browser screen width to calculate pixel rankings for a particular device;by default, the parameter is set to 1920;Note: to use this parameter, set calculate_rectangles to true
- `[].browser_screen_height` — integer，可选。browser screen heightoptional fieldyou can set a custom browser screen height to calculate pixel rankings for a particular device;by default, the parameter is set to 1080;Note: to use this parameter, set calculate_rectangles to true
- `[].browser_screen_resolution_ratio` — integer，可选。browser screen resolution ratiooptional fieldyou can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;by default, the parameter is set to 1;Note: to use this parameter, set calculate_rectangles to true
- `[].url` — string，可选。direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://www.google.co.uk/search?q=%20rank%20tracker%20api&amp;hl=en&amp;gl=GB&amp;uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude,radius" formatthe maximum number of decimal digits for "latitude" and "longitude": 7the minimum value for "radius": 199.9 (mm)the maximum value for "radius": 199999 (mm)example:53.476225,-2.243572,200
- `[].se_domain` — string，可选。search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de, etc.

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "android"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/news/live/html

ID: `GoogleNewsLiveHtml`
用途: ‌ Live SERP HTML provides a raw HTML page of 10 search engine results for the specified keyword, search engine, and location.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character '+' will be decoded to a space character)if you need to use the "%" character for your keyword, please specify it as "%25";if you need to use the “+” character for your keyword, please specify it as “%2B”;if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name&nbsp;or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available locations of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:en
- `[].depth` — integer，可选。parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 200；Your account will be billed per each SERP containing up to 10 results;Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automaticallyThe cost can be calculated on the Pricing page.
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available locations of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldnote that this API provides results for desktop onlychoose from the following values: windows, macosdefault value: windows
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].max_crawl_pages` — integer，可选。page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: the max_crawl_pages and depth parameters complement each other;learn more at our help center
- `[].search_param` — string，可选。additional parameters of the search queryoptional fieldget the list of available parameters and additional details here
- `[].url` — string，可选。direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://www.google.co.uk/search?q=%20rank%20tracker%20api&amp;hl=en&amp;gl=GB&amp;uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude,radius" formatthe maximum number of decimal digits for "latitude" and "longitude": 7the minimum value for "radius": 199.9 (mm)the maximum value for "radius": 199999 (mm)example:53.476225,-2.243572,200
- `[].se_domain` — string，可选。search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de, etc.

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/news/task_get/advanced/{id}

ID: `GoogleNewsTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/news/task_get/html/{id}

ID: `GoogleNewsTaskGetHtml`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 7 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/news/task_post

ID: `GoogleNewsTaskPost`
用途: ‌‌ SERP API provides top search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
中文补充: 本接口用于创建 Google News SERP 抓取任务，返回任务 ID。接口契约为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”;if you need to use the “+” character for your keyword, please specify it as “%2B”;if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, the charge per task will be multiplied by 5Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name&nbsp;or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:en
- `[].depth` — integer，可选。parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 700；Your account will be billed per each SERP containing up to 10 results;Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically;The cost can be calculated on the Pricing page.
- `[].priority` — integer，可选。task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default)2 – high execution priority；You will be additionally charged for the tasks with high execution priority.The cost can be calculated on the Pricing page.
- `[].pingback_url` — string，可选。notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&amp;tag=$tagNote: special characters in pingback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_url` — string，可选。URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&amp;tag=$tagNote: special characters in postback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatyperequired field if you specify postback_urlcorresponds to the datatype that will be sent to your serverpossible values:advanced, html
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldnote that this API provides results for desktop onlychoose from the following values: windows, macosdefault value: windows
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].max_crawl_pages` — integer，可选。page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: the max_crawl_pages and depth parameters complement each other;learn more at our help center
- `[].search_param` — string，可选。additional parameters of the search queryoptional fieldget the list of available parameters and additional details here
- `[].calculate_rectangles` — boolean，可选。calculate pixel rankings for SERP elements in advanced resultsoptional fieldpixel ranking refers to the distance between the result snippet and top left corner of the screen;Visit Help Center to learn more&gt;&gt;by default, the parameter is set to falseNote: if set to true, the charge per task will be multiplied by 2
- `[].browser_screen_width` — integer，可选。browser screen widthoptional fieldyou can set a custom browser screen width to calculate pixel rankings for a particular device;by default, the parameter is set to 1920;Note: to use this parameter, set calculate_rectangles to true
- `[].browser_screen_height` — integer，可选。browser screen heightoptional fieldyou can set a custom browser screen height to calculate pixel rankings for a particular device;by default, the parameter is set to 1080;Note: to use this parameter, set calculate_rectangles to true
- `[].browser_screen_resolution_ratio` — integer，可选。browser screen resolution ratiooptional fieldyou can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;by default, the parameter is set to 1;Note: to use this parameter, set calculate_rectangles to true
- `[].url` — string，可选。direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields;Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method;example:https://www.google.co.uk/search?q=%20rank%20tracker%20api&amp;hl=en&amp;gl=GB&amp;uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude,radius" formatthe maximum number of decimal digits for "latitude" and "longitude": 7the minimum value for "radius": 199.9 (mm)the maximum value for "radius": 199999 (mm)example:53.476225,-2.243572,200
- `[].se_domain` — string，可选。search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de, etc.

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/news/tasks_fixed

ID: `GoogleNewsTasksFixed`
用途: ‌ The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/news/tasks_ready

ID: `GoogleNewsTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/organic/live/advanced

ID: `GoogleOrganicLiveAdvanced`
用途: ‌ Live SERP provides real-time data on top search engine results for the specified keyword, search engine, and location. This endpoint will supply a complete overview of featured snippets and other extra elements of SERPs.
中文补充: 本接口用于根据指定的、搜索引擎类型、地点、语言、设备类型和操作系统获取 Google 搜索结果。请求通过容路径 `/v3/...` 提交，接口会根据所选搜索引擎类型和数据获取方式确定。

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”;if you need to use the “+” character for your keyword, please specify it as “%2B”;if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘cache:’, ‘define:’, ‘definition:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, the charge per task will be multiplied by 5；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name&nbsp;or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/google/locationsexample:2840
- `[].language_code` — string，可选。search engine language codeoptional field if you specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:en
- `[].depth` — integer，可选。parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 200；Your account will be billed per each SERP containing up to 10 results;Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;The cost can be calculated on the Pricing page.
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop
- `[].load_async_ai_overview` — boolean，可选。load asynchronous ai overviewoptional fieldset to true to obtain ai_overview items is SERPs even if they are loaded asynchronously;if set to false, you will only obtain ai_overview items from cache;default value: falseNote: you will be charged extra $0.002 for using this parameter;if the element is absent or contains "asynchronous_ai_overview": false, all extra charges will be returned to your account balance
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languageoptional field if you specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].stop_crawl_on_match` — array<object>，可选。array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: "stop_crawl_on_match":[{"match_value":"dataforseo.com","match_type":"with_subdomains"}] learn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api Your account will be billed per each SERP crawled through the specified targets
- `[].match_type` — string，可选。target match typerequired field if stop_crawl_on_match is specifiedtype of match for the match_valuepossible values:domain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard – wildcard pattern
- `[].match_value` — string，可选。target domain, subdomain, or wildcard valuerequired field if stop_crawl_on_match is specifiedspecify a target domain, subdomain, or wildcard value;Note: domain or subdomain must be specified without a request protocol;example: "match_value": "dataforseo.com","match_value": "/blog/post-*"
- `[].max_crawl_pages` — integer，可选。page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: you will be charged for each page crawled (10 organic results per page);learn more about pricing on our Pricing page;Note#2: the max_crawl_pages and depth parameters complement each other;learn more at our help center
- `[].search_param` — string，可选。additional parameters of the search queryoptional fieldget the list of available parameters and additional details here；Note: the following search engine parameters are not supported and will be automatically unset if specified: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.
- `[].remove_from_url` — array<string>，可选。remove specific parameters from URLsoptional fieldusing this field, you can specify up to 10 parameters to remove from URLs in the resultexample:"remove_from_url": ["srsltid"]Note: if the target field is specified, the specified URL parameters will be removed before the search
- `[].people_also_ask_click_depth` — integer，可选。clicks on the corresponding elementoptional fieldspecify the click depth on the people_also_ask element to get additional people_also_ask_element items;Note your account will be billed $0.00015 extra for each click;if the element is absent or we perform fewer clicks than you specified, all extra charges will be returned to your account balancepossible values: from 1 to 4
- `[].group_organic_results` — boolean，可选。display related resultsoptional fieldif set to true, the related_result element in the response will be provided as a snippet of its parent organic result;if set to false, the related_result element will be provided as a separate organic result;default value: true
- `[].calculate_rectangles` — boolean，可选。calcualte pixel rankings for SERP elements in advanced resultsoptional fieldpixel ranking refers to the distance between the result snippet and top left corner of the screen;Visit Help Center to learn more&gt;&gt;by default, the parameter is set to false;Note: you will be charged extra $0.002 for using this parameter
- `[].browser_screen_width` — integer，可选。browser screen widthoptional fieldyou can set a custom browser screen width to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1920 for desktop;360 for mobile on android;375 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true
- `[].browser_screen_height` — integer，可选。browser screen heightoptional fieldyou can set a custom browser screen height to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1080 for desktop;640 for mobile on android;812 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true
- `[].browser_screen_resolution_ratio` — integer，可选。browser screen resolution ratiooptional fieldyou can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;can be specified within the following range: 0.5-3;by default, the parameter is set to:1 for desktop;3 for mobile on android;3 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true
- `[].url` — string，可选。direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://www.google.co.uk/search?q=%20rank%20tracker%20api&amp;hl=en&amp;gl=GB&amp;uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS；Note: the following search engine parameters are not supported and will be automatically unset if specified in the URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.
- `[].location_coordinate` — string，可选。GPS coordinates of a locationoptional field if you specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude,radius" formatthe maximum number of decimal digits for "latitude" and "longitude": 7the minimum value for "radius": 199 (mm)the maximum value for "radius": 199999 (mm)example:53.476225,-2.243572,200
- `[].se_domain` — string，可选。search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de, etc.
- `[].target` — string，可选。target domain, subdomain, or webpage to get results foroptional fielda domain or a subdomain should be specified without https:// and www.note that the results of target-specific tasks will only include SERP elements that contain a url string;you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;examples:example.com - returns results for the website's home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;example.com* - returns results for the domain, including all its pages;*example.com* - returns results for the entire domain, including all its pages and subdomains;*example.com - returns results for the home page regardless of the subdomain, such as https://en.example.com;example.com/example-page - returns results for the exact URL;example.com/example-page* - returns results for all domain's URLs that start with the specified string
- `[].target_search_mode` — string，可选。target matching modeoptional fieldto enable this parameter, stop_crawl_on_match must also be enableddefines how the crawl should stop when multiple targets are specified in stop_crawl_on_matchpossible values: all, anyall – the crawl stops only when all specified targets are foundany – the crawl stops when any single target is founddefault value: anylearn more about this parameter on our Help Center
- `[].find_targets_in` — array<string>，可选。SERP element types to check for targetsoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be checked for target matchesif not specified, all first-level elements with url and domain fields are checked for targetspossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as ignore_targets_inexample:"find_targets_in": ["organic", "featured_snippet"]learn more about this parameter on our Help Center
- `[].ignore_targets_in` — array<string>，可选。SERP element types to exclude from target searchoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be excluded when searching for target matchespossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as find_targets_inexample:"ignore_targets_in": ["paid", "images"]learn more about this parameter on our Help Center

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein",
    "calculate_rectangles": "true"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/organic/live/html

ID: `GoogleOrganicLiveHtml`
用途: ‌ Live SERP HTML provides a raw HTML page of search engine results for the specified keyword, search engine, and location.

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character '+' will be decoded to a space character)if you need to use the "%" character for your keyword, please specify it as "%25";if you need to use the “+” character for your keyword, please specify it as “%2B”;if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'related:', 'site:', the charge per task will be multiplied by 5
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name&nbsp;or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/google/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:en
- `[].depth` — integer，可选。parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 200；Your account will be billed per each SERP containing up to 10 results;Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;The cost can be calculated on the Pricing page.
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop
- `[].load_async_ai_overview` — boolean，可选。load asynchronous ai overviewoptional fieldset to true to obtain ai_overview items is SERPs even if they are loaded asynchronously;if set to false, you will only obtain ai_overview items from cache;default value: falseNote your account will be billed $0.002 extra for each request;if the element is absent or contains "asynchronous_ai_overview": false, all extra charges will be returned to your account balance
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].stop_crawl_on_match` — array<object>，可选。array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: "stop_crawl_on_match":[{"match_value":"dataforseo.com","match_type":"with_subdomains"}] learn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api Your account will be billed per each SERP crawled through the specified targets
- `[].match_type` — string，可选。target match typerequired field if stop_crawl_on_match is specifiedtype of match for the match_valuepossible values:domain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard – wildcard pattern
- `[].match_value` — string，可选。target domain, subdomain, or wildcard valuerequired field if stop_crawl_on_match is specifiedspecify a target domain, subdomain, or wildcard value;Note: domain or subdomain must be specified without a request protocol;example: "match_value": "dataforseo.com","match_value": "/blog/post-*"
- `[].max_crawl_pages` — integer，可选。page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: you will be charged for each page crawled (10 organic results per page);learn more about pricing on our Pricing page;Note#2: the max_crawl_pages and depth parameters complement each other;learn more at our help center
- `[].search_param` — string，可选。additional parameters of the search queryoptional fieldget the list of available parameters and additional details here；Note: the following search engine parameters are not supported and will be automatically unset if specified: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.
- `[].expand_ai_overview` — boolean，可选。expand ai overviewoptional fieldset to true to expand the ai_overview item;default value: false
- `[].url` — string，可选。direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://www.google.co.uk/search?q=%20rank%20tracker%20api&amp;hl=en&amp;gl=GB&amp;uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS；Note: the following search engine parameters are not supported and will be automatically unset if specified in the URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude,radius" formatthe maximum number of decimal digits for "latitude" and "longitude": 7the minimum value for "radius": 199 (mm)the maximum value for "radius": 199999 (mm)example:53.476225,-2.243572,200
- `[].se_domain` — string，可选。search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de, etc.
- `[].target_search_mode` — string，可选。target matching modeoptional fieldto enable this parameter, stop_crawl_on_match must also be enableddefines how the crawl should stop when multiple targets are specified in stop_crawl_on_matchpossible values: all, anyall – the crawl stops only when all specified targets are foundany – the crawl stops when any single target is founddefault value: anylearn more about this parameter on our Help Center
- `[].find_targets_in` — array<string>，可选。SERP element types to check for targetsoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be checked for target matchesif not specified, all first-level elements with url and domain fields are checked for targetspossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as ignore_targets_inexample:"find_targets_in": ["organic", "featured_snippet"]learn more about this parameter on our Help Center
- `[].ignore_targets_in` — array<string>，可选。SERP element types to exclude from target searchoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be excluded when searching for target matchespossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as find_targets_inexample:"ignore_targets_in": ["paid", "images"]learn more about this parameter on our Help Center

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/organic/live/regular

ID: `GoogleOrganicLiveRegular`
用途: Live SERP provides real-time data on search engine results for the specified keyword, search engine, and location.
中文补充: **面向当前 API v2 用户的重要说明：**自 2026 年 5 月 5 日起，API v2 将不再提供支持。为确保现有业务持续运行，请迁移至 API v3。本指南将介绍迁移所需的步骤、主要变化及 v2/v3 接口对应。

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character '+' will be decoded to a space character)if you need to use the "%" character for your keyword, please specify it as "%25";if you need to use the “+” character for your keyword, please specify it as “%2B”;if this field contains such parameters as 'allinanchor:', 'allintext:', 'allintitle:', 'allinurl:', ‘cache:’, 'define:', 'filetype:', 'id:', 'inanchor:', 'info:', 'intext:', 'intitle:', 'inurl:', 'link:', 'site:', the charge per task will be multiplied by 5
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name&nbsp;or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/google/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:en
- `[].depth` — integer，可选。parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 200；Your account will be billed per each SERP containing up to 10 results;Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;The cost can be calculated on the Pricing page.
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:English
- `[].os` — string，可选。device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].stop_crawl_on_match` — array<object>，可选。array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: "stop_crawl_on_match":[{"match_value":"dataforseo.com","match_type":"with_subdomains"}] learn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api Your account will be billed per each SERP crawled through the specified targets
- `[].match_type` — string，可选。target match typerequired field if stop_crawl_on_match is specifiedtype of match for the match_valuepossible values:domain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard – wildcard pattern
- `[].match_value` — string，可选。target domain, subdomain, or wildcard valuerequired field if stop_crawl_on_match is specifiedspecify a target domain, subdomain, or wildcard value;Note: domain or subdomain must be specified without a request protocol;example: "match_value": "dataforseo.com","match_value": "/blog/post-*"
- `[].max_crawl_pages` — integer，可选。page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: you will be charged for each page crawled (10 organic results per page);learn more about pricing on our Pricing page;Note#2: the max_crawl_pages and depth parameters complement each other;learn more at our help center
- `[].search_param` — string，可选。additional parameters of the search queryoptional fieldget the list of available parameters and additional details here；Note: the following search engine parameters are not supported and will be automatically unset if specified: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.
- `[].group_organic_results` — boolean，可选。display related resultsoptional fieldif set to true, the related_result element in the response will be provided as a snippet of its parent organic result;if set to false, the related_result element will be provided as a separate organic result;default value: true
- `[].url` — string，可选。direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://www.google.co.uk/search?q=%20rank%20tracker%20api&amp;hl=en&amp;gl=GB&amp;uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS；Note: the following search engine parameters are not supported and will be automatically unset if specified in the URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude,radius" formatthe maximum number of decimal digits for "latitude" and "longitude": 7the minimum value for "radius": 199 (mm)the maximum value for "radius": 199999 (mm)example:53.476225,-2.243572,200
- `[].se_domain` — string，可选。search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de, etc.
- `[].target` — string，可选。target domain, subdomain, or webpage to get results foroptional fielda domain or a subdomain should be specified without https:// and www.note that the results of target-specific tasks will only include SERP elements that contain a url string;you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;examples:example.com - returns results for the website's home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;example.com* - returns results for the domain, including all its pages;*example.com* - returns results for the entire domain, including all its pages and subdomains;*example.com - returns results for the home page regardless of the subdomain, such as https://en.example.com;example.com/example-page - returns results for the exact URL;example.com/example-page* - returns results for all domain's URLs that start with the specified string
- `[].target_search_mode` — string，可选。target matching modeoptional fieldto enable this parameter, stop_crawl_on_match must also be enableddefines how the crawl should stop when multiple targets are specified in stop_crawl_on_matchpossible values: all, anyall – the crawl stops only when all specified targets are foundany – the crawl stops when any single target is founddefault value: anylearn more about this parameter on our Help Center
- `[].find_targets_in` — array<string>，可选。SERP element types to check for targetsoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be checked for target matchesif not specified, all first-level elements with url and domain fields are checked for targetspossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as ignore_targets_inexample:"find_targets_in": ["organic", "featured_snippet"]learn more about this parameter on our Help Center
- `[].ignore_targets_in` — array<string>，可选。SERP element types to exclude from target searchoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be excluded when searching for target matchespossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as find_targets_inexample:"ignore_targets_in": ["paid", "images"]learn more about this parameter on our Help Center

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/organic/task_get/advanced/{id}

ID: `GoogleOrganicTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/organic/task_get/html/{id}

ID: `GoogleOrganicTaskGetHtml`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 7 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/organic/task_get/regular/{id}

ID: `GoogleOrganicTaskGetRegular`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/organic/task_post

ID: `GoogleOrganicTaskPost`
用途: ‌‌ SERP API provides top 10 search engine results by default. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keywordrequired fieldyou can specify up to 700 characters in the keyword fieldall %## will be decoded (plus character ‘+’ will be decoded to a space character)if you need to use the “%” character for your keyword, please specify it as “%25”;if you need to use the “+” character for your keyword, please specify it as “%2B”;if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘cache:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘site:’, the charge per task will be multiplied by 5；learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name&nbsp;or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/google/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:en
- `[].depth` — integer，可选。parsing depthoptional fieldnumber of results in SERPdefault value: 10max value: 700；Your account will be billed per each SERP containing up to 10 results;Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;The cost can be calculated on the Pricing page.
- `[].device` — string，可选。device typeoptional fieldreturn results for a specific device typecan take the values:desktop, mobiledefault value: desktop
- `[].load_async_ai_overview` — boolean，可选。load asynchronous ai overviewoptional fieldset to true to obtain ai_overview items is SERPs even if they are loaded asynchronously;if set to false, you will only obtain ai_overview items from cache;default value: falseNote: you will be charged extra $0.0006 for using this parameter;if the element is absent or contains "asynchronous_ai_overview": false, all extra charges will be returned to your account balance
- `[].pingback_url` — string，可选。notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&amp;tag=$tagNote: special characters in pingback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_url` — string，可选。URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the requestexample:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&amp;tag=$tagNote: special characters in postback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatyperequired field if you specify postback_urlcorresponds to the datatype that will be sent to your serverpossible values:regular, advanced, html
- `[].priority` — integer，可选。task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default);2 – high execution priority；You will be additionally charged for the tasks with high execution priority.The cost can be calculated on the Pricing page.
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/locationsexample:London,England,United Kingdom
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude,radius" formatthe maximum number of decimal digits for "latitude" and "longitude": 7the minimum value for "radius": 199 (mm)the maximum value for "radius": 199999 (mm)example:53.476225,-2.243572,200
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/google/languagesexample:English
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].os` — string，可选。device operating systemoptional fieldif you specify desktop in the device field, choose from the following values: windows, macosdefault value: windowsif you specify mobile in the device field, choose from the following values: android, iosdefault value: android
- `[].stop_crawl_on_match` — array<object>，可选。array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: "stop_crawl_on_match":[{"match_value":"dataforseo.com","match_type":"with_subdomains"}] learn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api Your account will be billed per each SERP crawled through the specified targets
- `[].match_type` — string，可选。target match typerequired field if stop_crawl_on_match is specifiedtype of match for the match_valuepossible values:domain – specific domain or subdomainwith_subdomains – main domain and subdomainswildcard – wildcard pattern
- `[].match_value` — string，可选。target domain, subdomain, or wildcard valuerequired field if stop_crawl_on_match is specifiedspecify a target domain, subdomain, or wildcard value;Note: domain or subdomain must be specified without a request protocol;example: "match_value": "dataforseo.com","match_value": "/blog/post-*"
- `[].max_crawl_pages` — integer，可选。page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: you will be charged for each page crawled (10 organic results per page);learn more about pricing on our Pricing page;Note#2: the max_crawl_pages and depth parameters complement each other;learn more at our help center
- `[].search_param` — string，可选。additional parameters of the search queryoptional fieldget the list of available parameters and additional details here；Note: the following search engine parameters are not supported and will be automatically unset if specified: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.
- `[].remove_from_url` — array<string>，可选。remove specific parameters from URLsoptional fieldusing this field, you can specify up to 10 parameters to remove from URLs in the resultexample:"remove_from_url": ["srsltid"]
- `[].expand_ai_overview` — boolean，可选。expand ai overviewoptional fieldset to true to expand the ai_overview item;default value: false;Note: this parameter applies only to HTML task results
- `[].people_also_ask_click_depth` — integer，可选。clicks on the corresponding elementoptional fieldspecify the click depth on the people_also_ask element to get additional people_also_ask_element items;Note your account will be billed $0.00015 extra for each click regardless of task priority;if the element is absent or we perform fewer clicks than you specified, all extra charges will be returned to your account balancepossible values: from 1 to 4
- `[].group_organic_results` — boolean，可选。display related resultsoptional fieldif set to true, the related_result element in the response will be provided as a snippet of its parent organic result;if set to false, the related_result element will be provided as a separate organic result;default value: true
- `[].calculate_rectangles` — boolean，可选。calcualte pixel rankings for SERP elements in advanced resultsoptional fieldpixel ranking refers to the distance between the result snippet and top left corner of the screen;Visit Help Center to learn more&gt;&gt;by default, the parameter is set to falseNote: you will be charged extra $0.0006 for using this parameter
- `[].browser_screen_width` — integer，可选。browser screen widthoptional fieldyou can set a custom browser screen width to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1920 for desktop;360 for mobile on android;375 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true
- `[].browser_screen_height` — integer，可选。browser screen heightoptional fieldyou can set a custom browser screen height to calculate pixel rankings for a particular device;can be specified within the following range: 240-9999;by default, the parameter is set to:1080 for desktop;640 for mobile on android;812 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true
- `[].browser_screen_resolution_ratio` — integer，可选。browser screen resolution ratiooptional fieldyou can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;can be specified within the following range: 0.5-3;by default, the parameter is set to:1 for desktop;3 for mobile on android;3 for mobile on iOS;Note: to use this parameter, set calculate_rectangles to true
- `[].url` — string，可选。direct URL of the search queryoptional fieldyou can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.example:https://www.google.co.uk/search?q=%20rank%20tracker%20api&amp;hl=en&amp;gl=GB&amp;uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS；Note: the following search engine parameters are not supported and will be automatically unset if specified in the URL: lr, cr, as_qdr, as_sitesearch, as_occt, as_filetype.
- `[].target_search_mode` — string，可选。target matching modeoptional fieldto enable this parameter, stop_crawl_on_match must also be enableddefines how the crawl should stop when multiple targets are specified in stop_crawl_on_matchpossible values: all, anyall – the crawl stops only when all specified targets are foundany – the crawl stops when any single target is founddefault value: anylearn more about this parameter on our Help Center
- `[].find_targets_in` — array<string>，可选。SERP element types to check for targetsoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be checked for target matchesif not specified, all first-level elements with url and domain fields are checked for targetspossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as ignore_targets_inexample:"find_targets_in": ["organic", "featured_snippet"]learn more about this parameter on our Help Center
- `[].ignore_targets_in` — array<string>，可选。SERP element types to exclude from target searchoptional fieldto enable this parameter, stop_crawl_on_match must also be enabledspecifies which SERP element types should be excluded when searching for target matchespossible values: organic, paid, local_pack, featured_snippet, events, google_flights, images, jobs, knowledge_graph, local_service, map, scholarly_articles, third_party_reviews, twitterNote: cannot contain the same element types as find_targets_inexample:"ignore_targets_in": ["paid", "images"]learn more about this parameter on our Help Center
- `[].se_domain` — string，可选。search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de, etc.

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein"
  },
  {
    "language_name": "English",
    "location_name": "United States",
    "keyword": "albert einstein",
    "priority": "2",
    "tag": "some_string_123",
    "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
  },
  {
    "url": "https://www.google.co.uk/search?q=albert%20einstein&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS",
    "postback_data": "html",
    "postback_url": "https://your-server.com/postbackscript"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/organic/tasks_fixed

ID: `GoogleOrganicTasksFixed`
用途: ‌ The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.
中文补充: 本接口使用 **GET** 方法，路径为：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/organic/tasks_ready

ID: `GoogleOrganicTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/search_by_image/task_get/advanced/{id}

ID: `GoogleSearchByImageTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/google/search_by_image/task_post

ID: `GoogleSearchByImageTaskPost`
用途: ‌‌ Google Search By Image SERP API provides up to top 100 search engine results based on the image you specified. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
中文补充: **POST `/v3/serp/google/search_by_image/task_post`**

请求体: `application/json`

请求字段:
- `[].image_url` — string，可选。URL of the imagerequired fieldthe results will be based on the image you specified in this fieldexample:https://upload.wikimedia.org/wikipedia/commons/e/ed/Elon_Musk_Royal_Society.jpg
- `[].location_code` — integer，可选。search engine location coderequired field if you don't specify location_name&nbsp;or location_coordinateif you use this field, you don't need to specify location_name or location_coordinateyou can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:2840
- `[].language_code` — string，可选。search engine language coderequired field if you don't specify language_nameif you use this field, you don't need to specify language_nameyou can receive the list of available languages of the search engine with their language_code&nbsp;by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:en
- `[].pingback_url` — string，可选。notification URL of a completed taskoptional fieldwhen a task is completed we will notify you by GET request sent to the URL you have specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&amp;tag=$tagNote: special characters in pingback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_url` — string，可选。URL for sending task resultsoptional fieldonce the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specifiedyou can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.example:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&amp;tag=$tagNote: special characters in postback_url will be urlencoded;i.a., the # character will be encoded into %23；learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatyperequired field if you specify postback_urlcorresponds to the datatype that will be sent to your serverpossible values:advanced, html
- `[].priority` — integer，可选。task priorityoptional fieldcan take the following values:1 – normal execution priority (set by default)2 – high execution priority；You will be additionally charged for the tasks with high execution priority.The cost can be calculated on the Pricing page.
- `[].location_name` — string，可选。full name of search engine locationrequired field if you don't specify location_code or location_coordinateif you use this field, you don't need to specify location_code or location_coordinateyou can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locationsexample:London,England,United Kingdom
- `[].language_name` — string，可选。full name of search engine languagerequired field if you don't specify language_codeif you use this field, you don't need to specify language_codeyou can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languagesexample:English
- `[].tag` — string，可选。user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response
- `[].max_crawl_pages` — integer，可选。page crawl limitoptional fieldnumber of search results pages to crawlmax value: 100Note: the max_crawl_pages and depth parameters complement each other;learn more at our help center
- `[].search_param` — string，可选。additional parameters of the search queryoptional fieldget the list of available parameters and additional details here
- `[].calculate_rectangles` — boolean，可选。calculate pixel rankings for SERP elements in advanced resultsoptional fieldpixel ranking refers to the distance between the result snippet and top left corner of the screen;Visit Help Center to learn more&gt;&gt;by default, the parameter is set to falseNote: if set to true, the charge per task will be multiplied by 2
- `[].browser_screen_width` — integer，可选。browser screen widthoptional fieldyou can set a custom browser screen width to calculate pixel rankings for a particular device;by default, the parameter is set to 1920;Note: to use this parameter, set calculate_rectangles to true
- `[].browser_screen_height` — integer，可选。browser screen heightoptional fieldyou can set a custom browser screen height to calculate pixel rankings for a particular device;by default, the parameter is set to 1080;Note: to use this parameter, set calculate_rectangles to true
- `[].browser_screen_resolution_ratio` — integer，可选。browser screen resolution ratiooptional fieldyou can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device;by default, the parameter is set to 1;Note: to use this parameter, set calculate_rectangles to true
- `[].location_coordinate` — string，可选。GPS coordinates of a locationrequired field if you don't specify location_name&nbsp;or location_codeif you use this field, you don't need to specify location_name or location_codelocation_coordinate parameter should be specified in the "latitude,longitude,radius" formatthe maximum number of decimal digits for "latitude" and "longitude": 7the minimum value for "radius": 199.9 (mm)the maximum value for "radius": 199999 (mm)example:53.476225,-2.243572,200
- `[].se_domain` — string，可选。search engine domainoptional fieldwe choose the relevant search engine domain automatically according to the location and language you specifyhowever, you can set a custom search engine domain in this fieldexample:google.co.uk, google.com.au, google.de, etc.

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "image_url": "https://dataforseo.com/wp-content/uploads/2016/11/data_for_seo_light_429.png"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/search_by_image/tasks_fixed

ID: `GoogleSearchByImageTasksFixed`
用途: ‌ The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/google/search_by_image/tasks_ready

ID: `GoogleSearchByImageTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
中文补充: **GET `/v3/serp/google/search_by_image/tasks_ready`**

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/id_list

ID: `IdList`
用途: This endpoint is designed to provide you with a list of IDs and metadata for all SERP tasks created within the specified time period, including both successful and uncompleted tasks.
中文补充: 本接口使用 **POST** 方法，请求路径为 **`/v3/serp/id_list`**，用于查询指定时间范围创建的 SERP 任务 ID 及数据已完成和未完成的任务。

请求体: `application/json`

请求字段:
- `[].datetime_from` — string，可选。start time for filtering results；required field；if include_metadata is set to true, minimum start value: a month from current datetime;；if include_metadata is set to false, minimum start value: six months from current datetime;；maximum start value: current datetime;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00";；example:；2023-01-15 12:57:46 +00:00
- `[].datetime_to` — string，可选。finish time for filtering results；required field；if include_metadata is set to true, minimum finish value: a month from current datetime;；if include_metadata is set to false, minimum finish value: six months from current datetime;；maximum finish value: current datetime;；Note: datetime_to must be greater than datetime_from;；must be specified in the UTC format: "yyyy-mm-dd hh-mm-ss +00:00";；example:；2023-01-31 13:57:46 +00:00
- `[].limit` — integer，可选。the maximum number of returned task IDs；optional field；default value: 1000；maximum value: 1000；minimum value: 1
- `[].offset` — integer，可选。offset in the results array of returned task IDs；optional field；if you specify the 10 value, the first ten tasks in the results array will be omitted;；minimum and default value: 0;；maximum value: 100M (100 million)
- `[].sort` — string，可选。sorting by task execution time；optional field；possible values: "asc", "desc"；default value: "asc"
- `[].include_metadata` — boolean，可选。include task metadata in the response；optional field；if set to true, the metadata object containing parameters specified in the POST request will be provided in the response;；default value: false

最小请求示例:

```json
[
  {
    "datetime_from": "2026-08-01 17:42:44",
    "datetime_to": "2026-08-11 17:42:44",
    "limit": "10",
    "include_metadata": "true"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/naver/organic/task_get/advanced/{id}

ID: `NaverOrganicTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/naver/organic/task_get/html/{id}

ID: `NaverOrganicTaskGetHtml`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 7 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/naver/organic/task_get/regular/{id}

ID: `NaverOrganicTaskGetRegular`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/naver/organic/task_post

ID: `NaverOrganicTaskPost`
用途: ‌‌ Naver SERP API provides top 15 search engine results. Naver search results do not vary by location and language, and the search parameters for this search engine do not contain language and location variables. However, you can specify a keyword in any language, and the search engine results may vary depending on the language you used for specifying the search query.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；you can specify up to 700 characters in the keyword field；all %## will be decoded (plus character ‘+’ will be decoded to a space character)；if you need to use the “%” character for your keyword, please specify it as “%25”;；if you need to use the “+” character for your keyword, please specify it as “%2B”learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].url` — string，可选。direct URL of the search query；optional field；you can specify a direct URL and we will sort it out to the necessary fields；in most cases, we wouldn’t recommend using this method;；example:；https://search.naver.com/search.naver?where=nexearch&amp;sm=top_hty&amp;fbm=1&amp;ie=utf8&amp;query=iphone
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].depth` — integer，可选。parsing depth；optional field；number of results in SERP；default value: 15；max value: 700；Your account will be billed per each SERP containing up to 15 results; ；Setting depth above 15 may result in additional charges if the search engine returns more than 15 results;；The cost can be calculated on the Pricing page.
- `[].max_crawl_pages` — integer，可选。page crawl limit；optional field；number of search results pages to crawl；default value: 1；max value: 100；Note: the max_crawl_pages and depth parameters complement each other;；learn more at our help center
- `[].device` — string，可选。device type；optional field；return results for a specific device type；can take the values:desktop, mobile；default value: desktop
- `[].os` — string，可选。device operating system；optional field；if you specify desktop in the device field, choose from the following values: windows, macos；default value: windows；if you specify mobile in the device field, choose from the following values: android, ios；default value: android
- `[].se_domain` — string，可选。search engine domain；optional field；we choose the relevant search engine domain automatically；however, you can set a custom search engine domain in this field；example:；search.naver.com
- `[].search_param` — string，可选。additional parameters of the search query；optional field；get the list of available parameters and additional details here
- `[].stop_crawl_on_match` — array<object>，可选。array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: "stop_crawl_on_match":[{"match_value":"dataforseo.com","match_type":"with_subdomains"}] learn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api Your account will be billed per each SERP crawled through the specified targets
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatype；required field if you specify postback_url；corresponds to the function you used for setting a task；possible values:；regular, advanced, html
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "keyword": "albert einstein",
    "device": "desktop",
    "tag": "some_string_123",
    "postback_url": "https://your-server.com/postbackscript.php",
    "postback_data": "regular"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/naver/organic/tasks_fixed

ID: `NaverOrganicTasksFixed`
用途: ‌ The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/naver/organic/tasks_ready

ID: `NaverOrganicTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/screenshot

ID: `Screenshot`
用途: ‌‌ Using the Live Page Screenshot endpoint, you can capture a screenshot of any SERP page.
中文补充: 本接口用于获取指定 SERP 页面的截图。

请求体: `application/json`

请求字段:
- `[].task_id` — string，可选。task identifier；required field；unique identifier of the associated task in the UUID format；you will be able to use it within 7 days to request the results of the task at any time
- `[].browser_preset` — string，可选。browser resolution preset；optional field；browser preset associated with a certain device type；can take the following values: desktop, tablet, mobile ；Note: by default, browser preset corresponds to the device type specified in the POST request
- `[].browser_screen_width` — integer，可选。width of the browser resolution；optional field；can be specified in the following range: 240-9999；default value for desktop: 1920；default value for mobile: 390；default value for table: 1024
- `[].browser_screen_height` — integer，可选。height of the browser resolution；optional field；can be specified in the following range: 240-9999；default value for desktop: 1080；default value for mobile: 844；default value for table: 1366
- `[].browser_screen_scale_factor` — number，可选。browser scale factor；optional field；can be specified in the following range: 0.5-3；default value for desktop: 1；default value for mobile: 3；default value for table: 2
- `[].page` — integer，可选。number of SERP pages；optional field；if depth in the corresponding Task POST request exceeds 10 results (or 1 SERP page), specify the number of SERP pages to screenshot;；default value: 1

最小请求示例:

```json
[
  {
    "task_id": "06211235-0696-0139-1000-36727fbd3c90",
    "browser_screen_scale_factor": "0.5"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/seznam/languages

ID: `SeznamLanguages`
用途: You will receive the list of languages by calling this API.
中文补充: `GET /v3/serp/wp/languages`

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/seznam/locations

ID: `SeznamLocations`
用途: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
中文补充: 该接口用于获取 SERP WP 数据源支持的地理位置列表。可通过国家 ISO 代码筛选指定国家或地区的地点数据。

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/seznam/locations/{country}

ID: `SeznamLocationsCountry`
用途: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.

路径与查询参数:
- `country` — path，string，必填。country ISO code；optional field；specify the ISO code if you want to filter the list of locations by country；example:；us

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/seznam/organic/task_get/advanced/{id}

ID: `SeznamOrganicTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/seznam/organic/task_get/html/{id}

ID: `SeznamOrganicTaskGetHtml`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 7 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/seznam/organic/task_get/regular/{id}

ID: `SeznamOrganicTaskGetRegular`
用途: Description of the fields for sending a request:
中文补充: **HTTP 方法：** `GET` **接口路径：** `/v3/serp/seznam/organic/task_get/regular/$id`

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/seznam/organic/task_post

ID: `SeznamOrganicTaskPost`
用途: ‌‌ Seznam SERP API provides top 10 search engine results from one of the most popular search engines in the Czech Republic. Seznam is focused on the local search market, and thus supports the Czech language only.
中文补充: 本接口用于设置 Seznam 自然搜索结果（SERP）抓取任务。

请求体: `application/json`

请求字段:
- `[].keyword` — string，可选。keyword；required field；you can specify up to 700 characters in the keyword field；all %## will be decoded (plus character ‘+’ will be decoded to a space character)；if you need to use the “%” character for your keyword, please specify it as “%25”;；if you need to use the “+” character for your keyword, please specify it as “%2B”learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code；if you use this field, you don't need to specify location_code；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locations；example:；2840
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languages；example:；Czech
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languages；example:；csn
- `[].url` — string，可选。direct URL of the search query；optional field；you can specify a direct URL and we will sort it out to the necessary fields;；note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL;；in most cases, we wouldn’t recommend using this method.
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priority；You will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].depth` — integer，可选。parsing depth；optional field；number of results in SERP；default value: 10;；maximum value: 500;；Your account will be billed per each SERP containing up to 10 results; ；Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;；The cost can be calculated on the Pricing page.
- `[].max_crawl_pages` — integer，可选。page crawl limit；optional field；number of search results pages to crawl；default value: 1；max value: 10；Note: the max_crawl_pages and depth parameters complement each other;；learn more at our help center
- `[].device` — string，可选。device type；optional field；return results for a specific device type；can take the values:desktop, mobile；default value: desktop
- `[].os` — string，可选。device operating system；optional field；if you specify desktop in the device field, choose from the following values: windows, macos；default value: windows；if you specify mobile in the device field, choose from the following values: android, ios；default value: android
- `[].se_domain` — string，可选。search engine domain；optional field；we choose the relevant search engine domain automatically；however, you can set a custom search engine domain in this field；example:；search.seznam.cz
- `[].search_param` — string，可选。additional parameters of the search query；optional field
- `[].calculate_rectangles` — boolean，可选。calculate pixel rankings for SERP elements in advanced results；optional field；pixel ranking refers to the distance between the result snippet and top left corner of the screen;；Visit Help Center to learn more&gt;&gt;；by default, the parameter is set to false；Note: if set to true, the charge per task will be multiplied by 2
- `[].stop_crawl_on_match` — array<object>，可选。array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: "stop_crawl_on_match":[{"match_value":"dataforseo.com","match_type":"with_subdomains"}] learn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api Your account will be billed per each SERP crawled through the specified targets
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatype；required field if you specify postback_url；corresponds to the function you used for setting a task；possible values:；regular, advanced, html
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "language_code": "cs",
    "location_code": "2203",
    "keyword": "albert einstein"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/seznam/organic/tasks_fixed

ID: `SeznamOrganicTasksFixed`
用途: ‌ The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/seznam/organic/tasks_ready

ID: `SeznamOrganicTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/tasks_ready

ID: `TasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.
中文补充: 本接口用于获取已完成但尚未领取的 SERP 任务列表。HTTP 方法与接口路径如下：

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/yahoo/languages

ID: `YahooLanguages`
用途: You will receive the list of languages by calling this API.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/yahoo/locations

ID: `YahooLocations`
用途: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/yahoo/locations/{country}

ID: `YahooLocationsCountry`
用途: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.

路径与查询参数:
- `country` — path，string，必填。country ISO code；optional field；specify the ISO code if you want to filter the list of locations by country；example:；us

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/yahoo/organic/live/advanced

ID: `YahooOrganicLiveAdvanced`
用途: Live SERP provides real-time data on top search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.

请求体: `application/json`

请求字段:
- `[].url` — string，可选。direct URL of the search query；optional field；you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.；example:；https://search.yahoo.com/search?p=rank+checker&amp;n=100&amp;vl=lang_en&amp;vc=us&amp;ei=UTF-8
- `[].keyword` — string，可选。keyword；required field；you can specify up to 700 characters in the keyword field；all %## will be decoded (plus character '+' will be decoded to a space character)；if you need to use the "%" character for your keyword, please specify it as "%25";；if you need to use the “+” character for your keyword, please specify it as “%2B”learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name_or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locations；example:；2840n
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name_or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 199.9 (mm)；the maximum value for "radius": 199999 (mm)；example:；53.476225,-2.243572,200n
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languages；example:；enn
- `[].device` — string，可选。device type；optional field；return results for a specific device type；can take the values:desktop, mobile；default value: desktop
- `[].os` — string，可选。device operating system；optional field；if you specify desktop in the device field, choose from the following values: windows, macos；default value: windows；if you specify mobile in the device field, choose from the following values: android, ios；default value: android
- `[].se_domain` — string，可选。search engine domain；optional field；we choose the relevant search engine domain automatically according to the location and language you specify；however, you can set a custom search engine domain in this field；example:；au.search.yahoo.com, uk.search.yahoo.com, ca.search.yahoo.com, etc.
- `[].depth` — integer，可选。parsing depth；optional field；number of results in SERP；default value: 6；max value: 200；Your account will be billed per each SERP; ；Each Yahoo SERP can contain fewer than 10 results, so setting depth above the default value may result in additional charges ;；The cost can be calculated on the Pricing page.
- `[].max_crawl_pages` — integer，可选。page crawl limit；optional field；number of search results pages to crawl；default value: 1；max value: 100；Note: the max_crawl_pages and depth parameters complement each other;；learn more at our help center
- `[].target` — string，可选。target domain, subdomain, or webpage to get results for；optional field；a domain or a subdomain should be specified without https:// and www.；note that the results of target-specific tasks will only include SERP elements that contain a url string;；you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;；examples:；example.com - returns results for the website's home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;；example.com* - returns results for the domain, including all its pages;；*example.com* - returns results for the entire domain, including all its pages and subdomains;；*example.com - returns results for the home page regardless of the subdomain, such as https://en.example.com; ；example.com/example-page - returns results for the exact URL;；example.com/example-page* - returns results for all domain's URLs that start with the specified string
- `[].search_param` — string，可选。additional parameters of the search query；optional field；get the list of available parameters and additional details here
- `[].stop_crawl_on_match` — array<object>，可选。array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: "stop_crawl_on_match":[{"match_value":"dataforseo.com","match_type":"with_subdomains"}] learn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api Your account will be billed per each SERP crawled through the specified targets
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/yahoo/organic/live/html

ID: `YahooOrganicLiveHtml`
用途: Live SERP HTML provides a raw HTML page of search engine results for the specified keyword, search engine, and location.

请求体: `application/json`

请求字段:
- `[].url` — string，可选。direct URL of the search query；optional field；you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.；example:；https://search.yahoo.com/search?p=rank+checker&amp;n=100&amp;vl=lang_en&amp;vc=us&amp;ei=UTF-8
- `[].keyword` — string，可选。keyword；required field；you can specify up to 700 characters in the keyword field；all %## will be decoded (plus character '+' will be decoded to a space character)；if you need to use the "%" character for your keyword, please specify it as "%25";；if you need to use the “+” character for your keyword, please specify it as “%2B”learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name_or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locations；example:；2840n
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name_or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 199.9 (mm)；the maximum value for "radius": 199999 (mm)；example:；53.476225,-2.243572,200n
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languages；example:；enn
- `[].device` — string，可选。device type；optional field；return results for a specific device type；can take the values:desktop, mobile；default value: desktop
- `[].os` — string，可选。device operating system；optional field；if you specify desktop in the device field, choose from the following values: windows, macos；default value: windows；if you specify mobile in the device field, choose from the following values: android, ios；default value: android
- `[].se_domain` — string，可选。search engine domain；optional field；we choose the relevant search engine domain automatically according to the location and language you specify；however, you can set a custom search engine domain in this field；example:；au.search.yahoo.com, uk.search.yahoo.com, ca.search.yahoo.com, etc.
- `[].depth` — integer，可选。parsing depth；optional field；number of results in SERP；default value: 10；max value: 200；Your account will be billed per each SERP containing up to 10 results; ；Setting depth above 10 may result in additional charges if the search engine returns more than 10 results;；The cost can be calculated on the Pricing page.
- `[].max_crawl_pages` — integer，可选。page crawl limit；optional field；number of search results pages to crawl；default value: 1；max value: 100；Note: the max_crawl_pages and depth parameters complement each other;；learn more at our help center
- `[].search_param` — string，可选。additional parameters of the search query；optional field；get the list of available parameters and additional details here
- `[].stop_crawl_on_match` — array<object>，可选。array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: "stop_crawl_on_match":[{"match_value":"dataforseo.com","match_type":"with_subdomains"}] learn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api Your account will be billed per each SERP crawled through the specified targets

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/yahoo/organic/live/regular

ID: `YahooOrganicLiveRegular`
用途: Live Yahoo SERP provides real-time data on search engine results for the specified keyword, search engine, and location.

请求体: `application/json`

请求字段:
- `[].url` — string，可选。direct URL of the search query；optional field；you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.；example:；https://search.yahoo.com/search?p=rank+checker&amp;n=100&amp;vl=lang_en&amp;vc=us&amp;ei=UTF-8
- `[].keyword` — string，可选。keyword；required field；you can specify up to 700 characters in the keyword field；all %## will be decoded (plus character '+' will be decoded to a space character)；if you need to use the "%" character for your keyword, please specify it as "%25";；if you need to use the “+” character for your keyword, please specify it as “%2B”learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name_or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locations；example:；2840n
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name_or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 199.9 (mm)；the maximum value for "radius": 199999 (mm)；example:；53.476225,-2.243572,200n
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languages；example:；enn
- `[].device` — string，可选。device type；optional field；can take the values:desktop, mobile；default value: desktop
- `[].os` — string，可选。device operating system；optional field；if you specify desktop in the device field, choose from the following values: windows, macos；default value: windows；if you specify mobile in the device field, choose from the following values: android, ios；default value: android
- `[].se_domain` — string，可选。search engine domain；optional field；we choose the relevant search engine domain automatically according to the location and language you specify；however, you can set a custom search engine domain in this field；example:；au.search.yahoo.com, uk.search.yahoo.com, ca.search.yahoo.com, etc.
- `[].depth` — integer，可选。parsing depth；optional field；number of results in SERP；default value: 6；max value: 200；Your account will be billed per each SERP; ；Each Yahoo SERP can contain fewer than 10 results, so setting depth above the default value may result in additional charges ;；The cost can be calculated on the Pricing page.
- `[].max_crawl_pages` — integer，可选。page crawl limit；optional field；number of search results pages to crawl；default value: 1；max value: 100；Note: the max_crawl_pages and depth parameters complement each other;；learn more at our help center
- `[].target` — string，可选。target domain, subdomain, or webpage to get results for；optional field；a domain or a subdomain should be specified without https:// and www.；note that the results of target-specific tasks will only include SERP elements that contain a url string;；you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results;；examples:；example.com - returns results for the website's home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/;；example.com* - returns results for the domain, including all its pages;；*example.com* - returns results for the entire domain, including all its pages and subdomains;；*example.com - returns results for the home page regardless of the subdomain, such as https://en.example.com; ；example.com/example-page - returns results for the exact URL;；example.com/example-page* - returns results for all domain's URLs that start with the specified string
- `[].search_param` — string，可选。additional parameters of the search query；optional field；get the list of available parameters and additional details here
- `[].stop_crawl_on_match` — array<object>，可选。array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: "stop_crawl_on_match":[{"match_value":"dataforseo.com","match_type":"with_subdomains"}] learn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api Your account will be billed per each SERP crawled through the specified targets
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/yahoo/organic/task_get/advanced/{id}

ID: `YahooOrganicTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/yahoo/organic/task_get/html/{id}

ID: `YahooOrganicTaskGetHtml`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 7 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/yahoo/organic/task_get/regular/{id}

ID: `YahooOrganicTaskGetRegular`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/yahoo/organic/task_post

ID: `YahooOrganicTaskPost`
用途: ‌‌ SERP API provides top search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.

请求体: `application/json`

请求字段:
- `[].url` — string，可选。direct URL of the search query；optional field；you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.；example:；https://search.yahoo.com/search?p=rank+checker&amp;n=100&amp;vl=lang_en&amp;vc=us&amp;ei=UTF-8
- `[].keyword` — string，可选。keyword；required field；you can specify up to 700 characters in the keyword field；all %## will be decoded (plus character '+' will be decoded to a space character)；if you need to use the "%" character for your keyword, please specify it as "%25";；if you need to use the “+” character for your keyword, please specify it as “%2B”learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- `[].priority` — integer，可选。task priority；optional field；can take the following values:；1 – normal execution priority (set by default)；2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.；The cost can be calculated on the Pricing page.
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code or location_coordinate；if you use this field, you don't need to specify location_code or location_coordinate；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locations；example:；London,England,United Kingdom
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name_or location_coordinate；if you use this field, you don't need to specify location_name or location_coordinate；you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/locations；example:；2840n
- `[].location_coordinate` — string，可选。GPS coordinates of a location；required field if you don't specify location_name_or location_code；if you use this field, you don't need to specify location_name or location_code；location_coordinate parameter should be specified in the "latitude,longitude,radius" format；the maximum number of decimal digits for "latitude" and "longitude": 7；the minimum value for "radius": 199.9 (mm)；the maximum value for "radius": 199999 (mm)；example:；53.476225,-2.243572,200n
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.seermartech.cn/v3/serp/{{low_se_name}}/languages；example:；enn
- `[].device` — string，可选。device type；optional field；return results for a specific device type；can take the values:desktop, mobile；default value: desktop
- `[].os` — string，可选。device operating system；optional field；if you specify desktop in the device field, choose from the following values: windows, macos；default value: windows；if you specify mobile in the device field, choose from the following values: android, ios；default value: android
- `[].se_domain` — string，可选。search engine domain；optional field；we choose the relevant search engine domain automatically according to the location and language you specify；however, you can set a custom search engine domain in this field；example:；au.search.yahoo.com, uk.search.yahoo.com, ca.search.yahoo.com, etc.
- `[].depth` — integer，可选。parsing depth；optional field；number of results in SERP；default value: 6；max value: 700；Your account will be billed per each SERP; ；Each Yahoo SERP can contain fewer than 10 results, so setting depth above the default value may result in additional charges ;；The cost can be calculated on the Pricing page.
- `[].max_crawl_pages` — integer，可选。page crawl limit；optional field；number of search results pages to crawl；default value: 1；max value: 100；Note: the max_crawl_pages and depth parameters complement each other;；learn more at our help center
- `[].search_param` — string，可选。additional parameters of the search query；optional field；get the list of available parameters and additional details here
- `[].stop_crawl_on_match` — array<object>，可选。array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: "stop_crawl_on_match":[{"match_value":"dataforseo.com","match_type":"with_subdomains"}] learn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api Your account will be billed per each SERP crawled through the specified targets
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response
- `[].postback_url` — string，可选。URL for sending task results；optional field；once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/postbackscript?id=$id；http://your-server.com/postbackscript?id=$id&amp;tag=$tag；Note: special characters in postback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center
- `[].postback_data` — string，可选。postback_url datatype；required field if you specify postback_url；corresponds to the datatype that will be sent to your server；possible values:；regular, html
- `[].pingback_url` — string，可选。notification URL of a completed task；optional field；when a task is completed we will notify you by GET request sent to the URL you have specified；you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.；example:；http://your-server.com/pingscript?id=$id；http://your-server.com/pingscript?id=$id&amp;tag=$tag；Note: special characters in pingback_url will be urlencoded;；i.a., the # character will be encoded into %23learn more on our Help Center

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "albert einstein"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/yahoo/organic/tasks_fixed

ID: `YahooOrganicTasksFixed`
用途: ‌ The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/yahoo/organic/tasks_ready

ID: `YahooOrganicTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/youtube/languages

ID: `YoutubeLanguages`
用途: You will receive the list of languages by calling this API.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/youtube/locations

ID: `YoutubeLocations`
用途: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/youtube/locations/{country}

ID: `YoutubeLocationsCountry`
用途: You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.

路径与查询参数:
- `country` — path，string，必填。country ISO code；optional field；specify the ISO code if you want to filter the list of locations by country；example:；us

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/youtube/organic/live/advanced

ID: `YoutubeOrganicLiveAdvanced`
用途: ‌ Live SERP provides real-time data on the top 20 blocks of YouTube search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
中文补充: 本接口使用 `POST /v3/serp/youtube/organic/live/advanced`，实时获取指定在 YouTube 搜索结果中的高级数据。接口最多返回搜索结果页前 20 个结果区块，并根据指定的地区和语言返回对应结果。

请求体: `application/json`

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "audi"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/youtube/organic/task_get/advanced/{id}

ID: `YoutubeOrganicTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/youtube/organic/task_post

ID: `YoutubeOrganicTaskPost`
用途: ‌‌ YouTube Organic API provides the top 20 blocks of search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
中文补充: YouTube SERP API 用于根据指定的或视频 ID，结合搜索引擎类型、地域、语言和设备操作系统，获取 YouTube 搜索结果及视频数据。

请求体: `application/json`

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "keyword": "audi"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/youtube/organic/tasks_fixed

ID: `YoutubeOrganicTasksFixed`
用途: ‌ The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/youtube/organic/tasks_ready

ID: `YoutubeOrganicTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/youtube/video_comments/live/advanced

ID: `YoutubeVideoCommentsLiveAdvanced`
用途: ‌ Live YouTube Comments provides real-time data on comments on the video you specify in the request. You will get the top 20 comments on the video as well as information about the author, and key comment metrics.
中文补充: **POST** `https://api.seermartech.cn/v3/serp/youtube/video_comments/live/advanced`

请求体: `application/json`

请求字段:
- `[].video_id` — string，可选。ID of the video；required field；you can find video ID in the URL or 'youtube_video' item of YouTube Organic result；example:；vQXvyV0zIP4
- `[].location_name` — string，可选。full name of search engine location；required field if you don't specify location_code；if you use this field, you don't need to specify location_code；you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/youtube/locations；example:；United States
- `[].location_code` — integer，可选。search engine location code；required field if you don't specify location_name_；if you use this field, you don't need to specify location_name；you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/youtube/locations；example:；2840n
- `[].language_name` — string，可选。full name of search engine language；required field if you don't specify language_code；if you use this field, you don't need to specify language_code；you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/youtube/languages；example:；English
- `[].language_code` — string，可选。search engine language code；required field if you don't specify language_name；if you use this field, you don't need to specify language_name；you can receive the list of available languages of the search engine with their language_code_by making a separate request to the https://api.seermartech.cn/v3/serp/youtube/languages；example:；enn
- `[].device` — string，可选。device type；optional field；only value: desktop
- `[].os` — string，可选
- `[].depth` — integer，可选。parsing depth；optional field；number of results in SERP；default value: 20；max value: 200；Note: your account will be billed per each SERP containing up to 20 results;；thus, setting a depth above 20 may result in additional charges if the search engine returns more than 20 results;；if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance
- `[].tag` — string，可选。user-defined task identifier；optional field；the character limit is 255；you can use this parameter to identify the task and match it with the result；you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "video_id": "vQXvyV0zIP4"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/youtube/video_comments/task_get/advanced/{id}

ID: `YoutubeVideoCommentsTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/youtube/video_comments/task_post

ID: `YoutubeVideoCommentsTaskPost`
用途: ‌‌ YouTube Comments API provides data on comments on the video you specify in the request. You will get the top 20 comments on the video as well as information about the author, and key comment metrics.
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "video_id": "vQXvyV0zIP4"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/youtube/video_comments/tasks_fixed

ID: `YoutubeVideoCommentsTasksFixed`
用途: ‌ The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/youtube/video_comments/tasks_ready

ID: `YoutubeVideoCommentsTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.
中文补充: **GET** `https://api.seermartech.cn/v3/serp/youtube/video_comments/task_get/advanced/$id`

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/youtube/video_info/live/advanced

ID: `YoutubeVideoInfoLiveAdvanced`
用途: Live YouTube Video Info provides real-time data on the video you specify in the request. You will get data from the watching page containing key video and content metrics as well as the channel where the video is published. for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_info/live/advanced/?bash'
中文补充: 本接口使用 **POST** 方法，请求路径为：

请求体: `application/json`

请求字段:
- `[].video_id` — string，可选。ID of the video required field you can find video ID in the URL or 'youtube_video' item of YouTube Organic result example: vQXvyV0zIP4
- `[].location_code` — integer，可选。search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.seermartech.cn/v3/serp/youtube/locations example: 2840
- `[].language_code` — string，可选。search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.seermartech.cn/v3/serp/youtube/languages example: en
- `[].device` — string，可选。device type optional field only value: desktop
- `[].location_name` — string，可选。full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.seermartech.cn/v3/serp/youtube/locations example: United States
- `[].language_name` — string，可选。full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.seermartech.cn/v3/serp/youtube/languages example: English
- `[].os` — string，可选。device operating system optional field choose from the following values: windows, macos default value: windows
- `[].tag` — string，可选。user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "video_id": "vQXvyV0zIP4"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/youtube/video_info/task_get/advanced/{id}

ID: `YoutubeVideoInfoTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/youtube/video_info/task_post

ID: `YoutubeVideoInfoTaskPost`
用途: ‌‌ YouTube Video Info API provides detailed information about the video you specify in the POST request. You will get data from the watching page containing key video and content metrics as well as the channel where the video is published.
中文补充: 本接口使用 **POST** 方法设置 YouTube 视频信息采集任务。

请求体: `application/json`

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "video_id": "vQXvyV0zIP4"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/youtube/video_info/tasks_fixed

ID: `YoutubeVideoInfoTasksFixed`
用途: ‌ The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/youtube/video_info/tasks_ready

ID: `YoutubeVideoInfoTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/youtube/video_subtitles/live/advanced

ID: `YoutubeVideoSubtitlesLiveAdvanced`
用途: ‌ Live YouTube Subtitles provides real-time data on subtitles in the video you specify in the request. You will get data from the watching page containing subtitled text, its language, and duration in the video.
中文补充: 本接口使用 **POST** 方法，路径为：

请求体: `application/json`

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "video_id": "Y8Wu4rSNJms"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/youtube/video_subtitles/task_get/advanced/{id}

ID: `YoutubeVideoSubtitlesTaskGetAdvanced`
用途: Description of the fields for sending a request:

路径与查询参数:
- `id` — path，string，必填。task identifier；unique task identifier in our system in the UUID format；you will be able to use it within 30 days to request the results of the task at any time

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### POST /v3/serp/youtube/video_subtitles/task_post

ID: `YoutubeVideoSubtitlesTaskPost`
用途: ‌‌ YouTube Subtitles API provides data on all subtitles in the video you specify in the POST request. You will get data from the watching page containing subtitled text, its language, and duration in the video.
中文补充: 本接口用于创建 YouTube 视频字幕采集任务。请求提交后，系统将获取指定视频观看页中的字幕信息字幕文本、字幕语言以及字幕在视频中的时间范围。

请求体: `application/json`

最小请求示例:

```json
[
  {
    "language_code": "en",
    "location_code": "2840",
    "video_id": "Y8Wu4rSNJms"
  }
]
```

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — object，可选。array of results；in this case, the value will be null

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/youtube/video_subtitles/tasks_fixed

ID: `YoutubeVideoSubtitlesTasksFixed`
用途: ‌ The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

### GET /v3/serp/youtube/video_subtitles/tasks_ready

ID: `YoutubeVideoSubtitlesTasksReady`
用途: ‌ The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article.

关键响应字段:
- `version` — string，可选。the current version of the API
- `status_code` — integer，可选。general status code you can find the full list of the response codes here
- `status_message` — string，可选。general informational message you can find the full list of general informational messages here
- `time` — string，可选。total execution time, seconds
- `cost` — number，可选。total tasks cost, USD
- `tasks_count` — integer，可选。the number of tasks in the tasks array
- `tasks_error` — integer，可选。the number of tasks in the tasks array returned with an error
- `tasks` — array<object>，可选。array of tasks
- `tasks[].id` — string，可选。task identifier unique task identifier in our system in the UUID format
- `tasks[].status_code` — integer，可选。status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here
- `tasks[].status_message` — string，可选。informational message of the task you can find the full list of general informational messages here
- `tasks[].time` — string，可选。execution time, seconds
- `tasks[].cost` — number，可选。total tasks cost, USD
- `tasks[].result_count` — integer，可选。number of elements in the result array
- `tasks[].path` — array<string>，可选。URL path
- `tasks[].data` — object，可选。contains the same parameters that you specified in the POST request
- `tasks[].result` — array<object>，可选。array of results

调用规则: 使用 Bearer Token；同时检查 HTTP 状态、顶层 `status_code` 和 `tasks[].status_code`。

## 相关资源

- 完整 Markdown：https://docs.seermartech.cn/agent-api-reference.md
- Agent 约定入口：https://docs.seermartech.cn/llms-full.txt
- Postman：https://docs.seermartech.cn/seermartech-postman.json
- 登录：https://console.seermartech.cn/login
- 注册：https://console.seermartech.cn/register