streaming-availability
TypeScript icon, indicating that this package has built-in type declarations

4.2.0 • Public • Published

Streaming Availability API TypeScript Client

npm tsdoc

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.

Streaming Availability API

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 59 countries!

API Key

To get an instant free subscription to start using the API, you can visit the RapidAPI page of the API.

With a free subscription, you can send 100 requests per day. To send more requests, you can upgrade to paid plans whenever you like.

Useful Links

Features

  • Query streaming availability info of the movies and series via their TMDb or IMDd ids.
  • 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+)
  • 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)
  • Returned streaming availability info includes:
    • Deep links into the streaming services for movies, series, seasons and episodes,
    • Available video qualities (eg. SD, HD, UHD),
    • Available subtitles and audios,
    • First detection time of the shows on the streaming services,
    • Expiry date of the shows/seasons/episodes on the streaming services,
    • All the available options to stream a show (e.g. via subscription, to buy/rent, for free, available via an addons),
    • Price and currency information for buyable/rentable shows
  • Channel and addon support (e.g. Apple TV Channels, Hulu Addons, Prime Video Channels)
  • Posters, backdrops, cast & director information, genres, rating and many other details of the shows
  • Output also includes TMDB and IMDb ids for every show

Install

Via NPM

npm i streaming-availability

Requires Node version 18.0.0 or higher.

Via Script Tag from CDN

<script src="https://cdn.jsdelivr.net/gh/movieofthenight/ts-streaming-availability@v4.2.0/bundle.min.js"></script>

This script creates a global variable at window.streamingAvailability where you can access to the module.

Usage

Node

import * as streamingAvailability from "streaming-availability";

const RAPID_API_KEY = "<YOUR_RAPID_API_KEY>";

const client = new streamingAvailability.Client(new streamingAvailability.Configuration({
	apiKey: RAPID_API_KEY
}));

// Start using the client

Script Tag

<!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.2.0/bundle.min.js"></script>
	<script type="module">
		const RAPID_API_KEY = "<YOUR_RAPID_API_KEY>";

		const client = new streamingAvailability.Client(new streamingAvailability.Configuration({
			apiKey: RAPID_API_KEY
		}));

		// Start using the client
	</script>
</body>
</html>

Examples

These examples assume that you are running inside a module, since it uses top level await.

In examples folder, you can find sample package setups that you can take as a reference.

Get The Godfather's Streaming Availability Info

import * as streamingAvailability from "streaming-availability";

const RAPID_API_KEY = "<YOUR_RAPID_API_KEY>";

const client = new streamingAvailability.Client(new streamingAvailability.Configuration({
	apiKey: RAPID_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);
});

Via Script Tag

<!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.2.0/bundle.min.js"></script>
	<script type="module">
		const RAPID_API_KEY = "<YOUR_RAPID_API_KEY>";

		const client = new streamingAvailability.Client(new streamingAvailability.Configuration({
			apiKey: RAPID_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>

Checkout examples folder for the rest of the examples.

Auto Pagination

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:

const searchResult = await client.showsApi.searchShowsByFilters(({
	country: "us",
	catalogs: ["netflix"],
	genres: ["action"],
	showType: streamingAvailability.ShowType.Movie,
	orderBy: "popularity_1year",
}));

An example call with auto pagination that fetches at most 3 pages:

const shows = client.showsApi.searchShowsByFiltersWithAutoPagination({
	country: "us",
	catalogs: ["netflix"],
	genres: ["action"],
	showType: streamingAvailability.ShowType.Movie,
	orderBy: "popularity_1year",
}, 3)

Then you can iterate over the results in the following way:

for await (const show of shows) {
	// Do something with the show
}

Terms & Conditions and Attribution

While the client libraries have MIT licenses, the Streaming Availability API itself has further Terms & Conditions. 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 Terms & Conditions page.

Contact Us

If you have any questions or need further assistance, please don't hesitate to reach us via our contact form.

FAQ

  • I run into an issue. How can I get help?

    • If the issue is related to the API itself, please create a post here, and we will help with the issue.
    • If the issue is specific to a client library, then you can create a new issue on the respective repository of the library.
  • API returned me some wrong data. What can I do?

    • Send us a message with details of your findings. You can reach ous via our contact form. Once we receive the message we will take a look into the problems and fix the data.
  • I have a request to get a new streaming service supported by the API.

  • I need a client library in another language.

  • What is RapidAPI?

    • RapidAPI is the world's largest API marketplace. We use RapidAPI to handle the API subscriptions for us. You can instantly subscribe to Streaming Availability on RapidAPI and start using the Streaming Availability API through RapidAPI right away.

Client Libraries

  1. Go
  2. TypeScript/JavaScript

Services Supported

Service Id Service Name Supported Countries
netflix Netflix 58 Countries
prime Prime Video 56 Countries
disney Disney+ 36 Countries
hbo HBO Max 24 Countries
hulu Hulu United States
peacock Peacock United States
paramount Paramount+ 18 Countries
starz Starz United States
apple Apple TV 52 Countries
mubi Mubi 53 Countries
stan Stan Australia
now Now United Kingdom, Ireland, Italy
crave Crave Canada
all4 Channel 4 United Kingdom, Ireland
iplayer BBC iPlayer United Kingdom
britbox BritBox United States, Canada, Australia, South Africa
hotstar Hotstar India, Canada, United Kingdom, Singapore
zee5 Zee5 58 Countries
curiosity Curiosity Stream 57 Countries
wow Wow Germany

Countries Supported

Country Code Country Name
ae United Emirates
ar Argentina
at Austria
au Australia
az Azerbaijan
be Belgium
bg Bulgaria
br Brazil
ca Canada
ch Switzerland
cl Chile
co Colombia
cy Cyprus
cz Czech Republic
de Germany
dk Denmark
ec Ecuador
ee Estonia
es Spain
fi Finland
fr France
gb United Kingdom
gr Greece
hk Hong Kong
hr Croatia
hu Hungary
id Indonesia
ie Ireland
il Israel
in India
is Iceland
it Italy
jp Japan
kr South Korea
lt Lithuania
md Moldova
mk North Macedonia
mx Mexico
my Malaysia
nl Netherlands
no Norway
nz New Zealand
pa Panama
pe Peru
ph Philippines
pl Poland
pt Portugal
ro Romania
rs Serbia
ru Russia
se Sweden
sg Singapore
si Slovenia
th Thailand
tr Turkey
ua Ukraine
us United States
vn Vietnam
za South Africa

Package Sidebar

Install

npm i streaming-availability

Weekly Downloads

184

Version

4.2.0

License

MIT

Unpacked Size

2.7 MB

Total Files

346

Last publish

Collaborators

  • movieofthenight