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

# 竞品列表查询

> 查询指定品牌下的竞争对手列表。

查询指定品牌下的竞争对手列表。可通过 `competitorName` 按名称模糊筛选，不传则返回该品牌全部竞品。接口固定返回全量列表，按创建时间倒序排列。

<Info>
  **执行模式：SYNC · 实时请求。**
  请求发出后服务端同步执行业务，结果直接在当前响应的 `data` 中返回，不存在异步任务、无需轮询、无需二次查询。
</Info>

## 接口速查

| 项目 | 当前接口约定 |
| - | - |
| 接口状态 | 已上线 |
| 请求方式 | `POST` |
| 请求地址 | `https://geobaseapi.aibase.com/v1/openapi/execute` |
| 业务标识 | `geo.competitors` |
| 执行模式 | **SYNC · 实时请求**（直接返回，无需轮询） |
| 身份认证 | Header `AIBase-API-Key` |
| 请求格式 | `application/json` |
| 返回结构 | 分页结构（含 `records`） |

## 请求头

<ParamField header="AIBase-API-Key" type="string" required>
  开发者 API Key，例如 `AIBase_xxx`。用于身份认证、有效期与调用权限校验，请仅在服务端保存和使用。
</ParamField>

<ParamField header="Content-Type" type="string" required>
  固定为 `application/json`。
</ParamField>

<ParamField header="AIBase-Request-Id" type="string">
  开发者自定义请求 ID，用于请求追踪；不传时系统自动生成 UUID。
</ParamField>

## 请求体

<ParamField body="apiCode" type="string" required>
  固定为 `geo.competitors`
</ParamField>

<ParamField body="data.brandId" type="string" required>
  所属品牌 ID，为空返回 `4001`
</ParamField>

<ParamField body="data.competitorName" type="string">
  竞品名称关键字，按名称模糊筛选；不传返回全部竞品
</ParamField>

<RequestExample>
  ```bash cURL theme={null}
  curl --location 'https://geobaseapi.aibase.com/v1/openapi/execute' \
    --header 'Content-Type: application/json' \
    --header 'AIBase-API-Key: AIBase_xxxxxxxxxxxxxxxx' \
    --header 'AIBase-Request-Id: req-20260924-001' \
    --data '{
      "apiCode": "geo.competitors",
      "data": {
        "brandId": "brand-001",
        "competitorName": "竞品A"
      }
    }'
  ```

  ```python Python theme={null}
  import os
  import requests

  api_key = os.environ["AIBASE_API_KEY"]
  headers = {
      "AIBase-API-Key": api_key,
      "Content-Type": "application/json",
      "AIBase-Request-Id": "req-20260924-001",
  }

  res = requests.post(
      "https://geobaseapi.aibase.com/v1/openapi/execute",
      headers=headers,
      json={"apiCode": "geo.competitors", "data": {"brandId": "brand-001", "competitorName": "竞品A"}},
      timeout=60,
  )
  res.raise_for_status()
  payload = res.json()

  if payload["code"] == 200:
      for item in payload["data"]["records"]:
          print(item)
  ```

  ```javascript Node.js theme={null}
  const res = await fetch("https://geobaseapi.aibase.com/v1/openapi/execute", {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "AIBase-API-Key": process.env.AIBASE_API_KEY,
      "AIBase-Request-Id": "req-20260924-001",
    },
    body: JSON.stringify({"apiCode": "geo.competitors", "data": {"brandId": "brand-001", "competitorName": "竞品A"}}),
  });

  const payload = await res.json();
  if (payload.code === 200) {
    for (const item of payload.data.records) {
      console.log(item);
    }
  }
  ```

  ```java Java theme={null}
  String body = """
  {
    "apiCode": "geo.competitors",
    "data": {
      "brandId": "brand-001",
      "competitorName": "竞品A"
    }
  }
  """;

  HttpRequest request = HttpRequest.newBuilder()
      .uri(URI.create("https://geobaseapi.aibase.com/v1/openapi/execute"))
      .header("Content-Type", "application/json")
      .header("AIBase-API-Key", "AIBase_xxxxxxxxxxxxxxxx")
      .header("AIBase-Request-Id", "req-20260924-001")
      .POST(BodyPublishers.ofString(body))
      .build();

  HttpResponse<String> response = HttpClient.newHttpClient()
      .send(request, BodyHandlers.ofString());
  System.out.println(response.body());
  ```
