mirror of
https://github.com/KevinMidboe/moviedb.git
synced 2025-10-29 17:50:25 +00:00
91 lines
2.8 KiB
Markdown
91 lines
2.8 KiB
Markdown
# MovieDB
|
|
|
|
node.js library that makes the interaction with themoviedb.org V3 API easy.
|
|
|
|
## How to install
|
|
|
|
npm install moviedb
|
|
|
|
## How to use
|
|
|
|
Require MovieDB
|
|
|
|
var MovieDB = require('moviedb');
|
|
|
|
Create a MovieDB object with your themoviedb.org API KEY
|
|
|
|
var mdb = new MovieDB('your moviedb api key');
|
|
|
|
Use the api methods as you want, for example:
|
|
|
|
mdb.searchMovie({query: 'Alien' }, function(err, res){
|
|
console.log(res);
|
|
});
|
|
|
|
or
|
|
|
|
|
|
mdb.movieInfo({id: 666}, function(err, res){
|
|
console.log(res);
|
|
});
|
|
|
|
|
|
|
|
## Available methods
|
|
|
|
All themoviedb.org API v3 methods included (I have plans to change this method names, stay tuned):
|
|
|
|
| Method | API url |
|
|
|:-----------:|:------------:|
|
|
| searchMovie | search/movie |
|
|
| searchPerson | search/person |
|
|
| collectionInfo | collection/:id /
|
|
| movieInfo | movie/:id |
|
|
| movieAlternativeTitles | movie/:id/alternative_titles |
|
|
| movieCasts | movie/:id/casts |
|
|
| movieImages | movie/:id/keywords |
|
|
| movieKeywords | movie/:id/keywords |
|
|
| movieReleases | movie/:id/releases |
|
|
| movieTrailers | movue/:id/trailers |
|
|
| movieTranslations | movie/:id/translations |
|
|
| movieSimilar | movie/:id/similar_movies |
|
|
| personInfo | person/:id |
|
|
| personCredits | person/:id/credits |
|
|
| personImages | person/:id/images |
|
|
| miscLatestMovie | latest/movie |
|
|
| miscNowPlaying | movue/now-playing |
|
|
| miscPopularMovies | movie/popular |
|
|
| miscTopRatedMovies | movie/top-rated |
|
|
| miscAddMovieRating | movie/:id/rating |
|
|
| companyInfo | company/:id |
|
|
| companyMovies | company/:id/movies |
|
|
| accountInfo | account |
|
|
| accountFavoriteMovies | account/:id/favorite_movies |
|
|
| accoutRatedMovies | account/:id/rated_movies |
|
|
| accountAddFavorite | account/:id/favorite |
|
|
|
|
## License
|
|
|
|
(The MIT License)
|
|
|
|
Copyright (c) 2012 Dan Zajdband <dan.zajdband@gmail.com>
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining
|
|
a copy of this software and associated documentation files (the
|
|
'Software'), to deal in the Software without restriction, including
|
|
without limitation the rights to use, copy, modify, merge, publish,
|
|
distribute, sublicense, and/or sell copies of the Software, and to
|
|
permit persons to whom the Software is furnished to do so, subject to
|
|
the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be
|
|
included in all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
|
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|