# 获取视频评论/Get video comments

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/youtube/web_v2/get_video_comments:
    get:
      summary: 获取视频评论/Get video comments
      deprecated: false
      description: >-
        # [中文]

        ### 用途:

        - 获取YouTube视频的一级评论


        ### 参数详解:


        #### 📌 必选参数:

        **video_id** (string)

        - **作用**: 视频ID

        - **格式**: YouTube视频ID字符串

        - **示例**: `"oaSNBz4qMQY"`

        - **获取方式**: 从URL `https://www.youtube.com/watch?v=oaSNBz4qMQY` 中提取


        #### ⚙️ 可选参数:

        **language_code** (string, 可选)

        - **作用**: 设置评论显示的语言偏好

        - **默认值**: `"zh-CN"`

        - **可用值**: `"zh-CN"`, `"en-US"`, `"ja-JP"`, `"ko-KR"` 等


        **country_code** (string, 可选)

        - **作用**: 设置地区代码

        - **默认值**: `"US"`

        - **可用值**: `"US"`, `"JP"`, `"GB"` 等


        **sort_by** (string, 可选)

        - **作用**: 评论排序方式

        - **默认值**: `"top"`

        - **可用值**:
          - `"top"` - 热门评论（按点赞数排序）
          - `"newest"` - 最新评论（按时间排序）

        **continuation_token** (string, 可选)

        - **作用**: 翻页令牌，用于获取下一页评论

        - **默认值**: `null`

        - **获取方式**: 从上一次请求的响应中提取


        **need_format** (boolean, 可选)

        - **作用**: 是否返回清洗后的精简数据

        - **默认值**: `true`

        - **可用值**:
          - `false` - 返回原始完整数据
          - `true` - 返回清洗后的精简数据（推荐，默认）

        ### 返回数据结构 (need_format=true):

        ```json

        {
          "comments": [
            {
              "comment_id": "UgzRDoUJAvDNn5_8i8p4AaABAg",
              "content": "评论内容文本",
              "published_time": "1天前",
              "reply_level": 0,
              "like_count": "2",
              "like_count_a11y": "2 次赞",
              "reply_count": "0",
              "reply_count_a11y": "0 条回复",
              "reply_count_text": "1 条回复",
              "reply_continuation_token": "...",
              "author": {
                "channel_id": "UCzRzHrLFuH0lHZYnrI84I8Q",
                "display_name": "@username",
                "channel_url": "https://www.youtube.com/@username",
                "avatar_url": "https://yt3.ggpht.com/...",
                "avatar_thumbnails": [
                  {"url": "...", "width": 88, "height": 88}
                ],
                "is_verified": false,
                "is_creator": false,
                "is_artist": false
              },
              "creator_thumbnail_url": "https://yt3.ggpht.com/..."
            }
          ],
          "continuation_token": "下一页token"
        }

        ```


        ### 字段说明:

        - `comment_id`: 评论唯一ID

        - `content`: 评论文本内容

        - `published_time`: 发布时间（相对时间，如"1天前"）

        - `reply_level`: 回复层级（0表示一级评论）

        - `like_count`: 点赞数

        - `reply_count`: 回复数

        - `reply_count_text`: 回复数文本（如"1 条回复"）

        - `reply_continuation_token`: 获取该评论回复的token

        - `author`: 评论作者信息
          - `channel_id`: 作者频道ID
          - `display_name`: 显示名称
          - `channel_url`: 频道URL
          - `avatar_url`: 头像URL
          - `is_verified`: 是否已认证
          - `is_creator`: 是否为视频创作者
          - `is_artist`: 是否为音乐人
        - `creator_thumbnail_url`: 视频创作者头像URL


        # [English]

        ### Purpose:

        - Get YouTube video first-level comments


        ### Parameters:


        #### 📌 Required:

        **video_id** (string)

        - **Purpose**: Video ID

        - **Format**: YouTube video ID string

        - **Example**: `"oaSNBz4qMQY"`

        - **How to get**: Extract from URL
        `https://www.youtube.com/watch?v=oaSNBz4qMQY`


        #### ⚙️ Optional:

        **language_code** (string, optional)

        - **Purpose**: Set language preference for comments

        - **Default**: `"zh-CN"`

        - **Values**: `"zh-CN"`, `"en-US"`, `"ja-JP"`, `"ko-KR"`, etc.


        **country_code** (string, optional)

        - **Purpose**: Set region code

        - **Default**: `"US"`

        - **Values**: `"US"`, `"JP"`, `"GB"`, etc.


        **sort_by** (string, optional)

        - **Purpose**: Comment sorting method

        - **Default**: `"top"`

        - **Values**:
          - `"top"` - Top comments (sorted by likes)
          - `"newest"` - Newest comments (sorted by time)

        **continuation_token** (string, optional)

        - **Purpose**: Pagination token for next page

        - **Default**: `null`

        - **How to get**: Extract from previous response


        **need_format** (boolean, optional)

        - **Purpose**: Whether to return cleaned simplified data

        - **Default**: `true`

        - **Values**:
          - `false` - Return raw complete data
          - `true` - Return cleaned simplified data (recommended, default)

        ### Response Structure (need_format=true):

        ```json

        {
          "comments": [
            {
              "comment_id": "UgzRDoUJAvDNn5_8i8p4AaABAg",
              "content": "Comment text content",
              "published_time": "1 day ago",
              "reply_level": 0,
              "like_count": "2",
              "like_count_a11y": "2 likes",
              "reply_count": "0",
              "reply_count_a11y": "0 replies",
              "reply_count_text": "1 reply",
              "reply_continuation_token": "...",
              "author": {
                "channel_id": "UCzRzHrLFuH0lHZYnrI84I8Q",
                "display_name": "@username",
                "channel_url": "https://www.youtube.com/@username",
                "avatar_url": "https://yt3.ggpht.com/...",
                "avatar_thumbnails": [
                  {"url": "...", "width": 88, "height": 88}
                ],
                "is_verified": false,
                "is_creator": false,
                "is_artist": false
              },
              "creator_thumbnail_url": "https://yt3.ggpht.com/..."
            }
          ],
          "continuation_token": "next page token"
        }

        ```


        ### Field Descriptions:

        - `comment_id`: Unique comment ID

        - `content`: Comment text content

        - `published_time`: Published time (relative, e.g., "1 day ago")

        - `reply_level`: Reply level (0 for first-level comments)

        - `like_count`: Number of likes

        - `reply_count`: Number of replies

        - `reply_count_text`: Reply count text (e.g., "1 reply")

        - `reply_continuation_token`: Token to get replies for this comment

        - `author`: Comment author info
          - `channel_id`: Author's channel ID
          - `display_name`: Display name
          - `channel_url`: Channel URL
          - `avatar_url`: Avatar URL
          - `is_verified`: Whether verified
          - `is_creator`: Whether video creator
          - `is_artist`: Whether artist
        - `creator_thumbnail_url`: Video creator's avatar URL


        # [示例/Examples]

        ## 获取热门评论

        GET /youtube_web/get_video_comments?video_id=oaSNBz4qMQY&sort_by=top


        ## 获取最新评论

        GET /youtube_web/get_video_comments?video_id=oaSNBz4qMQY&sort_by=newest


        ## 获取清洗后的评论数据（推荐）

        GET
        /youtube_web/get_video_comments?video_id=oaSNBz4qMQY&need_format=true


        ## 翻页获取更多评论

        GET
        /youtube_web/get_video_comments?video_id=oaSNBz4qMQY&continuation_token=xxx&need_format=true
      operationId: get_video_comments_api_v1_youtube_web_v2_get_video_comments_get
      tags:
        - YouTube-Web-V2-API
        - YouTube-Web-V2-API
      parameters:
        - name: video_id
          in: query
          description: 视频ID/Video ID
          required: true
          example: LuIL5JATZsc
          schema:
            type: string
            minLength: 11
            maxLength: 11
            description: 视频ID/Video ID
            title: Video Id
        - name: language_code
          in: query
          description: 语言代码（如zh-CN, en-US等）/Language code
          required: false
          example: zh-CN
          schema:
            type: string
            description: 语言代码（如zh-CN, en-US等）/Language code
            default: zh-CN
            title: Language Code
        - name: country_code
          in: query
          description: 国家代码（如US, JP等）/Country code
          required: false
          example: US
          schema:
            type: string
            description: 国家代码（如US, JP等）/Country code
            default: US
            title: Country Code
        - name: sort_by
          in: query
          description: 排序方式 | Sort by
          required: false
          schema:
            $ref: '#/components/schemas/CommentSortByAPI'
            description: 排序方式 | Sort by
            examples:
              top:
                summary: 热门评论
                value: top
              newest:
                summary: 最新评论
                value: newest
            default: top
        - name: continuation_token
          in: query
          description: 翻页令牌/Pagination token
          required: false
          schema:
            type: string
            description: 翻页令牌/Pagination token
            title: Continuation Token
        - name: need_format
          in: query
          description: 是否需要清洗数据，提取关键内容，移除冗余数据/Whether to clean and format the data
          required: false
          schema:
            type: boolean
            description: 是否需要清洗数据，提取关键内容，移除冗余数据/Whether to clean and format the data
            default: true
            title: Need Format
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseModel'
          headers: {}
          x-apifox-name: OK
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          headers: {}
          x-apifox-name: Unprocessable Entity
      security:
        - HTTPBearer: []
          x-apifox:
            schemeGroups:
              - id: BDSzAFRBmvtm0H0dvuLF8
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: BDSzAFRBmvtm0H0dvuLF8
            scopes:
              BDSzAFRBmvtm0H0dvuLF8:
                HTTPBearer: []
      x-apifox-folder: YouTube-Web-V2-API
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-419083082-run
components:
  schemas:
    CommentSortByAPI:
      type: string
      enum:
        - top
        - newest
      title: CommentSortByAPI
      description: 评论排序方式
      x-apifox-folder: ''
    ResponseModel:
      properties:
        code:
          type: integer
          title: Code
          description: HTTP status code | HTTP状态码
          default: 200
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Id
          description: Unique request identifier | 唯一请求标识符
        message:
          type: string
          title: Message
          description: Response message (EN-US) | 响应消息 (English)
          default: Request successful. This request will incur a charge.
        message_zh:
          type: string
          title: Message Zh
          description: Response message (ZH-CN) | 响应消息 (中文)
          default: 请求成功，本次请求将被计费。
        support:
          type: string
          title: Support
          description: Support message | 支持消息
          default: 'Discord: https://discord.gg/aMEAS8Xsvz'
        time:
          type: string
          title: Time
          description: The time the response was generated | 生成响应的时间
        time_stamp:
          type: integer
          title: Time Stamp
          description: The timestamp the response was generated | 生成响应的时间戳
        time_zone:
          type: string
          title: Time Zone
          description: The timezone of the response time | 响应时间的时区
          default: America/Los_Angeles
        docs:
          anyOf:
            - type: string
            - type: 'null'
          title: Docs
          description: >-
            Link to the API Swagger documentation for this endpoint | 此端点的 API
            Swagger 文档链接
        cache_message:
          anyOf:
            - type: string
            - type: 'null'
          title: Cache Message
          description: Cache message (EN-US) | 缓存消息 (English)
          default: >-
            This response is cached and accessible via the URL below for 24
            hours at no extra cost. The cache is for request tracing only — it
            doesn't affect the API's data freshness and won't be returned
            through the API again.
        cache_message_zh:
          anyOf:
            - type: string
            - type: 'null'
          title: Cache Message Zh
          description: Cache message (ZH-CN) | 缓存消息 (中文)
          default: >-
            本次响应已缓存，可通过下方 URL 直接查看，有效期 24
            小时，访问缓存链接无额外费用。缓存仅用于请求溯源，不影响接口数据的时效性，也不会再次通过接口返回。
        cache_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Cache Url
          description: The URL to access the cached result | 访问缓存结果的 URL
        router:
          type: string
          title: Router
          description: The endpoint that generated this response | 生成此响应的端点
          default: ''
        params:
          type: string
        data:
          anyOf:
            - type: string
            - type: 'null'
          title: Data
          description: The response data | 响应数据
      type: object
      title: ResponseModel
      x-apifox-orders:
        - code
        - request_id
        - message
        - message_zh
        - support
        - time
        - time_stamp
        - time_zone
        - docs
        - cache_message
        - cache_message_zh
        - cache_url
        - router
        - params
        - data
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
      x-apifox-orders:
        - detail
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
      x-apifox-orders:
        - loc
        - msg
        - type
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
  securitySchemes:
    HTTPBearer:
      type: bearer
      description: >
        ----

        #### API Token Introduction:

        ##### Method 1: Use API Token in the Request Header (Recommended)

        - **Header**: `Authorization`

        - **Format**: `Bearer {token}`

        - **Example**: `{"Authorization": "Bearer your_token"}`

        - **Swagger UI**: Click on the `Authorize` button in the upper right
        corner of the page to enter the API token directly without the `Bearer`
        keyword.


        ##### Method 2: Use API Token in the Cookie (Not Recommended, Use Only
        When Method 1 is Unavailable)

        - **Cookie**: `Authorization`

        - **Format**: `Bearer {token}`

        - **Example**: `Authorization=Bearer your_token`


        #### Get API Token:

        1. Register and log in to your account on the TikHub website.

        2. Go to the user center, click on the API token menu, and create an API
        token.

        3. Copy and use the API token in the request header.

        4. Keep your API token confidential and use it only in the request
        header.


        ----


        #### API令牌简介:

        ##### 方法一：在请求头中使用API令牌（推荐）

        - **请求头**: `Authorization`

        - **格式**: `Bearer {token}`

        - **示例**: `{"Authorization": "Bearer your_token"}`

        - **Swagger UI**: 点击页面右上角的`Authorize`按钮，直接输入API令牌，不需要`Bearer`关键字。


        ##### 方法二：在Cookie中使用API令牌（不推荐，仅在无法使用方法一时使用）

        - **Cookie**: `Authorization`

        - **格式**: `Bearer {token}`

        - **示例**: `Authorization=Bearer your_token`


        #### 获取API令牌:

        1. 在TikHub网站注册并登录账户。

        2. 进入用户中心，点击API令牌菜单，创建API令牌。

        3. 复制并在请求头中使用API令牌。

        4. 保密您的API令牌，仅在请求头中使用。
      scheme: bearer
servers:
  - url: https://api.tikhub.io
    description: Production Environment
security: []

```