1.0.0 • Published 6 years ago
lacymorrow-omdb-client v1.0.0
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
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 Name | Required | Data Type | Valid Options | Description |
---|---|---|---|---|
apiKey | yes | string | A valid OMDB API key. | |
id | optional* | string | A valid IMDb ID (e.g. tt1285016) | |
title | optional* | string | Movie title to search for. | |
type | no | string | movie, series, episode | Type of result to return. |
year | no | number | Year of release. | |
plot | no | string | short, full | Return short or full plot. |
incTomatoes | no | boolean | Include Rotten Tomatoes ratings. | |
timeout | no | number | HTTP request timeout in milliseconds (default is 10 seconds). |
- An id or title must be provided
Search
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 Name | Required | Data Type | Valid Options | Description |
---|---|---|---|---|
apiKey | yes | string | A valid OMDB API key. | |
query | yes | string | Movie title to search for. | |
type | no | string | movie, series, episode | Type of result to return. |
year | no | number | Year of release. | |
plot | no | string | short, full | Return short or full plot. |
incTomatoes | no | boolean | Include Rotten Tomatoes ratings. | |
timeout | no | number | HTTP 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
1.0.0
6 years ago