按登录名获取 Twitch 直播标签列表

查看 Twitch 频道、剪辑、视频与直播数据 API 的全部接口 →

返回某个 Twitch 频道当前直播所带的分类标签,方便你按 Twitch 展示的标签对直播进行分组或筛选。输入参数:channel(必填)是公开 Twitch 网址中显示的频道登录名,例如 ninja,而不是展示用的标题。以频道 ninja 离线时的一次实测为例:返回 HTTP 200,使用统一的外层结构 {status, request_id, message, data};status 为 'ok',message 为 null,data.user 包含字符串类型的 id、值为 null 的 stream 以及 __typename 'User'。stream 为 null 时没有标签可读,这是有效结果,并不表示频道无效。实测中没有出现正在直播时的完整返回,因此这里不列出标签标识和标签名称的字段名;映射前请先查看真实开播频道的响应,标签标识和名称保持原样存储,不要推测未返回的标签。标签可能随时间变化,之后再展示时也不能证明频道仍在直播;需要开播背景信息请使用“获取直播详情”。

API 功能

读取当前直播的标签 传入频道登录名,即可读取该频道当前直播所带的分类标签,直接使用 Twitch 提供的标签名称来搭建直播发现页的分组与筛选。
离线频道返回干净的 null 实测离线频道返回 status 'ok'、message 为 null、data.user.stream 为 null,所以缺少标签集合是一种可以直接渲染的正常状态,不需要靠捕获异常来处理。
标签标识与名称原样保留 响应适合原样存储:标签标识和名称请保持返回的样子,不要自行补造未返回的标签,这样做出的分组才可信。
与其他直播接口输入一致 直播详情、观看人数和直播标签三个接口都只需要频道登录名,并共用 data.user 外层结构,同一个主播名单循环里可以用相同参数依次调用三者。
跟踪不同场次间的标签变化 标签只是请求时刻的快照,不同场次之间可能不同,因此重复轮询可以帮你观察主播如何给自己的内容打标签。

在线 API 演示

GET /api/project/twitch-scraper/list-stream-tags

调用成本暂不可用,未假定任何价格。

查看价格

API 响应 (JSON)

{}
curl -X GET 'https://api.opendata-api.com/api/project/twitch-scraper/list-stream-tags?key=<API_KEY>&channel=ninja'
📢
需要帮助?
如遇接口异常,或需要其他接口需求,可联系我们
联系我们

使用场景

常见问题

为什么标签接口返回 stream 为 null 且没有标签?

对频道 ninja 的实测中频道处于离线状态,data.user.stream 为 null,所以没有标签集合可读。标签集合为空或缺失与频道无效不是一回事,也可能取决于请求时的直播状态或 Twitch 的可用性。

标签的标识和名称分别在哪个字段里?

实测中没有出现正在直播时的完整返回,所以这里不列出确切的字段名。请对正在开播的频道调用一次,查看 data.user.stream,再把其中的标识和名称原样存储。

空的标签列表应该保存为“无标签”吗?

不应该。标签集合为空或缺失,可能只是频道离线,或调用时没有可用的标签。请保存为“未知”或“暂不可用”,以免报表误称该频道没有标签。

标签能说明频道此刻正在直播吗?

不能。标签会随时间变化,你的应用之后再展示时,它并不能证明频道仍在直播。需要确认开播或离线状态时,请搭配“获取直播详情”一起使用。

这个接口也会附带直播详情里的离线提示吗?

不会。实测中该接口的 message 为 null,只有“获取直播详情”会附带频道当前处于离线状态的提示。在这里请以 stream 是否为 null 为准,而不是依赖 message。

channel 应该传什么值?

传公开 Twitch 网址中显示的频道登录名,例如 ninja。如果手上只有展示名称,请先用“搜索频道”接口查找,再沿用结果里返回的登录名。

能用这个接口按标签筛选频道吗?

不能。该接口每次只接收一个频道登录名,返回的是该频道当前直播的标签。如果要按标签筛选或分组,请对自己名单里的每个频道分别调用,再在应用里做筛选。

相关接口

相关指南

查看订阅方案 →