Skip to content

πŸŽ₯ Get information, images, rating, description, etc. about a movie.

License

Notifications You must be signed in to change notification settings

lacymorrow/movie-info

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Oct 31, 2023
3875dc9 Β· Oct 31, 2023

History

93 Commits
Feb 27, 2018
Feb 26, 2018
Nov 29, 2022
Feb 3, 2018
Nov 29, 2022
Feb 9, 2018
Dec 12, 2017
Oct 31, 2023
Feb 16, 2018
Feb 13, 2018
Feb 18, 2020
Oct 31, 2023
Nov 29, 2022
Oct 31, 2023

Repository files navigation

Important

This library is considered feature-complete and will only receive updates for bug fixes. You may still create an issue if you have a feature request.

movie-info

npm version Maintainability Try movie-info on RunKit

Fetch information, images, rating, description, etc. about a movie.

movie-info

Features

  • Use anywhere, browser or Node - UMD (Browser Support)
  • Works in React + NextJS client/server (uses isomorphic-fetch)
  • Promise and Callback API
  • Includes:
    • Title
    • Release Date
    • Plot summary overview
    • Poster and backdrop images
    • IMDB rating + vote count
    • Recent popularity rating
    • Adult film (boolean)

Install

Using NPM:

$ npm install movie-info

In the browser:

<!-- movieInfo window global -->
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/movie-info/index.min.js"></script>

(via JSDelivr, or via Unpkg)

Usage

const movieInfo = require('movie-info')

movieInfo('Avatar').then(console.log)
Callbacks
movieInfo('Avatar', function (error, response){
    console.log(response)
})
Search year + Error handling
movieInfo('Oceans Eleven', '1960').then(
    function (response) {
        // success
        console.log(response)
        //=> { ... }
    },
    function (error) {
        // failed
    }
})

From the command line

$ npm install -g movie-info
$ movie-info --help

Usage
  $ movie-info movie [year]

Example
  $ movie-info 'Oceans Eleven' '1960'
  //=> { ... }
Response

Example output:

{
    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: 'http://image.tmdb.org/t/p/original'
}
Images

Combine the image_base with the desired path to create a complete image URL.

const imageUrl = movieInfo('Avatar')
  .then(response => console.log(response.imageBase + response.poster_path))

/* OR */

var imageUrl = response.image_base + response.poster_path
    //=> http://image.tmdb.org/t/p/original/pG8LL4LYMCr5uikhx9rewrW8352.jpg

API

movieInfo(movie [, year ] [, callback])

Returns a Promise which resolves to a movie object.

movie

Required

Type: string

Movie title to search for.

year

Type: string

Movie release year to search for. (optional)

callback(error, result)

Type: function

Callback function. (optional)

Related

License

This package uses data from TMDB. You may consult TMDB terms of service for usage rights.

MIT Β© Lacy Morrow