导入
搜索频道
学习如何使用 Twitch API 搜索频道。
...
频道搜索端点概览
代码示例
1https://api.twitch.tv/helix/search/channels
| 参数 | 类型 | 分类 | 说明 |
|---|---|---|---|
| query | 字符串 | 必需 | 搜索查询内容,必须为 URL 编码的字符串。 |
| after | 字符串 | 可选 | 用于向前分页的游标值。每次该端点返回多页结果时,都会提供一个游标值。将此值放入 after 参数中,可获取游标指定页面之后的结果页。 |
| first | 整数 | 可选 | 每页返回的结果数量,最多 100 条,默认值为 20。 |
| live_only | 布尔值 | 可选 | 是否仅返回当前正在直播的频道。默认值为 false。 |
1import fetch from "node-fetch"; 2 3const endpointUrl = new URL("https://api.twitch.tv/helix/search/channels"); 4 5const headerParameters = { 6 Authorization: "Bearer {{APP_ACCESS_TOKEN}}", 7 "Client-Id": "{{CLIENT_ID}}", 8}; 9 10// 定义搜索查询 11const queryParameters = new URLSearchParams({ 12 query: "twitch", 13}); 14 15const options = { 16 method: "GET", 17 headers: headerParameters, 18}; 19 20async function searchChannels() { 21 try { 22 endpointUrl.search = queryParameters; 23 const response = await fetch(endpointUrl, options); 24 printResponse(response); 25 } catch (error) { 26 printError(error); 27 } 28} 29 30searchChannels();
| 属性 | 类型 | 说明 |
|---|---|---|
| broadcaster_language | 字符串 | 频道直播所用语言的 ISO-639-1 代码。 |
| broadcaster_login | 字符串 | 频道用户的登录名。 |
| display_name | 字符串 | 频道的显示名称。 |
| game_id | 字符串 | 直播时主播正在玩的游戏 ID。如果频道未直播,则为用户上次直播时所玩的游戏 ID。 |
| game_name | 字符串 | 直播时主播正在玩的游戏名称。如果频道未直播,则为用户上次直播时所玩的游戏名称。 |
| id | 字符串 | 频道用户的 ID。 |
| is_live | 布尔值 | 表示频道当前是否正在直播。 |
| tag_ids | 字符串数组 | 应用于该频道的标签 ID 列表。 |
| thumbnail_url | 字符串 | 频道用户头像的静态图片 URL。 |
| title | 字符串 | 当前直播流的标题。如果频道未直播,则为最近一次直播的标题。 |
| started_at | 字符串 | 当前直播流开始的 UTC 时间戳。如果频道未直播,则为空字符串 ""。 |