YouTube-Web-V2-API

获取频道描述信息/Get channel description

Changed on

[中文]

用途:

  • 获取YouTube频道的介绍信息(订阅数、视频数、观看次数、注册时间、社交链接等)

重要提示 - 需要两次请求获取完整数据:

  • 第一次请求(使用channel_id): 返回基本信息(频道名称、描述、订阅数、视频数、头像、横幅等)
  • 第二次请求(使用continuation_token): 返回高级信息(注册时间、社交媒体链接、国家、观看次数等)

如何获取channel_id:

  • 如果你只有频道URL(如 https://www.youtube.com/@CozyCraftYT),请先调用 get_channel_id 接口获取channel_id
  • 该接口会返回类似 UCeu6U67OzJhV1KwBansH3Dg 的频道ID

参数详解:

📌 必选参数(二选一):

channel_id (string)

  • 作用: 频道ID,用于第一次请求获取频道基本信息
  • 格式: 通常以 UC 开头的24位字符串
  • 示例: "UCeu6U67OzJhV1KwBansH3Dg"
  • 获取方式: 调用 get_channel_id 接口,传入频道URL即可获取

continuation_token (string)

  • 作用: 翻页标志,用于第二次请求获取频道的高级信息
  • 获取方式: 从第一次请求的响应中获取 continuation_token 字段
  • 注意: channel_id 和 continuation_token 必须提供其中一个

⚙️ 可选参数:

language_code (string, 可选)

  • 作用: 设置显示语言偏好
  • 默认值: "zh-CN"
  • 可用值: "zh-CN", "en-US", "ja-JP", "ko-KR" 等

country_code (string, 可选)

  • 作用: 设置地区代码
  • 默认值: "US"
  • 可用值: "US", "JP", "GB" 等

need_format (boolean, 可选)

  • 作用: 是否返回清洗后的精简数据
  • 默认值: true
  • 可用值:
    • false - 返回原始完整数据
    • true - 返回清洗后的精简数据(推荐,默认)

使用流程(三步获取完整数据):

  1. 获取channel_id: 如果只有频道URL,先调用 get_channel_id?channel_url=https://www.youtube.com/@CozyCraftYT
  2. 第一次请求: 使用 channel_id 参数获取频道基本信息,同时获取 continuation_token
  3. 第二次请求: 使用 continuation_token 获取高级信息(注册时间、社交链接等)

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

第一次请求返回(使用channel_id):

{
  "channel_id": "UCeu6U67OzJhV1KwBansH3Dg",
  "title": "CozyCraft",
  "handle": "CozyCraftYT",
  "description": "频道介绍...",
  "subscriber_count": "9.84万位订阅者",
  "video_count": "181 个视频",
  "view_count": null,
  "country": null,
  "creation_date": null,
  "links": [],
  "avatar": [{"url": "...", "width": 900, "height": 900}],
  "banner": [{"url": "...", "width": 2560, "height": 424}],
  "keywords": "Minecraft Ambience...",
  "channel_url": "https://www.youtube.com/channel/UCeu6U67OzJhV1KwBansH3Dg",
  "vanity_url": "http://www.youtube.com/@CozyCraftYT",
  "rss_url": "https://www.youtube.com/feeds/videos.xml?channel_id=UCeu6U67OzJhV1KwBansH3Dg",
  "is_family_safe": true,
  "verified": false,
  "has_business_email": false,
  "has_membership": true,
  "continuation_token": "4qmFsgJg..."
}

第二次请求返回(使用continuation_token):

{
  "channel_id": "UCeu6U67OzJhV1KwBansH3Dg",
  "title": null,
  "handle": "CozyCraftYT",
  "description": "完整频道介绍...",
  "subscriber_count": "98.4K subscribers",
  "video_count": "181 videos",
  "view_count": "53,218,926 views",
  "country": "United States",
  "creation_date": "Oct 28, 2022",
  "links": [
    {"name": "Discord", "url": "https://discord.gg/tvuxxcsgSS"},
    {"name": "Twitter", "url": "https://twitter.com/..."}
  ],
  "avatar": [],
  "banner": [],
  "verified": false,
  "has_business_email": true,
  "continuation_token": null
}

注意事项:

  • 必须进行两次请求才能获取完整的频道信息
  • 第一次请求: 获取基本信息(title、avatar、banner、keywords、rss_url等)和 continuation_token
  • 第二次请求: 获取高级信息(creation_date、links、view_count、country等)
  • 建议两次请求都设置 need_format=true 获取清洗后的数据
  • 可以合并两次请求的结果来获得完整的频道信息

[English]

Purpose:

  • Get YouTube channel description information (subscribers, videos, views, creation date, social links, etc.)

Important - Two requests required for complete data:

  • First request (with channel_id): Returns basic info (title, description, subscribers, videos, avatar, banner, etc.)
  • Second request (with continuation_token): Returns advanced info (creation date, social media links, country, view count, etc.)

How to get channel_id:

  • If you only have channel URL (e.g., https://www.youtube.com/@CozyCraftYT), call get_channel_id endpoint first
  • It will return channel_id like UCeu6U67OzJhV1KwBansH3Dg

Parameters:

📌 Required (choose one):

channel_id (string)

  • Purpose: Channel ID for first request to get basic channel info
  • Format: Usually starts with UC, 24 characters
  • Example: "UCeu6U67OzJhV1KwBansH3Dg"
  • How to get: Call get_channel_id endpoint with channel URL

continuation_token (string)

  • Purpose: Pagination token for second request to get advanced info
  • How to get: Get continuation_token field from first request response
  • Note: Must provide either channel_id or continuation_token

⚙️ Optional:

language_code (string, optional)

  • Purpose: Set language preference
  • 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.

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)

Usage Flow (3 steps for complete data):

  1. Get channel_id: If you only have URL, call get_channel_id?channel_url=https://www.youtube.com/@CozyCraftYT
  2. First request: Use channel_id parameter to get basic info and continuation_token
  3. Second request: Use continuation_token to get advanced info (creation date, social links, etc.)

Response Structure (need_format=true):

First request response (with channel_id):

{
  "channel_id": "UCeu6U67OzJhV1KwBansH3Dg",
  "title": "CozyCraft",
  "handle": "CozyCraftYT",
  "description": "Channel description...",
  "subscriber_count": "98.4K subscribers",
  "video_count": "181 videos",
  "view_count": null,
  "country": null,
  "creation_date": null,
  "links": [],
  "avatar": [{"url": "...", "width": 900, "height": 900}],
  "banner": [{"url": "...", "width": 2560, "height": 424}],
  "keywords": "Minecraft Ambience...",
  "channel_url": "https://www.youtube.com/channel/UCeu6U67OzJhV1KwBansH3Dg",
  "vanity_url": "http://www.youtube.com/@CozyCraftYT",
  "rss_url": "https://www.youtube.com/feeds/videos.xml?channel_id=UCeu6U67OzJhV1KwBansH3Dg",
  "is_family_safe": true,
  "verified": false,
  "has_business_email": false,
  "has_membership": true,
  "continuation_token": "4qmFsgJg..."
}

Second request response (with continuation_token):

{
  "channel_id": "UCeu6U67OzJhV1KwBansH3Dg",
  "title": null,
  "handle": "CozyCraftYT",
  "description": "Full channel description...",
  "subscriber_count": "98.4K subscribers",
  "video_count": "181 videos",
  "view_count": "53,218,926 views",
  "country": "United States",
  "creation_date": "Oct 28, 2022",
  "links": [
    {"name": "Discord", "url": "https://discord.gg/tvuxxcsgSS"},
    {"name": "Twitter", "url": "https://twitter.com/..."}
  ],
  "avatar": [],
  "banner": [],
  "verified": false,
  "has_business_email": true,
  "continuation_token": null
}

Notes:

  • Two requests are required to get complete channel information
  • First request: Get basic info (title, avatar, banner, keywords, rss_url, etc.) and continuation_token
  • Second request: Get advanced info (creation_date, links, view_count, country, etc.)
  • Recommend setting need_format=true for both requests
  • You can merge results from both requests for complete channel info

[示例/Examples]

步骤1 - 获取channel_id(如果只有URL)

GET /youtube_web/get_channel_id?channel_url=https://www.youtube.com/@CozyCraftYT

步骤2 - 第一次请求获取基本信息和continuation_token

GET /youtube_web/get_channel_description?channel_id=UCeu6U67OzJhV1KwBansH3Dg&need_format=true

步骤3 - 第二次请求获取高级信息(使用返回的continuation_token)

GET /youtube_web/get_channel_description?continuation_token=xxx&need_format=true

get/api/v1/youtube/web_v2/get_channel_description

Request

  • Base URL
    https://api.tikhub.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

channel_idstring

频道ID(格式如:UCeu6U67OzJhV1KwBansH3Dg),可通过get_channel_id接口从频道URL获取/Channel ID, can be obtained from channel URL via get_channel_id endpoint

continuation_tokenstring

翻页标志(用于获取频道注册时间等高级信息)/Continuation token for getting advanced info like channel creation date

language_codestring

语言代码(如zh-CN, en-US等)/Language code

country_codestring

国家代码(如US, JP等)/Country code

need_formatboolean

是否需要清洗数据,提取关键内容,移除冗余数据/Whether to clean and format the data

Response

Successful Response

codeinteger

HTTP status code | HTTP状态码

request_idstring nullable

Unique request identifier | 唯一请求标识符

messagestring

Response message (EN-US) | 响应消息 (English)

message_zhstring

Response message (ZH-CN) | 响应消息 (中文)

supportstring

Support message | 支持消息

timestring

The time the response was generated | 生成响应的时间

time_stampinteger

The timestamp the response was generated | 生成响应的时间戳

time_zonestring

The timezone of the response time | 响应时间的时区

docsstring nullable

Link to the API Swagger documentation for this endpoint | 此端点的 API Swagger 文档链接

cache_messagestring nullable

Cache message (EN-US) | 缓存消息 (English)

cache_message_zhstring nullable

Cache message (ZH-CN) | 缓存消息 (中文)

cache_urlstring nullable

The URL to access the cached result | 访问缓存结果的 URL

routerstring

The endpoint that generated this response | 生成此响应的端点

paramsunknown
dataunknown

Changes

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      the response's property default value changed from This request will be cached. You can access the cached result directly using the URL below valid for 24 hours. Accessing the cache will not incur additional charges. to 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. for the status

    • info

      the response's property default value changed from 本次请求将被缓存,你可以使用下面的 URL 直接访问缓存结果,有效期为 24 小时,访问缓存不会产生额外费用。 to 本次响应已缓存,可通过下方 URL 直接查看,有效期 24 小时,访问缓存链接无额外费用。缓存仅用于请求溯源,不影响接口数据的时效性,也不会再次通过接口返回。 for the status