vimdb v4.0.6

vimdb

This package lets you get IMDb information from movies, series, etc without an API key.

⚙️ Installation

In your project root folder, enter the following command in the terminal:

$ yarn add vimdb

or, if you use NPM:

$ npm install vimdb

🤖 Usage

Import the class Imdb in your project and initialize it passing a parameter to specify in what language you want the results. For example, new Imdb('pt-BR') will return results in Brazilian Portuguese.

If no language parameter is specified then the default language will be set to English.

Get a show by ID

// Import the package in your script and initialize the Imdb class
import Imdb from 'vimdb'
const imdb = new Imdb()

// Get the details of the show "The Simpsons"
const show = await imdb.getShow('tt0096697')
console.log(show)

And the response should be something similar to this:

{
    "identifier": "tt0096697",
    "url": "https://www.imdb.com/title/tt0096697",
    "name": "The Simpsons",
    "summary": "The satiric adventures of a working-class family in the misfit city of Springfield.",
    "description": "This is an animated sitcom about the antics of a dysfunctional family. Homer is the oafish unhealthy beer loving father, Marge is the hardworking homemaker wife, Bart is the perpetual ten-year-old underachiever (and proud of it), Lisa is the unappreciated eight-year-old genius, and Maggie is the cute, pacifier loving silent infant.",
    "year": 1989,
    "contentRating": "TV-PG",
    "alternativeName": null,
    "duration": 22,
    "aggregateRating": { "ratingValue": 8.7, "ratingCount": 353617 },
    "genre": [ "Animation", "Comedy" ],
    "image": {
        "small": "https://m.media-amazon.com/images/M/MV5BYjFkMTlkYWUtZWFhNy00M2FmLThiOTYtYTRiYjVlZWYxNmJkXkEyXkFqcGdeQXVyNTAyODkwOQ@@._V1_UX182_CR0,0,182,268_AL_.jpg",
        "big": "https://m.media-amazon.com/images/M/MV5BYjFkMTlkYWUtZWFhNy00M2FmLThiOTYtYTRiYjVlZWYxNmJkXkEyXkFqcGdeQXVyNTAyODkwOQ@@._V1_SY1000_CR0,0,666,1000_AL_.jpg"
    },
    "recommended": [
        { "identifier": "tt0121955", "name": "South Park" },
        { "identifier": "tt0182576", "name": "Family Guy" },
        { "identifier": "tt0149460", "name": "Futurama" },
        { "identifier": "tt0397306", "name": "American Dad!" },
        { "identifier": "tt0462538", "name": "The Simpsons Movie" },
        { "identifier": "tt0412142", "name": "House" },
        { "identifier": "tt2861424", "name": "Rick and Morty" },
        { "identifier": "tt2085059", "name": "Black Mirror" },
        { "identifier": "tt1628033", "name": "Top Gear" },
        { "identifier": "tt0098904", "name": "Seinfeld" },
        { "identifier": "tt3398228", "name": "BoJack Horseman" },
        { "identifier": "tt0367279", "name": "Arrested Development" }
    ]
}

Documentation

For detailed information on how to use this package, please check the API reference for more examples.

🙏🏾 Donations

If you like this project then please consider becoming a sponsor. Your contribution will help me dedicate more time working on bugs and new features for this and other projects.

📝 License

vimdb is released under the MIT License. See LICENSE for details.

👨🏾‍💻 Author

Vinicius Egidio (vinicius.io)