流媒体观看平台与片库查询 — 打开交互式演示
引导式在线测试。想要原始接口文档? 查看接口文档 & 测试 →
接口列表
每次调用都会自动附带你的 API Key。
/api/project/streaming-availability/get-changes 查询某国家新上线、已下架、已更新、即将到期和即将上线的影视片库变动
说明
按国家返回流媒体片库的变动记录,每页 25 条,按变动日期排序。change_type 指定变动类型(new 新上线、removed 已下架、updated 已更新、expiring 即将到期、upcoming 即将上线),item_type 指定条目类型(show 为电影和剧集,按接口文档说明还支持 season 和 episode),country 为 ISO 3166-1 alpha-2 国家代码。还可以用 catalogs(最多 32 个平台选择器)、show_type(movie 或 series,仅在 item_type 为 show 时有意义)、order_direction(asc 或 desc)以及包含边界的 from/to Unix 时间戳继续缩小范围。历史类变动的时间窗口必须落在今天到 31 天前之间,未来类变动则必须落在今天到 31 天后之间。include_unknown_dates 只对未来类变动生效,因为历史变动一定带有时间戳。output_language 用于本地化关联的作品记录(en、es、tr、fr)。翻页时把上一次响应中的 nextCursor 作为 cursor 传入,并先做 URL 转义,因为该值可能包含 ? 和 &;首次请求不需要 cursor。响应包含四个顶层字段(均经实际调用确认):changes(本页变动记录)、shows(按作品 id 索引的受影响作品)、hasMore 和 nextCursor。每条变动记录包含 changeType、itemType、showId、showType、streamingOptionType、timestamp(Unix 秒)、link(指向平台内该作品的深度链接)和 service(id、name、homePage、themeColorCode、imageSet)。每个关联作品包含 id、itemType、showType、title、originalTitle、overview、releaseYear、runtime(分钟)、rating、imdbId、tmdbId、genres(id 和 name)、cast、directors、imageSet(竖版海报、横版海报以及多种宽度的横版背景图)和按国家代码索引的 streamingOptions;每个播放选项含 type、link、videoLink、audios、subtitles、availableSince、expiresSoon 以及提供该选项的 service。字段名来自一次实际探测(change_type=new、item_type=show、country=us、catalogs=netflix、show_type=movie),返回了 25 条变动且 hasMore 为 true;其他变动类型和条目类型来自接口文档说明,探测中没有实际调用。
| 参数 | 位置 | 值 |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query |
调用成本暂不可用,未假定任何价格。
/api/project/streaming-availability/get-countries 列出所有支持的国家及其流媒体平台
说明
一次响应返回完整的覆盖范围目录:以 ISO 3166-1 alpha-2 国家代码为键的对象,没有分页参数。一次不带任何参数的实际探测返回了 65 个国家。每个国家对象包含 countryCode、name 和 services。每个平台包含 id(其他接口可将它作为 catalogs 选择器使用)、name、homePage、themeColorCode、imageSet(lightThemeImage、darkThemeImage、whiteImage 三种徽标 URL)、streamingOptionTypes 和 addons。streamingOptionTypes 是由 addon、buy、rent、free、subscription 五个布尔值组成的对象,记录该平台在该国家实际提供哪些播放方式。每个附加频道包含 id、name、homePage、themeColorCode 以及自己的 imageSet;附加频道数量因平台和国家差异很大(实际抽样中从没有到一百多个不等)。output_language(en、es、tr、fr)用于本地化返回的名称。这些平台 id 和附加频道 id 正是片库查询与变动查询可用的 catalogs 选择器,因此先查询这个目录,才能保证筛选条件有效。上述国家集合、字段名和各国平台数量均来自实际调用;接口文档也说明该目录列出受支持的平台及其名称、徽标、支持的播放类型和可用的附加频道。
| 参数 | 位置 | 值 |
|---|---|---|
| query |
调用成本暂不可用,未假定任何价格。
/api/project/streaming-availability/get-country 获取单个国家的流媒体平台、播放类型和附加频道
说明
按路径参数 country-code 中的 ISO 3166-1 alpha-2 国家代码返回单个国家对象,包含 countryCode、name 和 services。使用 us 的实际探测返回了美国,共 20 个平台。每个平台包含 id、name、homePage、themeColorCode、imageSet(lightThemeImage、darkThemeImage、whiteImage 三种徽标 URL)、streamingOptionTypes 和 addons。streamingOptionTypes 是由 addon、buy、rent、free、subscription 五个布尔值组成的对象,可据此判断某个平台在该国家提供租赁、购买、免费套餐还是只有订阅。每个附加频道包含 id、name、homePage、themeColorCode 以及自己的 imageSet。在美国的抽样中,有六个平台带有附加频道,数量从一个到 140 个(Prime Video)不等。output_language(en、es、tr、fr)用于本地化返回的名称。如果已经知道国家,想拿到它的平台 id、播放类型和附加频道 id,用来在查询片库或变动之前校验 catalogs 选择器,就适合使用这个接口。上述字段名和数量均来自针对 us 的实际调用;接口文档也说明该响应列出该国家受支持的平台及其名称、徽标、支持的播放类型和可用的附加频道。
| 参数 | 位置 | 值 |
|---|---|---|
| path | ||
| query |
调用成本暂不可用,未假定任何价格。
/api/project/streaming-availability/get-genres 获取流媒体影视类型列表,含类型 id 与多语言名称
说明
返回用于划分电影和剧集的完整类型列表,响应是一个纯 JSON 数组,每个元素包含字符串 id 和展示名称 name。唯一的输入是可选的查询参数 output_language(en、es、tr 或 fr,默认 en),用来指定输出语言。一次使用默认参数的示例调用返回 HTTP 200,根节点是包含 21 个条目的数组,每个条目只有 id(例如 scifi、thriller)和 name(例如 Science Fiction、Thriller)两个字段,没有外层对象,也没有游标或分页字段。这里返回的 id 正是按条件搜索片库接口 genres 参数可接受的取值,因此这份列表就是类型筛选的词表。示例调用只使用了默认语言,所以 es、tr、fr 的翻译名称虽有文档说明,但没有在示例中验证。
| 参数 | 位置 | 值 |
|---|---|---|
| query |
调用成本暂不可用,未假定任何价格。
/api/project/streaming-availability/search-shows-by-filters 按类型、年份、评分和关键词浏览某国家的流媒体片库
说明
在某个国家的流媒体片库中搜索(可限定到指定平台),返回支持游标分页的电影和剧集列表。唯一必填的输入是 country(ISO 3166-1 alpha-2 国家代码)。可选筛选条件包括:catalogs(最多 32 个以逗号分隔的片库选择器,如 netflix、prime.subscription 或 hulu.addon.hbo)、genres 及 genres_relation(and 或 or)、在标题和简介中匹配的 keyword、show_original_language、year_min 和 year_max、rating_min 和 rating_max。排序使用 order_by(original_title、release_date、rating,或四个时间窗口的热度排序)配合 order_direction;series_granularity(show、season 或 episode)决定返回多细的剧集信息,output_language 可选 en、es、tr、fr,cursor 用于获取下一页。文档说明的响应是一个对象,包含 shows 数组、hasMore 标志和 nextCursor 字符串。每个作品包含标题、IMDb 与 TMDb id、上映年份,以及带深度链接、字幕、音轨和画质信息的播放选项。除了请求指定的平台外,每个作品还会列出同一国家内其他平台的可观看信息;其他国家的信息不会出现。每页条数:show_type 为 movie 或 series_granularity 为 show 时是 20 条,series 配合 episode 粒度时是 10 条,其余情况是 15 条。一次示例调用(country 为 us、catalogs 为 netflix、show_type 为 movie、order_by 为 popularity_alltime、series_granularity 为 show)返回 HTTP 200,含 20 个作品,hasMore 为 true,并带有字符串类型的 nextCursor。示例中每个作品包含 itemType、showType、id、imdbId、tmdbId、title、overview、releaseYear、originalTitle、genres、directors、cast、rating、runtime、streamingOptions(以国家代码为键、值为播放选项列表的对象)和 imageSet。每个播放选项包含 service、type、addon、link、videoLink、price、quality、audios、subtitles、expiresSoon、expiresOn 和 availableSince。来源文档的响应示例被截断,且其中的图片链接带有过期信息,因此只有上述示例字段列表应视为已验证。
| 参数 | 位置 | 值 |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query | ||
| query |
调用成本暂不可用,未假定任何价格。
/api/project/streaming-availability/search-shows-by-title 按片名搜索电影和剧集,返回所选国家的流媒体播放选项
说明
按片名关键词搜索电影和剧集,返回匹配影视作品的 JSON 数组,每条结果都附带你所选国家的流媒体上架信息。必填参数有两个:country(ISO 3166-1 alpha-2 国家代码,例如 us,支持的国家可通过 countries 接口查询)和 title(要搜索的片名关键词)。可选参数包括:show_type,用于把搜索限定为某一类作品(示例调用使用的是 movie,不传则同时搜索电影和剧集);output_language(en、es、tr 或 fr,默认 en);series_granularity(show、season 或 episode,默认 show,只对剧集生效,选 show 时返回体最小)。默认最多返回 20 条结果;如果片名完全相同的作品超过 20 部,则返回全部精确匹配项。本接口不支持分页。流媒体信息只包含所请求的国家,而且搜索条件仅有片名和作品类型,因此命中的作品在该国不一定能在线观看。示例调用(country 为 us、title 为 batman、show_type 为 movie、series_granularity 为 show)返回 HTTP 200,根节点是包含 20 个作品对象的数组。每个对象包含 itemType、showType、id、imdbId、tmdbId、title、originalTitle、overview、releaseYear、genres(由 id 和 name 组成的键值对)、directors、cast、rating、imageSet 和 streamingOptions,其中 20 条里有 19 条还带有 runtime。streamingOptions 是以国家代码为键的对象(示例中为 us),其下的播放选项包含 service、type、link、quality、audios、subtitles、expiresSoon 和 availableSince;租赁和购买类选项还有 price 对象(amount、currency、formatted),部分选项另有 expiresOn、videoLink 或 addon。文档中除 movie 这个示例外没有列出 show_type 的其他取值,示例调用也只验证了电影结果。
| 参数 | 位置 | 值 |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query |
调用成本暂不可用,未假定任何价格。
/api/project/streaming-availability/get-show 按内部编号、IMDb 或 TMDb 编号获取单部电影或剧集,并返回全球流媒体上架信息
说明
根据路径中的 id 获取单部作品的详细信息及其流媒体上架情况。id 可以是内部作品编号、IMDb 编号(tt 加数字,例如泰坦尼克号的 tt0120338),也可以是 TMDb 编号:电影写作 movie/<数字>,剧集写作 tv/<数字>(例如 movie/597 或 tv/1396),编号类型会被自动识别。可选的查询参数有 country、output_language 和 series_granularity。country 为 ISO 3166-1 alpha-2 国家代码:不传时返回所有国家的上架信息;传入后只包含该国家,这也是获得更小、更快响应的推荐做法。output_language 支持 en、es、tr 或 fr(默认 en)。series_granularity 支持 show、season 或 episode,只对剧集生效,本接口的默认值是 episode,如果不需要季和集信息,请选择 show。示例调用(id 为 tt0120338、country 为 us、series_granularity 为 show)返回 HTTP 200 和一个 JSON 对象,内容是电影《泰坦尼克号》(内部编号 136),包含 itemType、showType、id、imdbId、tmdbId、title、originalTitle、overview、releaseYear、genres(由 id 和 name 组成的键值对)、directors、cast、rating、runtime、imageSet 和 streamingOptions。streamingOptions 是以国家代码为键的对象(示例中只有 us),其下的选项包含 service、type、link、audios、subtitles、expiresSoon 和 availableSince,多数选项还有 quality;出现过的类型有 subscription、free、rent、buy 和 addon,租赁和购买类选项还带有 price 对象(amount、currency、formatted),部分选项另有 expiresOn 或 videoLink。示例调用没有覆盖的内容包括:TMDb 编号写法、不带 country 的调用,以及文档中给出的 404 错误响应体(带有 message 字段的 JSON 对象)。
| 参数 | 位置 | 值 |
|---|---|---|
| path | ||
| query | ||
| query | ||
| query |
调用成本暂不可用,未假定任何价格。
/api/project/streaming-availability/deprecated 按类型和编号查询作品的旧版接口(已弃用),新项目请使用获取单部作品接口
说明
这是位于 /shows/{type}/{id} 的旧版接口,源规范仅将其标注为 Deprecated(已弃用)。它有两个必填路径参数 type 和 id,均为字符串,没有声明任何查询参数,因此该路径上没有 country、output_language 或 series_granularity 这类控制项。规范没有给出这两个路径参数的说明、可选值或示例。该接口既没有做过示例调用,也没有提供响应示例,所以这里无法说明其返回字段,不要假定它与其他接口一致,使用前请自行验证输出。新接入请使用位于 /shows/{id} 的获取单部作品接口:它支持内部编号、IMDb 编号(tt 加数字)或 TMDb 编号(movie/<数字> 或 tv/<数字>),并增加了可选的 country、output_language 和 series_granularity 参数。保留这个条目主要是为了让现有调用方能认出旧路径,并据此规划迁移。
| 参数 | 位置 | 值 |
|---|---|---|
| path | ||
| path |
调用成本暂不可用,未假定任何价格。