oc

omdb-client

A node.js and browser client for the http://www.omdbapi.com API.

Showing:

Popularity

Downloads/wk

26

GitHub Stars

5

Maintenance

Last Commit

4yrs ago

Contributors

2

Package

Dependencies

1

Size (min+gzip)

1.0KB

License

ISC

Type Definitions

Tree-Shakeable

No?

Readme

OMDb API Client - The Open Movie Database

A node.js and front-end client for the http://www.omdbapi.com API. The OMDb API is a free web service to obtain movie information, all content and images on the site are contributed and maintained by its users.

Note: This project is unaffiliated with http://www.omdbapi.com.

Build Status

Build Status

Package Availability

Available via NPM:

npm install omdb-client

Available via Bower:

bower install omdb-client

Files in Bower package:

  • omdb-client/dist/omdb-client.js (dev)
  • omdb-client/dist/omdb-client.min.js (release)

Module is exposed using UMD bundle with the name 'omdb'.

API Guide

The API supports two functions:

  • Get (specific detail)
  • Search (broader search)

Get

Get specific movie:

Server-Side

var omdbApi = require('omdb-client');

var params = {
    apiKey: 'XXXXXXX',
    title: 'Terminator',
    year: 2012
}
omdbApi.get(params, function(err, data) {
    // process response...
});

Front-End

var params = {
    apiKey: 'XXXXXXX',
    title: 'Terminator',
    year: 2012
}
window.omdb.get(params, function(err, data) {
    // process response...
});

See more examples.

The following parameters are available for get:

Parameter NameRequiredData TypeValid OptionsDescription
apiKeyyesstringA valid OMDB API key.
idoptional*stringA valid IMDb ID (e.g. tt1285016)
titleoptional*stringMovie title to search for.
typenostringmovie, series, episodeType of result to return.
yearnonumberYear of release.
plotnostringshort, fullReturn short or full plot.
incTomatoesnobooleanInclude Rotten Tomatoes ratings.
timeoutnonumberHTTP request timeout in milliseconds (default is 10 seconds).
  • An id or title must be provided

Search movies:

Server-Side

var omdbApi = require('omdb-client');

var params = {
    apiKey: 'XXXXXXX',
    query: 'Terminator',
    year: 2012
}
omdbApi.search(params, function(err, data) {
    // process response...
});

Front-End

var params = {
    apiKey: 'XXXXXXX',
    query: 'Terminator',
    year: 2012
}
window.omdb.search(params, function(err, data) {
    // process response...
});

See more examples.

The following parameters are available for search:

Parameter NameRequiredData TypeValid OptionsDescription
apiKeyyesstringA valid OMDB API key.
queryyesstringMovie title to search for.
typenostringmovie, series, episodeType of result to return.
yearnonumberYear of release.
plotnostringshort, fullReturn short or full plot.
incTomatoesnobooleanInclude Rotten Tomatoes ratings.
timeoutnonumberHTTP request timeout in milliseconds (default is 10 seconds).
  • An id or title must be provided

Dev Commands:

Contributions are welcome. Be aware that there is a pre-commit hook to check linting and tests.

Run tests:

npm test

Run jshint:

npm run lint

Run test coverage report:

npm run coverage

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100