Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/worr/node-imdb-api
A non-scraping, functional node.js interface to imdb (mirror of gitlab.com/worr/node-imdb-api)
https://github.com/worr/node-imdb-api
api-client imdb javascript omdb omdb-api-consumer typescript
Last synced: 3 months ago
JSON representation
A non-scraping, functional node.js interface to imdb (mirror of gitlab.com/worr/node-imdb-api)
- Host: GitHub
- URL: https://github.com/worr/node-imdb-api
- Owner: worr
- Created: 2012-09-03T02:20:35.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2023-03-05T15:26:12.000Z (over 1 year ago)
- Last Synced: 2024-07-18T15:29:24.588Z (4 months ago)
- Topics: api-client, imdb, javascript, omdb, omdb-api-consumer, typescript
- Language: TypeScript
- Homepage: https://gitlab.com/worr/node-imdb-api
- Size: 2.97 MB
- Stars: 336
- Watchers: 9
- Forks: 51
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# node-imdb-api
A non-scraping, functional node.js interface to imdb
# Badges
[](http://badge.fury.io/js/imdb-api) [](https://gitlab.com/worr/node-imdb-api/-/commits/master) [](https://david-dm.org/worr/node-imdb-api) [](https://gitlab.com/worr/node-imdb-api/-/commits/master) [](https://gitter.im/worr/node-imdb-api?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
# Github / Gitlab
[Gitlab](https://gitlab.com/worr/node-imdb-api) is the official upstream, and
commits are mirrored to [Github](https://github.com/worr/node-imdb-api). I look
at issues and PRs/MRs on both. Feel free to contribute on either.
# API Docs
[API docs are now here](https://docs.worrbase.com/node/imdb-api/)
# Use
Import the library using `require`
```js
const imdb = require('imdb-api')
```
or ES6 `import`
```js
import imdb from 'imdb-api'
```
Call `get` to get a single movie
```js
imdb.get({name: 'The Toxic Avenger'}, {apiKey: 'foo', timeout: 30000}).then(console.log).catch(console.log);
Movie {
title: 'The Toxic Avenger',
...
}
```
Furthermore if you already know the id you can call `get` with different args:
```js
imdb.get({id: 'tt0090190'}, {apiKey: 'foo'}).then(console.log);
Movie {
title: 'The Toxic Avenger',
...
}
```
You can search for movies, and get multiple results by using the `search` function.
```js
imdb.search({
name: 'Toxic Avenger'
}, {
apiKey: 'foo'
}).then(console.log).catch(console.log);
```
TV shows have an `episodes` method that you can use to fetch all of the episodes
from that TV series.
```js
imdb.get({name: 'How I Met Your Mother'}, {apiKey: 'foo'}).then((things) => {
return things.episodes()
}).then((eps) => {
console.log(eps);
});
Episode {
season: 2,
name: 'The Scorpion and the Toad',
released: '2006-10-25T07:00:00.000Z',
episode: 2,
rating: '8.3',
imdbid: 'tt0869673' },
...
```
# Using a `Client` object
`imdb-api` also exported a `Client` object that you can use to store options for subsequent requests.
```js
import imdb = require('imdb');
const cli = new imdb.Client({apiKey: 'xxxxxx'});
cli.get({'name': 'The Toxic Avenger'}).then(console.log);
```
`Client` also has a `search` method for searching.
```js
import imdb = require('imdb');
const cli = new imdb.Client({apiKey: 'xxxxxx'});
cli.search({'name': 'The Toxic Avenger'}).then((search) => {
for (const result of search.results) {
console.log(result.title);
}
});
```
# FAQ
## I see an API key in your examples? Is it required? How do I get one?
Yes, it is required! omdb made this a requirement as of May 8, 2017. This is unfortunate,
but totally understandable. While I plan on working on finding an alternative to provide
the movie info you crave, I've enabled you to pass in an apikey.
You can get one by going [here](https://www.patreon.com/posts/api-is-going-10743518).
## Why? There are like 3 other interfaces to imdb in npm
Most of them scrape imdb. imdb explicitly forbids scraping.
And what happens when the site layout changes? Well then your screen scraping
solution fails in interesting ways. Screen scraping is also pretty slow,
and we can't have that.
## WOAH I looked at your code and you're using unofficial APIs!
There isn't an official API to imdb. As soon as one is released (and I
notice), I'll update the module.
imdb DOES release all of their data in text files nightly, so unofficial sites
have popped up providing RESTful APIs against that data.
I have to use a few, since none of them are complete.
## What if one of the unofficial APIs disappears?
File a bug. I'll get creative.