streaming-availability

Version:

Streaming Availability API allows getting streaming availability information of movies and series; and querying the list of available shows on streaming services such as Netflix, Disney+, Apple TV, Max and Hulu across 60 countries!

www.movieofthenight.com/about/api

movieofthenight/ts-streaming-availability

159 lines (149 loc) • 37.7 kB

HTML

<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>streaming-availability</title><meta name="description" content="Documentation for streaming-availability"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">streaming-availability</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>streaming-availability</h1></div><div class="tsd-panel tsd-typography"><a id="md:streaming-availability-api-typescript-client" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Streaming Availability API TypeScript Client<a href="#md:streaming-availability-api-typescript-client" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><a href="https://www.npmjs.com/package/streaming-availability" target="_blank" class="external"><img src="https://img.shields.io/npm/v/streaming-availability?style=flat-square&logo=npm&color=blue" alt="npm"></a> <a href="https://movieofthenight.github.io/ts-streaming-availability/" target="_blank" class="external"><img src="https://img.shields.io/badge/tsdoc-reference-blue?style=flat-square" alt="tsdoc"></a> This client can be used in both JavaScript and TypeScript projects; and both in browser and Node environment. Since using this client in browser would expose your API key to the public, it is more secure to use it in server-side applications. Using it in browser is only recommended for personal projects and development purposes. <a id="md:streaming-availability-api" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Streaming Availability API<a href="#md:streaming-availability-api" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>Streaming Availability API allows getting streaming availability information of movies and series; and querying the list of available shows on streaming services such as Netflix, Disney+, Apple TV, Max and Hulu across 60 countries! <a id="md:api-key" class="tsd-anchor"></a><h3 class="tsd-anchor-link">API Key<a href="#md:api-key" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3>To get an instant free subscription to start using the API, you can visit <a href="https://docs.movieofthenight.com/guide/authorization" target="_blank" class="external">our Authorization guide</a>. You can get started with a free plan without giving any payment information, and upgrade to paid plans whenever you like. <a id="md:useful-links" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Useful Links<a href="#md:useful-links" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul> <li> <a href="https://www.movieofthenight.com/about/api" target="_blank" class="external">Official Webpage of the API</a> </li> <li> <a href="https://docs.movieofthenight.com/" target="_blank" class="external">API Documentation</a> </li> <li> <a href="https://www.movieofthenight.com/contact" target="_blank" class="external">Contact Form</a> </li> <li> <a href="https://github.com/movieofthenight/streaming-availability-api" target="_blank" class="external">Main GitHub Repository of the API</a> </li> </ul> <a id="md:features" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Features<a href="#md:features" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul> <li>Query streaming availability info of the movies and series via their TMDb or IMDd ids.</li> <li>Search for movies and series via their titles, genres, keywords, release years on specific streaming services (e.g.: Get all the zombie action movies available on Netflix and Disney+)</li> <li>Order the search results by titles, release year or popularity over different time periods (e.g.: get the all-time most popular movies on Netflix US, get the most popular series in the last 7 days on Amazon Prime and Disney+ in the United Kingdom)</li> <li>Get the list of upcoming & expiring titles</li> <li>Get the daily Top 10 lists</li> <li>Returned streaming availability info includes: <ul> <li>Deep links into the streaming services for movies, series, seasons and episodes,</li> <li>Available video qualities (eg. SD, HD, UHD),</li> <li>Available subtitles and audios,</li> <li>First detection time of the shows on the streaming services,</li> <li>Expiry date of the shows/seasons/episodes on the streaming services,</li> <li>All the available options to stream a show (e.g. via subscription, to buy/rent, for free, available via an addons),</li> <li>Price and currency information for buyable/rentable shows</li> </ul> </li> <li>Channel and addon support (e.g. Apple TV Channels, Hulu Addons, Prime Video Channels)</li> <li>Posters, backdrops, cast & director information, genres, rating and many other details of the shows</li> <li>Output also includes TMDB and IMDb ids for every show</li> </ul> <a id="md:install" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Install<a href="#md:install" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><a id="md:via-npm" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Via NPM<a href="#md:via-npm" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code>npm i streaming-availability </code><button>Copy</button></pre> <blockquote> Requires Node version <code>18.0.0</code> or higher. </blockquote> <a id="md:via-script-tag-from-cdn" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Via Script Tag from CDN<a href="#md:via-script-tag-from-cdn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="html"><script src="https://cdn.jsdelivr.net/gh/movieofthenight/ts-streaming-availability@v4.5.0/bundle.min.js"></script> </code><button type="button">Copy</button></pre> This script creates a global variable at <code>window.streamingAvailability</code> where you can access to the module. <a id="md:usage" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Usage<a href="#md:usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><a id="md:node" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Node<a href="#md:node" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="ts">import * as streamingAvailability from "streaming-availability"; const API_KEY = "<YOUR_API_KEY>"; const client = new streamingAvailability.Client(new streamingAvailability.Configuration({ apiKey: API_KEY })); // Start using the client </code><button type="button">Copy</button></pre> <a id="md:script-tag" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Script Tag<a href="#md:script-tag" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="html"><!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Example</title> </head> <body style="white-space: pre-line"> <script src="https://cdn.jsdelivr.net/gh/movieofthenight/ts-streaming-availability@v4.5.0/bundle.min.js"></script> <script type="module"> const API_KEY = "<YOUR_API_KEY>"; const client = new streamingAvailability.Client(new streamingAvailability.Configuration({ apiKey: API_KEY })); // Start using the client </script> </body> </html> </code><button type="button">Copy</button></pre> <a id="md:examples" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Examples<a href="#md:examples" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>These examples assume that you are running inside a module, since it uses <a href="https://github.com/tc39/proposal-top-level-await" target="_blank" class="external">top level await</a>. In <a href="https://github.com/movieofthenight/ts-streaming-availability/blob/main/examples" target="_blank" class="external">examples</a> folder, you can find sample package setups that you can take as a reference. <a id="md:get-the-godfathers-streaming-availability-info" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Get The Godfather's Streaming Availability Info<a href="#md:get-the-godfathers-streaming-availability-info" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="ts">import * as streamingAvailability from "streaming-availability"; const API_KEY = "<YOUR_API_KEY>"; const client = new streamingAvailability.Client(new streamingAvailability.Configuration({ apiKey: API_KEY })); let show = await client.showsApi.getShow( {id: "tt0068646", country: "us"} ); console.log(show.title); console.log(show.overview); show.streamingOptions["us"].forEach((streamingOption) => { console.log(streamingOption.link); }); </code><button type="button">Copy</button></pre> <a id="md:via-script-tag" class="tsd-anchor"></a><h4 class="tsd-anchor-link">Via Script Tag<a href="#md:via-script-tag" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="html"><!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>The Godfather</title> </head> <body style="white-space: pre-line"> <script src="https://cdn.jsdelivr.net/gh/movieofthenight/ts-streaming-availability@v4.5.0/bundle.min.js"></script> <script type="module"> const API_KEY = "<YOUR_API_KEY>"; const client = new streamingAvailability.Client(new streamingAvailability.Configuration({ apiKey: API_KEY })); let show = await client.showsApi.getShow( {id: "tt0068646", country: "us"} ); document.body.textContent = show.title + "\r\n"; document.body.textContent += show.overview + "\r\n"; show.streamingOptions["us"].forEach((streamingOption) => { document.body.textContent += streamingOption.link + "\r\n"; }); </script> </body> </html> </code><button type="button">Copy</button></pre> <blockquote> Checkout <a href="https://github.com/movieofthenight/ts-streaming-availability/blob/main/examples" target="_blank" class="external">examples</a> folder for the rest of the examples. </blockquote> <a id="md:auto-pagination" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Auto Pagination<a href="#md:auto-pagination" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>This client supports auto-pagination for the paginated endpoints. If you'd like to use auto-pagination, you can call the corresponding auto pagination versions of the functions. An example call without auto pagination: <pre><code class="ts">const searchResult = await client.showsApi.searchShowsByFilters(({ country: "us", catalogs: ["netflix"], genres: ["action"], showType: streamingAvailability.ShowType.Movie, orderBy: "popularity_1year", })); </code><button type="button">Copy</button></pre> An example call with auto pagination that fetches at most 3 pages: <pre><code class="ts">const shows = client.showsApi.searchShowsByFiltersWithAutoPagination({ country: "us", catalogs: ["netflix"], genres: ["action"], showType: streamingAvailability.ShowType.Movie, orderBy: "popularity_1year", }, 3) </code><button type="button">Copy</button></pre> Then you can iterate over the results in the following way: <pre><code class="ts">for await (const show of shows) { // Do something with the show } </code><button type="button">Copy</button></pre> <a id="md:terms--conditions-and-attribution" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Terms & Conditions and Attribution<a href="#md:terms--conditions-and-attribution" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>While the client libraries have MIT licenses, the Streaming Availability API itself has further <a href="https://developers.movieofthenight.com/terms-and-conditions" target="_blank" class="external">Terms & Conditions</a>. Make sure to read it before using the API. Notably, the API requires an attribution to itself, if the data acquired through is made public. You can read further about the attribution requirement on the <a href="https://developers.movieofthenight.com/terms-and-conditions" target="_blank" class="external">Terms & Conditions</a> page. <a id="md:contact-us" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Contact Us<a href="#md:contact-us" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>If you have any questions or need further assistance, please don't hesitate to reach us via <a href="https://www.movieofthenight.com/contact" target="_blank" class="external">our contact form</a>. <a id="md:faq" class="tsd-anchor"></a><h2 class="tsd-anchor-link">FAQ<a href="#md:faq" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul> <li> How often the data is updated? <ul> <li>The data is updated daily.</li> </ul> </li> <li> I run into an issue. How can I get help? <ul> <li>Send us a message via <a href="https://www.movieofthenight.com/contact" target="_blank" class="external">our contact form</a>, and we will get back to you as soon as possible.</li> </ul> </li> <li> API returned me some wrong data. What can I do? <ul> <li>Send us a message with details of your findings. You can reach ous via <a href="https://www.movieofthenight.com/contact" target="_blank" class="external">our contact form</a>. Once we receive the message we will take a look into the problems and fix the data.</li> </ul> </li> <li> I have a request to get a new streaming service supported by the API. <ul> <li>Send us a message via <a href="https://www.movieofthenight.com/contact" target="_blank" class="external">our contact form</a>, and we will get back to you.</li> </ul> </li> <li> I need a client library in another language. <ul> <li>Send us a message via <a href="https://www.movieofthenight.com/contact" target="_blank" class="external">our contact form</a>, and we will get back to you.</li> </ul> </li> </ul> <a id="md:client-libraries" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Client Libraries<a href="#md:client-libraries" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><a href="https://docs.movieofthenight.com/guide/client-libraries" target="_blank" class="external">Click here to see the full list of official client libraries</a> <a id="md:services--countries-supported" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Services & Countries Supported<a href="#md:services--countries-supported" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>We support all the major streaming services across the globe, <a href="https://docs.movieofthenight.com/guide/countries-and-services" target="_blank" class="external">click here to see the full list!</a> </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility">Member Visibility<ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Protected</label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Inherited</label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>External</label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:streaming-availability-api-typescript-client">Streaming Availability API TypeScript Client</a><ul><li><a href="#md:streaming-availability-api">Streaming Availability API</a></li><li><ul><li><a href="#md:api-key">API Key</a></li><li><a href="#md:useful-links">Useful Links</a></li><li><a href="#md:features">Features</a></li></ul></li><li><a href="#md:install">Install</a></li><li><ul><li><a href="#md:via-npm">Via NPM</a></li><li><a href="#md:via-script-tag-from-cdn">Via Script Tag from CDN</a></li></ul></li><li><a href="#md:usage">Usage</a></li><li><ul><li><a href="#md:node">Node</a></li><li><a href="#md:script-tag">Script Tag</a></li></ul></li><li><a href="#md:examples">Examples</a></li><li><ul><li><a href="#md:get-the-godfathers-streaming-availability-info">Get The Godfather's Streaming Availability Info</a></li><li><ul><li><a href="#md:via-script-tag">Via Script Tag</a></li></ul></li></ul></li><li><a href="#md:auto-pagination">Auto Pagination</a></li><li><a href="#md:terms--conditions-and-attribution">Terms & Conditions and Attribution</a></li><li><a href="#md:contact-us">Contact Us</a></li><li><a href="#md:faq">FAQ</a></li><li><a href="#md:client-libraries">Client Libraries</a></li><li><a href="#md:services--countries-supported">Services & Countries Supported</a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg>streaming-availability</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></footer><div class="overlay"></div></body></html>