1.0.7 • Published 2 years ago

justwatch-api v1.0.7

Weekly downloads
22
License
ISC
Repository
github
Last release
2 years ago

Unofficial JustWatch API

The justwatch.com API for node js.

Disclaimer

This is not the official JustWatch API. JustWatch doesn't offer an open API and doesn't plan to do this in the future.

The work of many developers went and is still going into the development and maintenance of the data and the API. JustWatch's main business is to operate a streaming guide with apps for iOS and Android. They offer the data for business intelligence and marketing. Therefore it is prohibited to use the API for commercial use (consumer service, data science, business intelligence, etc.). It is ok to use the API for private projects, but please be respectful with your API calls to not put too much load on the API. The API is not supported in any way and will change frequently without warning.

If you would like to work with JustWatch and use the data/API please get in contact with them via info@justwatch.com. Currently, JustWatch can only work with bigger partners and clients. JustWatch is also hiring: https://www.justwatch.com/us/talent and has some interesting open source projects:

Install

npm install --save justwatch-api

API Reference

const JustWatch = require('justwatch-api');

Class: JustWatch

new JustWatch(options)

  • options \ - locale \ The locale to use when performing requests. Default: en_US

jw.request(method, endpoint, params)

  • method \ The HTTP method for the request
  • endpoint \ The API endpoint
  • params \ Parameters to send with the request
  • Returns: \ A promise that resolves to the response

Send a general request to the JustWatch API.

jw.search(options)

  • options \ - query \ the term to search for
  • Returns: \ A promise that resolves to the response

Search for a title.

jw.getProviders()

  • Returns: \ A promise that resolves to the response

Get a list of available providers.

jw.getGenres()

  • Returns: \ A promise that resolves to the response

Get a list of available genres.

jw.getSeasons(season_id)

  • season_id \ The ID of the Season. Can be obtaines from the getTitle('show', {ID of the TV show})
  • Returns: \ A promise that resolves to the response

Get a list of season details and lists all episodes for a given TV show's season

jw.getEpisodes(show_id)

  • show_id \ The ID of the TV show
  • Returns: \ A promise that resolves to the response

Get a list of episodes for a given TV show. For a complete list of episodes for a season, use getSeasons above.

jw.getTitle(content_type, title_id)

  • content_type \ movie or show
  • title_id \ The ID of the title to get
  • Returns: \ A promise that resolves to the response

Gets a specified title

jw.getPerson(person_id)

  • person_id \ the ID of the person to get
  • Returns: \ A promise that resolves to the response

Get a person by their ID.

1.0.7

2 years ago

1.0.6

2 years ago

1.0.5

2 years ago

1.0.4

3 years ago

1.0.3

3 years ago

1.0.2

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago