movie-info
v3.0.3
Published
Get information, images, rating, description, etc. about a movie.
Maintainers
Readme
"Avatar" → { title, poster_path, vote_average, ... }
[!IMPORTANT] This library is feature-complete and only receives bug-fix updates. Feature requests still welcome — please open an issue.
Features
- Use anywhere — browser or Node, UMD bundle (browser support)
- Works in React + Next.js, client and server, via isomorphic-fetch
- Promise and callback API
- Returns title, release date, plot summary, poster + backdrop paths, ratings, vote count, popularity, and more
- Powered by TMDB
Install
npm install movie-infoIn the browser:
<!-- movieInfo as a window global -->
<script src="https://cdn.jsdelivr.net/npm/movie-info/index.min.js"></script>Also available via Unpkg.
Usage
const movieInfo = require("movie-info");
movieInfo("Avatar").then(console.log);
//=> { title: "Avatar", release_date: "2009-12-15", poster_path: "/...", ... }Callback form
movieInfo("Avatar", (error, response) => {
console.log(response);
});Year disambiguation + error handling
movieInfo("Oceans Eleven", "1960").then(
response => console.log(response),
error => console.error("not found:", error),
);[!TIP] Try it live — open in RunKit (here's an example output).
Response shape
{
adult: false,
backdrop_path: "/lhkU86q5cszZkca9MVQLMvUAE6m.jpg",
id: 1640,
original_title: "Crash",
release_date: "2004-09-10",
poster_path: "/pG8LL4LYMCr5uikhx9rewrW8352.jpg",
popularity: 3.30511799781063,
title: "Crash",
vote_average: 6.9,
vote_count: 271,
imageBase: "https://image.tmdb.org/t/p/original"
}Building image URLs
Combine imageBase with any returned *_path field:
const { imageBase, poster_path } = await movieInfo("Avatar");
const url = imageBase + poster_path;
//=> https://image.tmdb.org/t/p/original/pG8LL4LYMCr5uikhx9rewrW8352.jpgAPI
movieInfo(movie [, year ] [, callback])
Returns a Promise that resolves to a movie object.
| Argument | Type | Required | Description |
|---|---|:---:|---|
| movie | string | ✅ | Movie title to search for |
| year | string \| number | | Optional release-year disambiguator |
| callback | (err, result) => void | | Optional Node-style callback |
CLI
npm install --global movie-info
movie-info --help
# Usage
# $ movie-info movie [year]
#
# Example
# $ movie-info 'Oceans Eleven' '1960'
# => { ... }Related
Part of a small family of media-data utilities:
- album-art — Fetch album and artist cover art.
- movie-art — Get the poster art for a movie.
- movie-trailer — Find the trailer for a movie.
Acknowledgments
- TMDB — movie data (subject to the TMDB Terms of Service).
