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

# Twitch Profiles

> 获取 Twitch 的标准化公开 Profiles 数据。

# Twitch Profiles

获取 Twitch 的标准化公开 Profiles 数据。

每个成功任务固定扣除 `0.19` 积分。

## 请求体

```json theme={"system"}
{
  "username": "ninja"
}
```

## 通过 MCP 使用

| 接口             | 值                                                |
| -------------- | ------------------------------------------------ |
| REST           | `POST /v1/twitch/profile`                        |
| Compact MCP    | `socq_execute` with `endpoint: "twitch/profile"` |
| Typed MCP      | `socq_twitch_profile`                            |
| Exact-tool URL | `https://api.socq.ai/mcp?tools=twitch_profiles`  |
| CLI            | `socq twitch profile`                            |

<Info>
  请求成功后会返回 `task_id`。使用 `socq_get_task` 查询任务，成功后从 `results.items` 读取标准化结果。
</Info>

## 结果字段

| 字段                        | 类型        | 可为空 | 说明                                       |
| ------------------------- | --------- | --- | ---------------------------------------- |
| `id`                      | `string`  | 是   | 当前结果项的唯一标识。                              |
| `platform`                | `string`  | 否   | 结果所属的平台，例如 `instagram` 或 `linkedin`。     |
| `resource`                | `string`  | 否   | 该结果对应的 SocQ 资源，例如 `videos` 或 `comments`。 |
| `type`                    | `string`  | 否   | 结果项的类别，例如 `video`、`post` 或 `comment`。    |
| `url`                     | `string`  | 是   | 结果项的公开访问地址（如可获得）。                        |
| `published_at`            | `string`  | 是   | 源内容的发布时间（如可获得），使用 ISO 8601 格式。           |
| `collected_at`            | `string`  | 否   | SocQ 采集或处理该结果的时间，使用 ISO 8601 格式。         |
| `username`                | `string`  | 是   | 账号的公开用户名或账号标识。                           |
| `name`                    | `string`  | 是   | 账号或主页的显示名称。                              |
| `text`                    | `string`  | 是   | 账号或主页的简介。                                |
| `avatar_url`              | `string`  | 是   | 账号头像图片的地址。                               |
| `cover_url`               | `string`  | 是   | 封面图片的地址。                                 |
| `website`                 | `string`  | 是   | 账号、公司或广告主关联的网站。                          |
| `is_verified`             | `boolean` | 是   | 账号是否已通过平台认证。                             |
| `is_private`              | `boolean` | 是   | 账号是否为私密账号。                               |
| `location`                | `object`  | 是   | 结果关联的地理位置信息。                             |
| `location`                | `object`  | 否   | 标准结果中的字段值。                               |
| `location.name`           | `string`  | 是   | 便于阅读的地点名称。                               |
| `location.city`           | `string`  | 是   | 城市名称。                                    |
| `location.region`         | `string`  | 是   | 地区、州或省份名称。                               |
| `location.country`        | `string`  | 是   | 国家或地区名称或代码。                              |
| `location.latitude`       | `number`  | 是   | 十进制度格式的纬度。                               |
| `location.longitude`      | `number`  | 是   | 十进制度格式的经度。                               |
| `metrics`                 | `object`  | 是   | 结果项可获得的计数和度量数据。                          |
| `metrics`                 | `object`  | 否   | 标准结果中的字段值。                               |
| `metrics.followers_count` | `integer` | 是   | 粉丝数量。                                    |
| `metrics.following_count` | `integer` | 是   | 关注的账号数量。                                 |
| `metrics.posts_count`     | `integer` | 是   | 帖子数量，或与趋势关联的帖子数量。                        |

## 任务完成响应

```json theme={"system"}
{
  "code": 200,
  "message": "success",
  "data": {
    "task_id": "task_example",
    "public_id": "twitch/profile",
    "status": "succeeded",
    "result_count": 0,
    "credits_amount": 0,
    "results": {
      "schema_id": "account",
      "schema_version": "1.0",
      "items": [],
      "limit": 20,
      "next_cursor": null,
      "has_more": false
    }
  }
}
```


## OpenAPI

````yaml zh/api-manual/agent-api/agent-api.json POST /v1/twitch/profile
openapi: 3.1.0
info:
  title: SocQ Agent API 中文版
  version: v1-d93e6d4f8368
  description: 根据 SocQ 能力目录生成的异步社交数据 API。
servers:
  - url: https://api.socq.ai
security: []
paths:
  /v1/twitch/profile:
    post:
      tags:
        - twitch
      summary: Twitch Profiles
      description: 获取 Twitch 的标准化公开 Profiles 数据。
      operationId: socq_twitch_profile
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              additionalProperties: false
              properties:
                username:
                  type: string
                  minLength: 1
                  description: 公开账号用户名。
              required:
                - username
      responses:
        '200':
          description: 任务已受理
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentSubmitResponse'
        '422':
          description: Input validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentValidationErrorResponse'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    AgentSubmitResponse:
      type: object
      properties:
        code:
          type: integer
          const: 200
          description: HTTP 业务状态码。
        data:
          type: object
          properties:
            task_id:
              type: string
              description: 任务 ID，用于查询任务状态和结果。
            status:
              type: string
              description: 任务当前状态。
            created_time:
              type:
                - string
                - 'null'
              description: 任务创建时间。
          required:
            - task_id
            - status
    AgentValidationErrorResponse:
      type: object
      properties:
        code:
          type: integer
          const: 422
        error:
          type: object
          properties:
            message:
              type: string
            type:
              type: string
            details:
              type: object
          required:
            - message
            - type
      required:
        - code
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: '使用 `Authorization: Bearer <token>` 请求头进行身份验证。'
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: 也可以通过 `x-api-key` 请求头提供 API Key。

````