tmdb Documentation Release 0.2 Wesley Bitter Jul 08, 2017 Contents 1 tmdb package 3 1.1 Notes...................................................3 1.2 List of API methods...........................................3 2 tmdb.errors module 163 Python Module Index 165 i ii tmdb Documentation, Release 0.2 Contents: Contents 1 tmdb Documentation, Release 0.2 2 Contents CHAPTER 1 tmdb package Documentation of API methods. Most of these are a 1:1 mapping to the TMDB API. To get started you need an api_key from TMDB, please see the TMDB website for such a key. After you have obtained your api_key you can start querying the API from Python by doing the following simple steps: import tmdb api= tmdb.API(api_key) results= api.search_movie(query="rocky") # Do things with results here Notes • There are several methods currently in the API marked as a get request while they are actually post requests. These do not work currently. • There is currently no caching in the library, it is suggested you do this yourself for now • There is currently no throttling of requests, it is suggested you do this yourself for now List of API methods • tmdb.API.configuration() • tmdb.API.account() • tmdb.API.account_lists() • tmdb.API.account_favorite_movies() 3 tmdb Documentation, Release 0.2 • tmdb.API.account_favorite() • tmdb.API.account_rated_movies() • tmdb.API.account_movie_watchlist() • tmdb.API.account_movie_watchlist() • tmdb.API.authentication_token_new() • tmdb.API.authentication_session_new() • tmdb.API.authentication_guest_session_new() • tmdb.API.certification_movie_list() • tmdb.API.movie_changes() • tmdb.API.person_changes() • tmdb.API.collection() • tmdb.API.collection_images() • tmdb.API.company() • tmdb.API.company_movies() • tmdb.API.credit() • tmdb.API.discover_movie() • tmdb.API.discover_tv() • tmdb.API.find() • tmdb.API.genre_list() • tmdb.API.genre_movies() • tmdb.API.job_list() • tmdb.API.keyword() • tmdb.API.keyword_movies() • tmdb.API.list() • tmdb.API.list_item_status() • tmdb.API.list() • tmdb.API.list_add_item() • tmdb.API.list_remove_item() • tmdb.API.list() • tmdb.API.movie() • tmdb.API.movie_alternative_titles() • tmdb.API.movie_credits() • tmdb.API.movie_images() • tmdb.API.movie_keywords() • tmdb.API.movie_releases() • tmdb.API.movie_trailers() 4 Chapter 1. tmdb package tmdb Documentation, Release 0.2 • tmdb.API.movie_translations() • tmdb.API.movie_similar_movies() • tmdb.API.movie_reviews() • tmdb.API.movie_lists() • tmdb.API.movie_changes() • tmdb.API.movie_latest() • tmdb.API.movie_upcoming() • tmdb.API.movie_now_playing() • tmdb.API.movie_popular() • tmdb.API.movie_top_rated() • tmdb.API.movie_account_states() • tmdb.API.movie_rating() • tmdb.API.network() • tmdb.API.person() • tmdb.API.person_movie_credits() • tmdb.API.person_tv_credits() • tmdb.API.person_combined_credits() • tmdb.API.person_external_ids() • tmdb.API.person_images() • tmdb.API.person_changes() • tmdb.API.person_popular() • tmdb.API.person_latest() • tmdb.API.review() • tmdb.API.search_movie() • tmdb.API.search_collection() • tmdb.API.search_tv() • tmdb.API.search_person() • tmdb.API.search_list() • tmdb.API.search_company() • tmdb.API.search_keyword() • tmdb.API.tv() • tmdb.API.tv_credits() • tmdb.API.tv_external_ids() • tmdb.API.tv_images() • tmdb.API.tv_translations() • tmdb.API.tv_on_the_air() 1.2. List of API methods 5 tmdb Documentation, Release 0.2 • tmdb.API.tv_top_rated() • tmdb.API.tv_popular() • tmdb.API.tv_season() • tmdb.API.tv_season_credits() • tmdb.API.tv_season_external_ids() • tmdb.API.tv_season_images() • tmdb.API.tv_season_episode() • tmdb.API.tv_season_episode_credits() • tmdb.API.tv_season_episode_external_ids() • tmdb.API.tv_season_episode_images() class tmdb.API(api_key) Bases: object account(api, *positional, **params) For more information on return value see official API docs For information about possible exceptions see tmdb.errors documentation. Required Parameters session_id (str)– Usage: >>> api= tmdb.API(api_key) >>> api.account(<parameters>) {u'id': 36, u'include_adult': False, u'iso_3166_1': u'US', u'iso_639_1': u'en', u'name': u'John Doe', u'username': u'johndoe'} account_favorite(api, *positional, **params) For more information on return value see official API docs For information about possible exceptions see tmdb.errors documentation. Required Parameters • favorite (str) – true | false • Required JSON Body (str)– • movie_id (int)– • id (int)– • session_id (str)– Usage: 6 Chapter 1. tmdb package tmdb Documentation, Release 0.2 >>> api= tmdb.API(api_key) >>> api.account_favorite(<parameters>) {u'status_code': 12, u'status_message': u'The item/record was updated successfully'} account_favorite_movies(api, *positional, **params) For more information on return value see official API docs For information about possible exceptions see tmdb.errors documentation. Required Parameters • id (int)– • session_id (str)– Optional Parameters • sort_order (str) – asc | desc • page (int) – Minimum 1, maximum 1000. • language (str) – ISO 639-1 code. • sort_by (str) – Only ‘created_at‘ is currently supported. Usage: >>> api= tmdb.API(api_key) >>> api.account_favorite_movies(<parameters>) {u'page': 1, u'results': [{u'backdrop_path': u'/wrKcSXtHz4LedgEf1aW5e4ZVyHJ.jpg', u'id': 9806, u'original_title': u'The Incredibles', u'poster_path': u'/9k4sgKD79q0MDHSWIqNnHqOfOEV.jpg', u'release_date': u'2004-11-05', u'title': u'The Incredibles', u'vote_average': 8.6, u'vote_count': 46}, {u'backdrop_path': u'/uAVdwu4vEx0TwuC4ewp9RqplKEV.jpg', u'id': 1452, u'original_title': u'Superman Returns', u'poster_path': u'/qpsarVxFcxJxtCK5dAoHLt3365R.jpg', u'release_date': u'2006-06-21', u'title': u'Superman Returns', u'vote_average': 6.6, u'vote_count': 20}, {u'backdrop_path': u'/x9a4Q6Qlgh9Fk1f5z6K4r5OeLd9.jpg', u'id': 8960, u'original_title': u'Hancock', u'poster_path': u'/dsCxSr4w3g2ylhlZg3v5CB5Pid7.jpg', u'release_date': u'2008-07-02', u'title': u'Hancock', u'vote_average': 7.0, u'vote_count': 34}, {u'backdrop_path': u'/oPE44KcuRBKfuE15RD8sC2awh3P.jpg', u'id': 9741, 1.2. List of API methods 7 tmdb Documentation, Release 0.2 u'original_title': u'Unbreakable', u'poster_path': u'/ndb1jugavBmgcfZKrfHXxC0T6al.jpg', u'release_date': u'2000-11-14', u'title': u'Unbreakable', u'vote_average': 7.8, u'vote_count': 25}, {u'backdrop_path': u'/7u3pxc0K1wx32IleAkLv78MKgrw.jpg', u'id': 603, u'original_title': u'The Matrix', u'poster_path': u'/gynBNzwyaHKtXqlEKKLioNkjKgN.jpg', u'release_date': u'1999-03-31', u'title': u'The Matrix', u'vote_average': 9.1, u'vote_count': 249}, {u'backdrop_path': u'/af98P1bc7lJsFjhHOVWXQgNNgSQ.jpg', u'id': 424, u'original_title': u"Schindler's List", u'poster_path': u'/I2lJ7ens7Rzlm3x5HfDbwF3ykh.jpg', u'release_date': u'1993-11-30', u'title': u"Schindler's List", u'vote_average': 8.7, u'vote_count': 41}, {u'backdrop_path': u'/6kVVfNT0auG6fU5SFQ1zbayNWUC.jpg', u'id': 7191, u'original_title': u'Cloverfield', u'poster_path': u'/as01o40tJ2FhtheqeXf7bVZ0EQO.jpg', u'release_date': u'2008-01-16', u'title': u'Cloverfield', u'vote_average': 7.2, u'vote_count': 35}, {u'backdrop_path': u'/6yFoLNQgFdVbA8TZMdfgVpszOla.jpg', u'id': 218, u'original_title': u'The Terminator', u'poster_path': u'/q8ffBuxQlYOHrvPniLgCbmKK4Lv.jpg', u'release_date': u'1984-10-26', u'title': u'The Terminator', u'vote_average': 8.6, u'vote_count': 67}, {u'backdrop_path': u'/8uO0gUM8aNqYLs1OsTBQiXu0fEv.jpg', u'id': 550, u'original_title': u'Fight Club', u'poster_path': u'/2lECpi35Hnbpa4y46JX0aY3AWTy.jpg', u'release_date': u'1999-10-15', u'title': u'Fight Club', u'vote_average': 9.1, u'vote_count': 175}, {u'backdrop_path': u'/siKq2bQo09YGLTiqvKR1pXJ5li9.jpg', u'id': 23483, u'original_title': u'Kick-Ass', u'poster_path': u'/gtfggr5n3ED1neoTqVYmsVCoSS.jpg', u'release_date': u'2010-04-16', u'title': u'Kick-Ass', u'vote_average': 8.3, u'vote_count': 108}, {u'backdrop_path': u'/419GfpzSip2cXf17x8FKIRHSSPK.jpg', u'id': 679, u'original_title': u'Aliens', u'poster_path': u'/qet8RDq99dRteBfSRfGeZeqY9xe.jpg', 8 Chapter 1. tmdb package tmdb Documentation, Release 0.2 u'release_date': u'1986-07-18', u'title': u'Aliens', u'vote_average': 8.8, u'vote_count': 107}, {u'backdrop_path': u'/sCtmAY3DgrFOjlrDh6mP7luUO7t.jpg', u'id': 489, u'original_title': u'Good Will Hunting', u'poster_path': u'/3yHtbRfp32AouPSwYESoJM3cOeQ.jpg', u'release_date': u'1997-12-05', u'title': u'Good Will Hunting', u'vote_average': 8.8, u'vote_count': 32}, {u'backdrop_path': u'/5YF6MwuuKBRKLUE2dz3wetkgxAE.jpg', u'id': 453, u'original_title': u'A Beautiful Mind', u'poster_path': u'/79L8f0qbawvmdXE4ThVstC5sOxP.jpg', u'release_date': u'2001-12-13', u'title': u'A Beautiful Mind', u'vote_average': 8.5, u'vote_count': 28}, {u'backdrop_path': u'/bYtrTSGDqvd2KlHTO78b4Y3S4E9.jpg', u'id': 807, u'original_title': u'Se7en', u'poster_path': u'/zgB9CCTDlXRv50Z70ZI4elJtNEk.jpg', u'release_date': u'1995-09-22', u'title': u'Se7en', u'vote_average': 8.9, u'vote_count': 96}, {u'backdrop_path': u'/6HbOqP1GUElNLdX8Bx2uP542CIP.jpg', u'id': 180, u'original_title': u'Minority Report', u'poster_path': u'/h3lpltSn7Rj1eYTPQO1lYGdw4Bz.jpg', u'release_date': u'2002-06-21', u'title': u'Minority Report', u'vote_average': 8.3, u'vote_count': 34}, {u'backdrop_path': u'/i9A0UMFg1hI2kLyCCwnmSbpT2cd.jpg', u'id': 73, u'original_title': u'American History X', u'poster_path': u'/fXepRAYOx1qC3wju7XdDGx60775.jpg', u'release_date': u'1998-10-30', u'title': u'American History X', u'vote_average': 8.7, u'vote_count': 61}, {u'backdrop_path': u'/5XPPB44RQGfkBrbJxmtdndKz05n.jpg', u'id': 19995, u'original_title': u'Avatar', u'poster_path': u'/s66l83fTQp0FAJsJqY0xUmkamcx.jpg',