Twitch 频道、剪辑、视频与直播数据 API — 打开交互式演示
引导式在线测试。想要原始接口文档? 查看接口文档 & 测试 →
接口列表
每次调用都会自动附带你的 API Key。
/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。以上字段名来自单次实测,不保证每条片段都有;用游标翻到下一页的行为在实测中没有验证。片段的可用性会随时间变化:返回结果不代表可以下载媒体文件或永久可访问,也不应认为列表包含该频道的全部历史片段。
| 参数 | 位置 | 值 |
|---|---|---|
| query | ||
| 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;有直播时的字段分支没有观察到,这里不做记录,实时状态请通过直播相关接口读取。标识符请按字符串保存,可选的资料字段请保持返回时的原样:字段缺失并不能证明频道已被删除,频道存在也不代表它正在直播。
| 参数 | 位置 | 值 |
|---|---|---|
| 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:展示名可能与频道及直播查询所需的登录名不同。结果在不同调用之间可能变化,也不是完整的频道目录。
| 参数 | 位置 | 值 |
|---|---|---|
| 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 区分两种情况。实测中没有出现正在直播时的完整返回,因此这里不列出直播状态下的字段名,接入前请先用真实开播频道的响应核对再做字段映射。该接口不会录制或下载直播,也不保证持续的直播状态;需要观众数据请使用“获取直播观看人数”,需要分类标签请使用“获取直播标签列表”。
| 参数 | 位置 | 值 |
|---|---|---|
| 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 时没有标签可读,这是有效结果,并不表示频道无效。实测中没有出现正在直播时的完整返回,因此这里不列出标签标识和标签名称的字段名;映射前请先查看真实开播频道的响应,标签标识和名称保持原样存储,不要推测未返回的标签。标签可能随时间变化,之后再展示时也不能证明频道仍在直播;需要开播背景信息请使用“获取直播详情”。
| 参数 | 位置 | 值 |
|---|---|---|
| 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 区分开。该数字表示当前这场直播的观众数量,不同于历史视频的播放量,也不同于频道粉丝总数。接口不提供观众历史或时间序列,请在每条快照上记录你自己的检索时间。
| 参数 | 位置 | 值 |
|---|---|---|
| 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 去重。适用范围:响应反映的是当前可获取的视频记录,并非完整的历史存档;已删除、已过期或受限制的录像可能不会出现。该接口只返回元数据和图片链接,不会下载媒体文件。
| 参数 | 位置 | 值 |
|---|---|---|
| query | ||
| query |
调用成本暂不可用,未假定任何价格。