第一次请求:按登录名查询频道资料
在平台控制台获取你有权使用的 API 密钥,替换示例中的 <API_KEY>。密钥会出现在请求 URL 中,请勿通过公开链接、截图或未经脱敏的日志泄露;正式应用请从服务端发起请求。
示例把 channel 设为公开的频道登录名 ninja,无需 Twitch 账号或额外凭据。你可以换成任意公开频道的登录名;如果只知道主播的名字,请先用频道搜索找回登录名。频道是否正在直播、是否有数据,以每次实际返回为准。打开页面、切换入口、展开面板或复制示例都不会发送数据请求,只有你主动提交才会发起查询。
基础 URL https://api.opendata-api.com
curl -X GET 'https://api.opendata-api.com/api/project/twitch-scraper/get-channel-details?key=<API_KEY>&channel=ninja'import requests
response = requests.request(
"GET",
"https://api.opendata-api.com/api/project/twitch-scraper/get-channel-details",
params={
"key": "<API_KEY>",
"channel": "ninja",
},
timeout=30,
)
response.raise_for_status()
print(response.json())const url = new URL("https://api.opendata-api.com/api/project/twitch-scraper/get-channel-details");
url.search = new URLSearchParams({
"key": "<API_KEY>",
"channel": "ninja",
}).toString();
const response = await fetch(url, {
method: "GET",
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
console.log(await response.json());请求前先了解
- channel 必须填写公开频道网址末尾的登录名,例如 ninja,而不是页面上显示的名称或标题。展示名可能含大小写、空格或中文,与登录名并不一致;只知道名字时,先用频道搜索找回 login,再调用其他接口。
- 频道离线时,直播详情、直播标签和观看人数都会返回成功响应,其中 stream 为 null:表示频道没有在直播,或请求时没有可用的直播数据,不是请求失败。此时没有观看人数和标签,请记为缺失(NULL),不要写成 0 人或空标签;三个接口中只有直播详情会附带离线提示。实测中没有出现开播状态的完整返回,接入前请用一次真实开播频道的响应核对字段名。
- 只有频道剪辑和频道视频支持翻页。首次请求不要传 cursor,之后把响应里页面级(data.user 下)的 cursor 原样传回,并保持 channel 不变。不要使用单条记录上的 cursor 字符串;值缺失或重复出现时就停止翻页,并按记录 id 去重。频道搜索没有翻页参数,想看更多候选请调整关键词。
- 直播详情、直播标签和观看人数都是请求那一刻的快照,不是历史记录或录像,接口也不提供观众人数的时间序列。需要趋势时请自行定时调用,并把检索时间与结果一起保存,同时控制轮询频率。粉丝总数、当前观看人数和视频播放量是三种不同的数字,不要混用。
区分请求状态与查询结果
先检查 HTTP 状态,再检查网关返回的 code、message 和 data 业务状态:HTTP 200 只代表请求到达网关,业务成败以 code 与 message 为准。业务成功后,再读取 data 中 Twitch 数据自带的 status 和 message。频道离线时,三个直播接口仍是成功响应,只是 stream 为 null,应按离线或暂无数据处理,不要当作错误重试,也不要记成 0 人。
按任务选择接口
- 查询频道资料与粉丝数
-
已知频道登录名时使用频道详情:传入 channel,返回用户 id、登录名、展示名、头像素材、粉丝总数与合作伙伴标记,无需额外凭据。拿到的用户 id 也可以作为频道确实存在的依据,再去读取直播相关字段;展示标题不能代替登录名。
- 按名称或关键词找到频道
-
只知道主播名字或关键词时,先用频道搜索传入 query,对照候选结果里的登录名、展示名、简介和粉丝数选定目标,并保存 login 供其他接口使用。该接口没有翻页参数,一次只返回一小批候选;结果不是完整的频道目录,使用前可再用频道详情确认。
- 浏览频道剪辑与往期视频
-
频道剪辑和频道视频都必填 channel 登录名,可选 cursor 用于续页。首次请求不要传 cursor,之后原样传回上一次响应中的页面级续页值,并保持 channel 不变;值缺失或重复时停止,再按 id 去重。两者返回的是元数据和链接,不包含可下载的媒体文件。
- 查看直播状态、标签与观看人数
-
直播详情、直播标签和观看人数都只需要 channel 登录名,返回的是请求时刻的快照。频道离线时 stream 为 null,属于有效结果,其中只有直播详情会附带离线提示。如需先确认频道存在,可先用频道详情取得用户 id;要做趋势分析,请自行定时调用并记录采样时间。
频道内容
/api/project/twitch-scraper/list-channel-clips 按登录名获取 Twitch 频道精彩片段列表
完整文档 →说明
返回某个 Twitch 频道的公开精彩片段(Clips),结果为支持游标翻页的集合,与该频道的视频和直播数据相互独立。输入参数:channel(必填)是公开 Twitch 网址中显示的频道登录名,例如 ninja,而不是展示用的标题;cursor(可选,数字)是同一频道上一次响应返回的续页游标,首次请求时不要传。以频道 ninja 的一次实测为例:响应使用统一的外层结构 {status, request_id, message, data},status 为 'ok',message 为 null;data.user 包含频道 id、一个含 12 条记录的 clips 数组,以及顶层 cursor(实测为整数)。clips 中的每一项形如 {cursor, node},前 11 项的单条 cursor 为 null,最后一项为字符串。每个 node 包含 id、slug、url、embedURL、title、viewCount、language、thumbnailURL、createdAt、durationSeconds 和 isFeatured,并嵌套 curator(id、login、displayName)、game(id、slug、name、boxArtURL)、broadcast(id、startedAt、title)以及 broadcaster(id、login、displayName、profileImageURL、primaryColorHex、roles)对象;champBadge 和 guestStarParticipants 为 null。以上字段名来自单次实测,不保证每条片段都有;用游标翻到下一页的行为在实测中没有验证。片段的可用性会随时间变化:返回结果不代表可以下载媒体文件或永久可访问,也不应认为列表包含该频道的全部历史片段。
仅提交你选择的 Twitch 查询 1 个必填 · 1 个可选
| 参数 | 位置 | 值 |
|---|---|---|
| query |
可选的翻页参数 (1)
| 参数 | 位置 | 值 |
|---|---|---|
| query |
调用成本暂不可用,未假定任何价格。
频道资料
/api/project/twitch-scraper/get-channel-details 按登录名获取 Twitch 频道资料与粉丝数
完整文档 →说明
按登录名查询某个 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;有直播时的字段分支没有观察到,这里不做记录,实时状态请通过直播相关接口读取。标识符请按字符串保存,可选的资料字段请保持返回时的原样:字段缺失并不能证明频道已被删除,频道存在也不代表它正在直播。
仅提交你选择的 Twitch 查询 1 个必填 · 0 个可选
| 参数 | 位置 | 值 |
|---|---|---|
| query |
调用成本暂不可用,未假定任何价格。
频道发现
/api/project/twitch-scraper/search-channels 按名称或关键词搜索 Twitch 频道
完整文档 →说明
按文本搜索公开可发现的 Twitch 频道,返回一份简短的候选列表,帮助你选出想要的频道。输入参数:query(必填)是频道名称或任意搜索文本,例如 ninja。该接口不提供 cursor 或页码参数,响应中也没有游标。以查询词 ninja 的一次实测为例:响应使用统一的外层结构 {status, request_id, message, data},status 为 'ok',message 为 null;data.channels 含 15 条记录,每条形如 {trackingID, item}。每个 item 包含 id、login、displayName、profileImageURL、description(字符串,15 条中有 2 条为 null)、followers.totalCount、roles(isPartner、isParticipatingDJ)、broadcastSettings(id、title)、lastBroadcast(id、startedAt)、channel(id、schedule)、latestVideo.edges[].node(id、title、lengthSeconds 及预览缩略图字段)和 topClip.edges[].node(id、slug、title、durationSeconds、thumbnailURL);self、watchParty 和 channel.schedule 为 null。在这次搜索实测中,item.stream 对一个离线频道为 null,其余 14 个频道为对象,包含 type、viewersCount、game、freeformTags 等字段;这些直播字段只在这次搜索样本中见到,并未在其他接口上验证。请保留返回的 login 和各类 id:展示名可能与频道及直播查询所需的登录名不同。结果在不同调用之间可能变化,也不是完整的频道目录。
仅提交你选择的 Twitch 查询 1 个必填 · 0 个可选
| 参数 | 位置 | 值 |
|---|---|---|
| query |
调用成本暂不可用,未假定任何价格。
直播状态
/api/project/twitch-scraper/get-stream-details 按登录名获取 Twitch 直播间状态与开播详情
完整文档 →说明
按频道登录名查询某个 Twitch 频道当前的直播情况,返回请求时刻的一次快照。输入参数:channel(必填)是公开 Twitch 网址中显示的频道登录名,例如 ninja,而不是展示用的标题。以频道 ninja 离线时的一次实测为例:返回 HTTP 200,使用统一的外层结构 {status, request_id, message, data};status 为 'ok',message 中带有“频道当前处于离线状态”的提示,data.user 包含字符串类型的 id、值为 null 的 stream 以及 __typename 'User'。stream 为 null 表示频道没有在直播,或请求时没有可用的直播数据,这是有效结果而不是请求失败,可结合 status 和 message 区分两种情况。实测中没有出现正在直播时的完整返回,因此这里不列出直播状态下的字段名,接入前请先用真实开播频道的响应核对再做字段映射。该接口不会录制或下载直播,也不保证持续的直播状态;需要观众数据请使用“获取直播观看人数”,需要分类标签请使用“获取直播标签列表”。
仅提交你选择的 Twitch 查询 1 个必填 · 0 个可选
| 参数 | 位置 | 值 |
|---|---|---|
| query |
调用成本暂不可用,未假定任何价格。
直播分类标签
/api/project/twitch-scraper/list-stream-tags 按登录名获取 Twitch 直播标签列表
完整文档 →说明
返回某个 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 时没有标签可读,这是有效结果,并不表示频道无效。实测中没有出现正在直播时的完整返回,因此这里不列出标签标识和标签名称的字段名;映射前请先查看真实开播频道的响应,标签标识和名称保持原样存储,不要推测未返回的标签。标签可能随时间变化,之后再展示时也不能证明频道仍在直播;需要开播背景信息请使用“获取直播详情”。
仅提交你选择的 Twitch 查询 1 个必填 · 0 个可选
| 参数 | 位置 | 值 |
|---|---|---|
| query |
调用成本暂不可用,未假定任何价格。
直播观众指标
/api/project/twitch-scraper/get-stream-viewer-count 按登录名获取 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 时响应中没有观看人数,这是有效结果。实测中没有出现正在直播时的完整返回,因此这里不列出观看人数字段的名称;映射前请先查看真实开播频道的响应,并把“没有数值”与数字 0 区分开。该数字表示当前这场直播的观众数量,不同于历史视频的播放量,也不同于频道粉丝总数。接口不提供观众历史或时间序列,请在每条快照上记录你自己的检索时间。
仅提交你选择的 Twitch 查询 1 个必填 · 0 个可选
| 参数 | 位置 | 值 |
|---|---|---|
| query |
调用成本暂不可用,未假定任何价格。
频道视频
/api/project/twitch-scraper/list-channel-videos 按频道登录名获取 Twitch 频道公开的往期直播回放视频列表
完整文档 →说明
按频道登录名查询某个 Twitch 频道当前可获取的公开视频(往期直播回放)合集。必填参数 channel(例如 ninja);翻页时再传可选的数字型 cursor,该值必须来自同一频道上一次响应返回的继续翻页值。响应统一包装为 {status, request_id, message, data},具体记录位于 data.user 下。 以频道 ninja 做实时探测时观察到:data.user.id(频道 ID)、data.user.videos(每页 12 条 edge)以及 data.user.cursor(整数,第一页为 2),后者是页面级的继续翻页值。每条 edge 包含一个不透明的 cursor 字符串和一个 node,node 内含 id、title、publishedAt(ISO 8601 UTC 时间)、lengthSeconds、viewCount、previewThumbnailURL、animatedPreviewURL、game(id、name、displayName、slug、boxArtURL)、owner(id、login、displayName、profileImageURL、primaryColorHex、roles.isPartner)、self.isRestricted、resourceRestriction 以及 contentTags。在这次探测中,视频按发布时间从新到旧排列,resourceRestriction 为 null,contentTags 为空列表;这两个字段有值时的情况、第二页内容以及合集末尾的表现均未观察到。 翻页方式:第一次请求不要传 cursor,保持 channel 不变,原样使用返回的继续翻页值,当该值缺失或重复出现时停止,并按视频 id 去重。适用范围:响应反映的是当前可获取的视频记录,并非完整的历史存档;已删除、已过期或受限制的录像可能不会出现。该接口只返回元数据和图片链接,不会下载媒体文件。
仅提交你选择的 Twitch 查询 1 个必填 · 1 个可选
| 参数 | 位置 | 值 |
|---|---|---|
| query |
可选的翻页参数 (1)
| 参数 | 位置 | 值 |
|---|---|---|
| query |
调用成本暂不可用,未假定任何价格。
频道、内容与直播数据能力
按频道登录名读取 Twitch 公开数据的 REST/JSON 接口:频道资料、频道搜索、剪辑、往期直播视频,以及某一时刻的直播状态。无需注册 Twitch 开发者应用,也不用自己申请和刷新 OAuth 令牌。
- 频道资料:一次请求取得单个频道的用户 id、登录名、展示名、头像素材、粉丝总数与合作伙伴标记
- 频道搜索:按名称或关键词找到候选频道,并取回后续调用所需的登录名
- 剪辑与视频:支持游标翻页的公开频道剪辑和往期直播视频列表
- 直播状态:直播详情、直播标签与观看人数快照;频道离线时明确返回 null 的 stream,而不是报错
适用于创作者营销名单筛选、电竞与游戏发行商监控、开播通知机器人、直播间叠加层、精彩片段整理与数据分析看板。