</RequestExample>

## 返回参数

业务结果位于 `data`，为分页结构，其中 `records` 为竞品列表（本接口固定返回全量，`size = -1`）。

<ResponseField name="records" type="object[]">
  竞品明细列表。
</ResponseField>

<ResponseField name="records[].id" type="string">
  竞品唯一标识。
</ResponseField>

<ResponseField name="records[].competitorName" type="string">
  竞品名称。
</ResponseField>

<ResponseField name="records[].logoUrl" type="string">
  竞品 Logo URL。
</ResponseField>

<ResponseField name="records[].monitorType" type="integer">
  `1` 开启监控，`0` 关闭监控。
</ResponseField>

<ResponseField name="records[].competitorWebsite" type="string">
  竞品官网 URL。
</ResponseField>

<ResponseField name="records[].competitorKeywords" type="object">
  竞品监控关键词，JSON 数组解析后的数组，可能为 null。
</ResponseField>

<ResponseField name="records[].createTime" type="string">
  格式 `yyyy-MM-dd HH:mm:ss`。
</ResponseField>

<ResponseField name="total" type="long / integer">
  总数、每页条数、当前页、总页数；本接口返回全量，`size = -1`。
</ResponseField>

<ResponseField name="size" type="long / integer">
  同上，见上方分页字段说明。
</ResponseField>

<ResponseField name="current" type="long / integer">
  同上，见上方分页字段说明。
</ResponseField>

<ResponseField name="pages" type="long / integer">
  同上，见上方分页字段说明。
</ResponseField>

<ResponseExample>
  ```json 200 (成功响应) theme={null}
  {
    "code": 200,
    "msg": "成功",
    "data": {
      "records": [
        {
          "id": "comp-001",
          "competitorName": "竞品A",
          "logoUrl": "https://cdn.example.com/comp-a.png",
          "monitorType": 1,
          "competitorWebsite": "https://www.comp-a.com",
          "competitorKeywords": ["关键词1", "关键词2"],
          "createTime": "2026-09-20 10:00:00"
        }
      ],
      "total": 1,
      "size": -1,
      "current": 1,
      "pages": 1
    },
    "timeStamp": 1788830174812
  }
  ```
</ResponseExample>

## 接入注意事项

1. `apiCode` 必须固定为 `geo.competitors`。
2. `brandId` 为必填参数，为空返回 `4001`（所需参数不足）。
3. `competitorName` 可选，按名称模糊筛选。
4. 接口固定返回全量列表，`size = -1`，无需传分页参数。
5. `competitorKeywords` 可能为 `null`，解析时做好空值兼容。
6. 建议先通过 `geo.brand` 获取品牌 ID，再调用本接口。

<AccordionGroup>
  <Accordion title="Java 返回对象">
    ```java theme={null}
    public class CompetitorData {
        private String id;
        private String competitorName;
        private String logoUrl;
        private Integer monitorType;
        private String competitorWebsite;
        private Object competitorKeywords;
        private LocalDateTime createTime;
    }
    ```

    完整响应类型可表示为 `ReturnResult<PageResult<CompetitorData>>`（`PageResult` 定义见 6.2.5）。
  </Accordion>

  <Accordion title="TypeScript 类型">
    ```typescript theme={null}
    export interface CompetitorData {
      id: string;
      competitorName: string;
      logoUrl: string | null;
      monitorType: number;
      competitorWebsite: string | null;
      competitorKeywords: string[] | null;
      createTime: string;
    }
    ```

    可按以下 TypeScript 类型定义解析响应数据。
  </Accordion>
</AccordionGroup>

<Note>
  本页的 cURL 与 Java 示例来自官方接口文档；Python 与 Node.js 示例为等价转写，未经服务端联调，请以实际返回结果为准。
</Note>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.