按登录名获取 Twitch 频道资料与粉丝数

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

按登录名查询某个 Twitch 频道的公开资料信息,适合在获取该频道的片段、视频或直播信息之前先确认频道身份。输入参数:channel(必填)是公开 Twitch 网址中显示的频道登录名,例如 ninja,而不是展示用的标题。以频道 ninja 的一次实测为例:响应使用统一的外层结构 {status, request_id, message, data},status 为 'ok',message 为 null;data.user 包含 id、login、displayName、primaryColorHex、profileImageURL 和 bannerImageURL;followers.totalCount(整数);带有 isPartner 与 isParticipatingDJ 布尔值的 roles;以及 channel 对象,其中有自己的 id、self(isAuthorized、restrictionType)、trailer(video)和 home.preferences.heroPreset。实测时该频道处于离线状态,因此 stream 字段为 null;有直播时的字段分支没有观察到,这里不做记录,实时状态请通过直播相关接口读取。标识符请按字符串保存,可选的资料字段请保持返回时的原样:字段缺失并不能证明频道已被删除,频道存在也不代表它正在直播。

API 功能

登录名换用户 id 把输入的频道登录名解析为 data.user.id 中的 Twitch 用户 id,这样可以保存一个稳定的主键,而不是可能会改变的名称。
一次请求拿到粉丝总数 followers.totalCount 以整数形式返回请求时刻的频道粉丝数,可直接用于报价单、增长曲线和关注名单表格。
头像与横幅素材 同时返回 profileImageURL、bannerImageURL 和 primaryColorHex,仪表盘或机器人无需再发一次请求,就能渲染头像、横幅和品牌主色。
合作伙伴与 DJ 身份标记 roles 对象提供 isPartner 和 isParticipatingDJ 两个布尔值,便于筛选赞助合作候选人,并按身份对频道分组。
频道主页设置 嵌套的 channel 对象返回频道 id、预告片、主页 hero 预设以及实测中观察到的观众授权状态,适合在镜像频道主页配置时参考。

在线 API 演示

GET /api/project/twitch-scraper/get-channel-details

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

查看价格

API 响应 (JSON)

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

使用场景

常见问题

查询频道资料时,channel 应该传什么值?

传公开 Twitch 网址中出现的频道登录名,例如 ninja。带空格、首字母大写的展示名称并不是登录名。如果只知道名字,请先调用「搜索频道」,再使用它返回的登录名。

这个接口能告诉我主播现在是否在直播吗?

不能可靠地判断。实测中频道离线,data.user.stream 为 null,而有直播时的字段分支没有观察到,因此这个接口不记录任何直播字段名。要获取当前的直播信息,请使用直播相关接口;频道存在并不意味着它正在直播。

followers.totalCount 代表什么?

它是请求那一刻该频道粉丝总数的整数值,属于某个时间点的数据,如果想绘制增长曲线,请连同时间戳一起保存。

id 应该当数字还是字符串处理?

请保持为字符串。实测中 data.user.id 返回的就是字符串,建议保留标识符的字符串形式,不要转换成数字。

如果部分资料字段缺失或为空怎么办?

可选的资料字段请保持返回时的原样。元数据缺失并不能说明频道已被删除。实测只覆盖了一个真实存在的频道,所以对于未知的登录名,请对非 ok 状态或缺少 data.user 的情况做好容错处理。

响应中哪些字段能反映合作伙伴状态?

data.user.roles 包含 isPartner 和 isParticipatingDJ 两个布尔值。对频道 ninja 的实测中两者都存在,其他身份标记没有观察到。

使用这个频道信息 API 需要 Twitch 凭证吗?

不需要。你只需要发送本服务的 API 密钥和频道登录名,无需注册 Twitch 应用,也不用生成或刷新 client-credentials 令牌。

相关接口

相关指南

查看订阅方案 →