Reference¶
-
class
conf_auth.
Authentication
¶ Generate ids needed to access user accounts or use write methods.
See more about sessions: https://www.themoviedb.org/documentation/api/sessions
-
guest_session_new
(**kwargs)¶ Generate a guest session id.
A guest session can be used to rate movies without having a registered TMDb user account. You should only generate a single guest session per user (or device) as you will be able to attach the ratings to a TMDb user account in the future. There is also IP limits in place so you should always make sure it’s the end user doing the guest session actions.
If a guest session is not used for the first time within 24 hours, it will be automatically discarded.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fauthentication%2Fguest_session%2Fnew
-
session_new
(request_token, **kwargs)¶ Generate a session id for user based authentication.
A valid session id is required in order to use any of the write methods.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fauthentication%2Fsession%2Fnew
Parameters: request_token – The token generated from token_new()
the user to approve. The token needs to be approved by the user before being used here.
-
token_new
(**kwargs)¶ Generate a valid request token for user based authentication.
A request token is required in order to request a session id. You can generate any number of request tokens but they will expire after 60 minutes. As soon as a valid session id has been created the token will be destroyed.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fauthentication%2Ftoken%2Fnew
-
-
class
conf_auth.
Configuration
¶ Configuration information
See: http://docs.themoviedb.apiary.io/#configuration
-
info
(**kwargs)¶ Get the system wide configuration information.
Some elements of the API require some knowledge of this configuration data. The purpose of this is to try and keep the actual API responses as light as possible. It is recommended you store this data within your application and check for updates every so often.
This method currently holds the data relevant to building image URLs as well as the change key map.
To build an image URL, you will need 3 pieces of data. The base_url, size and file_path. Simply combine them all and you will have a fully qualified URL. Here’s an example URL:
http://d3gtl9l2a4fn1j.cloudfront.net/t/p/w500/8uO0gUM8aNqYLs1OsTBQiXu0fEv.jpg
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fconfiguration
-
-
class
movies.
Collections
(id)¶ Get information about movie collections
See: http://docs.themoviedb.apiary.io/#collections
-
images
(**kwargs)¶ Get all of the images for a particular collection by collection id.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fcollection%2F%7Bid%7D%2Fimages
Parameters: - language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
- include_image_language – (optional) Comma separated ISO 639-1 codes, e.g. ‘en, es’.
- append_to_response – (optional) Any Movies method names, comma separated, e.g. ‘credits, images’.
-
info
(**kwargs)¶ Get the basic collection information for a specific collection id.
You can get the ID needed for this method by making a
Movies.info()
request and paying attention to the belongs_to_collection hash.Movie parts are not sorted in any particular order. If you would like to sort them yourself you can use the provided release_date.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fcollection%2F%7Bid%7D
Parameters: - language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
- append_to_response – (optional) Any Collections method names. E.g. ‘images’
-
-
class
movies.
Companies
(id=0)¶ Get information about movie companies.
See: http://docs.themoviedb.apiary.io/#companies
-
info
(**kwargs)¶ Get the basic information about a movie company.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fcompany%2F%7Bid%7D
Parameters: append_to_response – (optional) Any Collections method names. E.g. ‘movies’
-
movies
(**kwargs)¶ Get the list of movies associated with a particular company.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fcompany%2F%7Bid%7D%2Fmovies
Parameters: - page – (optional) Result page number, e.g. 3.
- language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
- append_to_response – (optional) Any Collections method names. E.g. ‘info’
-
-
class
movies.
Keywords
(id)¶ See: http://docs.themoviedb.apiary.io/#keywords
-
info
(**kwargs)¶ Get the basic information for a specific keyword id.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fkeyword%2F%7Bid%7D
-
movies
(**kwargs)¶ Get the list of movies for a particular keyword by id.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fkeyword%2F%7Bid%7D%2Fmovies
Parameters: - page – (optional) Result page number, e.g. 3.
- language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
-
-
class
movies.
Movies
(id=0)¶ Interact with The Movie Database Movies endpoints
See: http://docs.themoviedb.apiary.io/#movies
-
account_states
(session_id, **kwargs)¶ Get status of whether or not the movie has been rated or added to favourite or watch lists.
A valid session id is required.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fmovie%2F%7Bid%7D%2Faccount_states
Parameters: session_id – A session id as returned from session_new()
-
alternative_titles
(**kwargs)¶ Get the alternative titles for a specific movie id.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fmovie%2F%7Bid%7D%2Falternative_titles
Parameters: - country – (optional) ISO 3166-1 code, e.g. ‘us’. For a list of 3166-1 codes, see http://en.wikipedia.org/wiki/ISO_3166-1
- append_to_response – (optional) Any Movies method names. E.g. ‘credits, images’
-
changes
(**kwargs)¶ Get the changes for a specific movie id.
Changes are grouped by key, and ordered by date in descending order. By default, only the last 24 hours of changes are returned. The maximum number of days that can be returned in a single request is 14. The language is present on fields that are translatable.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fmovie%2F%7Bid%7D%2Fchanges
Parameters: - start_date – (optional) A string in the format ‘YYYY-MM-DD’
- end_date – (optional) Same as start_date
-
credits
(**kwargs)¶ Get the cast and crew information for a specific movie id.
TMDB docs: http://docs.themoviedb.apiary.io/#get-%2F3%2Fmovie%2F%7Bid%7D%2Fcredits
Parameters: append_to_response – (optional) Any Movies method names. E.g. ‘credits, images’
-
images
(**kwargs)¶ Get the images (posters and backdrops) for a specific movie id.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fmovie%2F%7Bid%7D%2Fimages
Parameters: - language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
- include_image_language – (optional) Comma separated ISO 639-1 codes, e.g. ‘en, es’.
- append_to_response – (optional) Any Movies method names, comma separated, e.g. ‘credits, images’.
-
info
(**kwargs)¶ Get the basic movie information for a specific movie id.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fmovie%2F%7Bid%7D
Parameters: - language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
- append_to_response – (optional) Any Movies method names. E.g. ‘credits, images’
-
keywords
(**kwargs)¶ Get the plot keywords for a specific movie id.
TMDB docs: http://docs.themoviedb.apiary.io/#get-%2F3%2Fmovie%2F%7Bid%7D%2Fkeywords
Parameters: append_to_response – (optional) Any Movies method names. E.g. ‘credits, images’
-
latest
(**kwargs)¶ Get the latest movie id.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fmovie%2Flatest
-
lists
(**kwargs)¶ Get the lists that the movie belongs to.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fmovie%2F%7Bid%7D%2Flists
Parameters: - page – (optional) Result page number, e.g. 3.
- language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
- append_to_response – (optional) Any Movies method names. E.g. ‘credits, images’
-
now_playing
(**kwargs)¶ Get the list of movies playing in theatres.
This list refreshes every day. The maximum number of items this list will include is 100.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fmovie%2Fnow_playing
Parameters: - page – (optional) Result page number, e.g. 3.
- language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
-
popular
(**kwargs)¶ Get the list of popular movies on The Movie Database.
This list refreshes every day.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fmovie%2Fpopular
Parameters: - page – (optional) Result page number, e.g. 3.
- language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
-
rating
(rating, session_id=None, guest_session_id=None, **kwargs)¶ Rate a movie.
A valid session id or guest session id is required.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fmovie%2F%7Bid%7D%2Flists
Parameters: - rating – A float
- session_id – A session id as returned from
session_new()
. Required if guest_session_id is not specified. - guest_session_id – A session id as returned from
guest_session_new()
Required if session_id is not specified.
-
releases
(**kwargs)¶ Get the release date by country for a specific movie id.
TMDB docs: http://docs.themoviedb.apiary.io/#get-%2F3%2Fmovie%2F%7Bid%7D%2Freleases
Parameters: append_to_response – (optional) Any Movies method names. E.g. ‘credits, images’
-
reviews
(**kwargs)¶ Get the reviews for a particular movie id.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fmovie%2F%7Bid%7D%2Freviews
Parameters: - page – (optional) Result page number, e.g. 3.
- language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
- append_to_response – (optional) Any Movies method names. E.g. ‘credits, images’
-
similar_movies
(**kwargs)¶ Get the similar movies for a specific movie id.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fmovie%2F%7Bid%7D%2Fsimilar_movies
Parameters: - page – (optional) Result page number, e.g. 3.
- language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
- append_to_response – (optional) Any Movies method names. E.g. ‘credits, images’
-
top_rated
(**kwargs)¶ Get the list of top rated movies.
This list refreshes every day. This list only includes movies that have 10 or more votes.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fmovie%2Ftop_rated
Parameters: - page – (optional) Result page number, e.g. 3.
- language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
-
trailers
(**kwargs)¶ Get the trailers for a specific movie id.
TMDB docs: http://docs.themoviedb.apiary.io/#get-%2F3%2Fmovie%2F%7Bid%7D%2Ftrailers
Parameters: append_to_response – (optional) Any Movies method names. E.g. ‘credits, images’
-
translations
(**kwargs)¶ Get the translations for a specific movie id.
TMDB docs: http://docs.themoviedb.apiary.io/#get-%2F3%2Fmovie%2F%7Bid%7D%2Ftranslations
Parameters: append_to_response – (optional) Any Movies method names. E.g. ‘credits, images’
-
upcoming
(**kwargs)¶ Get the list of upcoming movies.
This list refreshes every day. The maximum number of items this list will include is 100.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fmovie%2Fupcoming
Parameters: - page – (optional) Result page number, e.g. 3.
- language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
-
-
class
movies.
Reviews
(id)¶ Get information about reviews.
See: http://docs.themoviedb.apiary.io/#reviews
-
info
(**kwargs)¶ Get the full details of a review by ID.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Freview%2F%7Bid%7D
-
-
class
tv.
Networks
(id)¶ Information about TV networks.
See: http://docs.themoviedb.apiary.io/#networks
-
info
()¶ Get the basic information about a TV network.
You can use this ID to search for TV shows with the discover.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fnetwork%2F%7Bid%7D
-
-
class
tv.
TV
(id=0)¶ Interact with The Movie Database TV endpoints
See: http://docs.themoviedb.apiary.io/#tv
-
credits
(**kwargs)¶ Get the cast & crew information about a TV series.
Just like on the TMDB website, this information is pulled from the last season of the series.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Ftv%2F%7Bid%7D%2Fcredits
Parameters: - language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
- append_to_response – (optional) Any TV method names. E.g. ‘credits, images’
-
external_ids
(**kwargs)¶ Get the external ids for a TV series.
E.g. IMDB, TVRage, Freebase.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Ftv%2F%7Bid%7D%2Fexternal_ids
Parameters: language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
-
images
(**kwargs)¶ Get the images (posters and backdrops) for a TV series.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Ftv%2F%7Bid%7D%2Fimages
Parameters: - language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
- include_image_language – (optional) Comma separated ISO 639-1 codes, e.g. ‘en, es’.
-
info
(**kwargs)¶ Get the primary information about a TV series by id.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Ftv%2F%7Bid%7D
Parameters: - language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
- append_to_response – (optional) Any TV method names. E.g. ‘credits, images’
-
popular
(**kwargs)¶ Get the list of popular TV shows.
This list refreshes every day.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Ftv%2Fpopular
Parameters: - page – (optional) Result page number, e.g. 3.
- language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
-
top_rated
(**kwargs)¶ Get the list of top rated TV shows.
By default, this list will only include TV shows that have 2 or more votes. This list refreshes every day.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Ftv%2Ftop_rated
Parameters: - page – (optional) Result page number, e.g. 3.
- language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
-
translations
(**kwargs)¶ Get the list of translations that exist for a TV series.
These translations cascade down to the episode level.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Ftv%2F%7Bid%7D%2Ftranslations
-
-
class
tv.
TVEpisodes
(id, season_number, episode_number)¶ Interact with The Movie Database TV episode endpoints
See: http://docs.themoviedb.apiary.io/#tvepisodes
-
credits
(**kwargs)¶ Get the basic movie information for a specific movie id.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fmovie%2F%7Bid%7D
-
external_ids
(**kwargs)¶ Get the basic movie information for a specific movie id.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fmovie%2F%7Bid%7D
Parameters: language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
-
images
(**kwargs)¶ Get the basic movie information for a specific movie id.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fmovie%2F%7Bid%7D
Parameters: language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
-
info
(**kwargs)¶ Get the basic movie information for a specific movie id.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fmovie%2F%7Bid%7D
Parameters: - language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
- append_to_response – (optional) Any Movies method names. E.g. ‘credits, images’
-
-
class
tv.
TVSeasons
(id, season_number)¶ Interact with The Movie Database TV season endpoints
See: http://docs.themoviedb.apiary.io/#tvseasons
-
credits
(**kwargs)¶ Get the cast & crew credits for a TV season.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Ftv%2F%7Bid%7D%2Fseason%2F%7Bseason_number%7D%2Fcredits
-
external_ids
(**kwargs)¶ Get the external ids for a TV season.
E.g. IMDB, TVRage, Freebase.
Parameters: language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
-
images
(**kwargs)¶ Get the images (posters) for a TV season.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Ftv%2F%7Bid%7D%2Fseason%2F%7Bseason_number%7D%2Fimages
Parameters: - language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
- include_image_language – (optional) Comma separated ISO 639-1 codes, e.g. ‘en, es’.
-
info
(**kwargs)¶ Get the primary information about a TV season.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Ftv%2F%7Bid%7D%2Fseason%2F%7Bseason_number%7D
Parameters: - language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
- append_to_response – (optional) Any Movies method names. E.g. ‘credits, images’
-
-
class
people.
Credits
(credit_id)¶ Get full credit details about a person.
See: http://docs.themoviedb.apiary.io/#credits
-
info
(**kwargs)¶ Get the detailed information about a particular credit record.
This is currently only supported with the new credit model found in TV. These ids can be found from any TV credit response as well as the
tv_credits()
andcombined_credits()
methods for people.The episodes object returns a list of episodes and are generally going to be guest stars. The season array will return a list of season numbers. Season credits are credits that were marked with the “add to every season” option in the editing interface and are assumed to be “season regulars”.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fcredit%2F%7Bcredit_id%7D
Parameters: language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
-
-
class
people.
Jobs
¶ Interact with the Jobs endpoint.
See: http://docs.themoviedb.apiary.io/#jobs
-
list
(**kwargs)¶ Get a list of valid jobs.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fjob%2Flist
-
-
class
people.
People
(id=0)¶ Get information about people in Movies and TV Shows.
See: http://docs.themoviedb.apiary.io/#people
-
changes
(**kwargs)¶ Get the changes for a specific person id.
Changes are grouped by key, and ordered by date in descending order. By default, only the last 24 hours of changes are returned. The maximum number of days that can be returned in a single request is 14. The language is present on fields that are translatable.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fperson%2F%7Bid%7D%2Fchanges
Parameters: - start_date – (optional) A string in the format ‘YYYY-MM-DD’
- end_date – (optional) Same as start_date
-
combined_credits
(**kwargs)¶ Get the combined (movie and TV) credits for a specific person id.
To get the expanded details for each TV record, call the
Credits.info()
method with the provided credit_id. This will provide details about which episode and/or season the credit is for.TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fperson%2F%7Bid%7D%2Fcombined_credits
Parameters: - language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
- append_to_response – (optional) Any People method names. E.g. ‘credits, images’
-
images
()¶ Get the images for a specific person id.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fperson%2F%7Bid%7D%2Fimages
-
info
(**kwargs)¶ Get the general person information for a specific id.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fperson%2F%7Bid%7D
Parameters: append_to_response – (optional) Any People method names. E.g. ‘combined_credits, images’
-
latest
()¶ Get the latest person id.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fperson%2Flatest
Parameters: - page – (optional) Result page number, e.g. 3.
- language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
-
movie_credits
(**kwargs)¶ Get the movie credits for a specific person id.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fperson%2F%7Bid%7D%2Fmovie_credits
Parameters: - language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
- append_to_response – (optional) Any People method names. E.g. ‘credits, images’
-
popular
(**kwargs)¶ Get the list of popular people on The Movie Database.
This list refreshes every day. The maximum number of items this list will include is 100.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fperson%2Fpopular
Parameters: - page – (optional) Result page number, e.g. 3.
- language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
-
tv_credits
(**kwargs)¶ Get the TV credits for a specific person id.
To get the expanded details for each record, call the
Credits.info()
method with the provided credit_id. This will provide details about which episode and/or season the credit is for.TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fperson%2F%7Bid%7D%2Ftv_credits
Parameters: - language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
- append_to_response – (optional) Any People method names. E.g. ‘credits, images’
-
-
class
account.
Account
(session_id)¶ Interact with a The Movie Database user account.
See: http://docs.themoviedb.apiary.io/#account
-
add_movie_watchlist
(movie_id, watchlist, **kwargs)¶ Add or remove a movie to an accounts watch list.
TMDB doc: http://docs.themoviedb.apiary.io/#post-%2F3%2Faccount%2F%7Bid%7D%2Ffavorite_movies
Parameters: - movie_id – The id of the movie to add or remove from watchlist.
- watchlist – Either True to add movie_id to watchlist or False to remove.
-
favorite
(movie_id, favorite, **kwargs)¶ Add or remove a movie to an accounts favorite list.
TMDB doc: http://docs.themoviedb.apiary.io/#post-%2F3%2Faccount%2F%7Bid%7D%2Ffavorite
Parameters: - movie_id – The id of the movie to favorite or unfavorite.
- favorite – Either True to favorite movie_id or False to unfavorite.
-
favorite_movies
(**kwargs)¶ Get the list of favorite movies for an account.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Faccount%2F%7Bid%7D%2Ffavorite_movies
Parameters: - page – (optional) Result page number, e.g. 3.
- language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
- sort_by – (optional) Only ‘created_at` is currently supported.
- sort_order – (optional) Either ‘asc’ or ‘desc’.
-
get_movie_watchlist
(**kwargs)¶ Get the list of movies on an accounts watchlist.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Faccount%2F%7Bid%7D%2Fmovie_watchlist
Parameters: - page – (optional) Result page number, e.g. 3.
- language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
- sort_by – (optional) Only ‘created_at` is currently supported.
- sort_order – (optional) Either ‘asc’ or ‘desc’.
-
info
(**kwargs)¶ Get the basic information for an account.
This method has to be called before calling any other Account methods.
You will need to have a valid session id.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Faccount
-
lists
(**kwargs)¶ Get the lists that you have created and marked as a favorite.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Faccount%2F%7Bid%7D%2Flists
Parameters: - page – (optional) Result page number, e.g. 3.
- language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
-
rated_movies
(**kwargs)¶ Get the list of rated movies (and associated rating) for an account.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Faccount%2F%7Bid%7D%2Frated_movies
Parameters: - page – (optional) Result page number, e.g. 3.
- language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
- sort_by – (optional) Only ‘created_at` is currently supported.
- sort_order – (optional) Either ‘asc’ or ‘desc’.
-
-
class
account.
Lists
(id=0, session_id=0)¶ Get lists and interact with lists.
See: http://docs.themoviedb.apiary.io/#lists
-
add_item
(media_id, **kwargs)¶ Add a new movie to a list that the user created.
A valid session id is required.
TMDB doc: http://docs.themoviedb.apiary.io/#post-%2F3%2Flist%2F%7Bid%7D%2Fadd_item
Parameters: media_id – The id of the item to add.
-
create_list
(name, description, **kwargs)¶ Create a new list.
A valid session id is required.
TMDB doc: http://docs.themoviedb.apiary.io/#post-%2F3%2Flist
Parameters: - name – The name of the list to create.
- description – A description of the list.
- language – (optional) Probably a ISO 639-1 code (Waiting on confirmation from TMDB).
-
delete_list
(**kwargs)¶ Delete a list that the user created.
A valid session id is required.
TMDB doc: http://docs.themoviedb.apiary.io/#delete-%2F3%2Flist%2F%7Bid%7D
-
info
(**kwargs)¶ Get a list by id.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Flist%2F%7Bid%7D
-
item_status
(movie_id, **kwargs)¶ Check to see if a movie ID is already added to a list.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Flist%2F%7Bid%7D%2Fitem_status
Parameters: language – Check to see if this movie ID is already part of a list or not.
-
remove_item
(media_id, **kwargs)¶ Delete a movie from a list that the user created.
A valid session id is required.
TMDB doc: http://docs.themoviedb.apiary.io/#post-%2F3%2Flist%2F%7Bid%7D%2Fremove_item
Parameters: media_id – The id of the item to remove.
-
-
class
changes.
Changes
¶ See: http://docs.themoviedb.apiary.io/#changes
-
movies
(**kwargs)¶ Get a list of movie ids that have been edited.
By default the last 24 hours are shown and only 100 items per page. The maximum number of days that can be returned in a single request is 14. You can then use the movie changes API to get the actual data that has been changed.
Please note: The change log system to support this was changed on October 5, 2012 and will only show movies that have been edited since.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fmovie%2Fchanges
Parameters: - page – (optional) Result page number, e.g. 3.
- start_date – (optional) A string in the format ‘YYYY-MM-DD’.
- end_date – (optional) Same as start_date.
-
persons
(**kwargs)¶ Get a list of person ids that have been edited.
By default the last 24 hours are shown and only 100 items per page. The maximum number of days that can be returned in a single request is 14. You can then use the movie changes API to get the actual data that has been changed.
Please note: The change log system to support this was changed on October 5, 2012 and will only show movies that have been edited since.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fmovie%2Fchanges
Parameters: - page – (optional) Result page number, e.g. 3.
- start_date – (optional) A string in the format ‘YYYY-MM-DD’.
- end_date – (optional) Same as start_date.
-
-
class
search.
Search
¶ Search movies, TV shows, collections, persons, lists, companies and keywords.
See: http://docs.themoviedb.apiary.io/#search
-
collections
(query, **kwargs)¶ Search for collections by name.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fsearch%2Fcollection
Parameters: - query – CGI escaped (URL encoded) string
- page – (optional) Result page number, e.g. 3.
- language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
-
companies
(query, **kwargs)¶ Search for companies by name.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fsearch%2Fcompany
Parameters: - query – CGI escaped (URL encoded) string
- page – (optional) Result page number, e.g. 3.
-
keywords
(query, **kwargs)¶ Search for keywords by name.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fsearch%2Fkeyword
Parameters: - query – CGI escaped (URL encoded) string
- page – (optional) Result page number, e.g. 3.
-
lists
(query, **kwargs)¶ Search for lists by name and description.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fsearch%2Flist
Parameters: - query – CGI escaped (URL encoded) string
- page – (optional) Result page number, e.g. 3.
- include_adult – (optional) Toggle the inclusion of adult titles. Either True or False.
-
movies
(query, **kwargs)¶ Search for movies by title.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fsearch%2Fmovie
Parameters: - query – CGI escaped (URL encoded) string
- page – (optional) Result page number, e.g. 3.
- language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
- include_adult – (optional) Toggle the inclusion of adult titles. Either True or False.
- year – (optional) Only include movies that have this year in their release dates.
- primary_release_year – (optional) Only include movies that have have this year in their primary release dates.
- search_type – (optional) By default, the search type is ‘phrase’. This is almost guaranteed the option you will want. It’s a great all purpose search type and by far the most tuned for every day querying. For those wanting more of an “autocomplete” type search, set this option to ‘ngram’.
-
persons
(query, **kwargs)¶ Search for people by name.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fsearch%2Fperson
Parameters: - query – CGI escaped (URL encoded) string
- page – (optional) Result page number, e.g. 3.
- include_adult – (optional) Toggle the inclusion of adult titles. Either True or False.
- search_type – (optional) By default, the search type is ‘phrase’. This is almost guaranteed the option you will want. It’s a great all purpose search type and by far the most tuned for every day querying. For those wanting more of an “autocomplete” type search, set this option to ‘ngram’.
-
tv
(query, **kwargs)¶ Search for TV shows by title.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fsearch%2Ftv
Parameters: - query – CGI escaped (URL encoded) string
- page – (optional) Result page number, e.g. 3.
- language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
- first_air_date_year – (optional) Filter the results to only match shows that have a air date with with value.
- search_type – (optional) By default, the search type is ‘phrase’. This is almost guaranteed the option you will want. It’s a great all purpose search type and by far the most tuned for every day querying. For those wanting more of an “autocomplete” type search, set this option to ‘ngram’.
-
-
class
discover.
Discover
¶ See: http://docs.themoviedb.apiary.io/#discover
-
movie
(**kwargs)¶ Discover movies by different types of data like average rating, number of votes, genres and certifications.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fdiscover%2Fmovie
Parameters: - page – (optional) Result page number, e.g. 3.
- language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
- sort_by – (optional) Available options are vote_average.desc, vote_average.asc, release_date.desc, release_date.asc, popularity.desc, popularity.asc.
- include_adult – (optional) Toggle the inclusion of adult titles. Expected value is a boolean, True or False.
- year – (optional) Filter the results release dates to matches that include this value.
- primary_release_year – (optional) Filter the results so that only the primary release date year has this value.
- with_genres – (optional) Only include movies with the specified genres. Expected value is an integer (the id of a genre). Multiple values can be specified. Comma separated indicates an ‘AND’ query, while a pipe (|) separated value indicates an ‘OR’.
- vote_count_gte – (optional) Only include movies that are equal to, or have a vote count higher than this value. Expected value is an integer.
- vote_average_gte – (optional) Only include movies that are equal to, or have a higher average rating than this value. Expected value is a float.
- release_date_gte – (optional) The minimum release date to include. Expected format is YYYY-MM-DD.
- release_date_lte – (optional) The maximum release date to include. Expected format is YYYY-MM-DD.
- certification_country – (optional) Only include movies with certifications for a specific country. When this value is specified, certification.lte is required. A ISO 3166-1 is expected.
- certification_lte – (optional) Only include movies with this certification and lower. Expected value is a valid certification for the specificed certification_country.
- with_companies – (optional) Filter movies to include a specific company. Expected value is an integer (the id of a company). They can be comma separated to indicate an ‘AND’ query.
-
tv
(**kwargs)¶ Discover TV shows by different types of data like average rating, number of votes, genres, the network they aired on and air dates.
TMDB doc: http://docs.themoviedb.apiary.io/#get-%2F3%2Fdiscover%2Ftv
Parameters: - page – (optional) Result page number, e.g. 3.
- language – (optional) ISO 639-1 code, e.g. ‘de’. For a list of 639-1 codes, see http://en.wikipedia.org/wiki/ISO_639-1
- sort_by – (optional) Available options are vote_average.desc, vote_average.asc, first_air_date.desc, first_air_date.asc, popularity.desc, popularity.asc.
- first_air_date_year – (optional) Filter the results release dates to matches that include this value. Expected value is a year.
- vote_count.gte – (optional) Only include TV shows that are equal to, or have a vote count higher than this value. Expected value is an integer.
- vote_average.gte – (optional) Only include TV shows that are equal to, or have a higher average rating than this value. Expected value is a float.
- with_genres – (optional) Only include TV shows with the specified genres. Expected value is an integer (the id of a genre). Multiple values can be specified. Comma separated indicates an ‘AND’ query, while a pipe (|) separated value indicates an ‘OR’.
- with_networks – (optional) Filter TV shows to include a specific network. Expected value is an integer (the id of a network). They can be comma separated to indicate an ‘AND’ query.
- first_air_date.gte – (optional) The minimum air date to include. Expected format is YYYY-MM-DD.
- first_air_date.lte – (optional) The maximum air date to include. Expected format is YYYY-MM-DD.
-