Skip to content

Movies

Bases: TMDB

Movies functionality.

See: https://developers.themoviedb.org/3/movies

Source code in src/tmdb_client_py/movies.py
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
class Movies(TMDB):
    """
    Movies functionality.

    See: https://developers.themoviedb.org/3/movies
    """

    BASE_PATH = "movie"
    URLS = {
        "info": "/{id}",
        "account_states": "/{id}/account_states",
        "alternative_titles": "/{id}/alternative_titles",
        "changes": "/{id}/changes",
        "credits": "/{id}/credits",
        "external_ids": "/{id}/external_ids",
        "images": "/{id}/images",
        "keywords": "/{id}/keywords",
        "lists": "/{id}/lists",
        "recommendations": "/{id}/recommendations",
        "release_dates": "/{id}/release_dates",
        "reviews": "/{id}/reviews",
        "similar_movies": "/{id}/similar_movies",
        "translations": "/{id}/translations",
        "videos": "/{id}/videos",
        "watch_providers": "/{id}/watch/providers",
        "rating": "/{id}/rating",
        "rating_delete": "/{id}/rating",
        "latest": "/latest",
        "now_playing": "/now_playing",
        "popular": "/popular",
        "top_rated": "/top_rated",
        "upcoming": "/upcoming",
        "releases": "/{id}/releases",  # backward compatibility
    }

    def __init__(self, id=0):
        super().__init__()
        self.id = id

    def info(self, **kwargs):
        """
        Get the primary information about a movie.

        Supports append_to_response. Read more about this at
        https://developers.themoviedb.org/3/getting-started/append-to-response.

        Args:
            language: (optional) ISO 639-1 code.
            append_to_response: (optional) Append requests within the same
                namespace to the response.

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_id_path("info")

        response = self._GET(path, kwargs)
        self._set_attrs_to_values(response)
        return response

    def account_states(self, **kwargs):
        """
        Grab the following account states for a session:
            - Movie rating
            - If it belongs to your watchlist
            - If it belongs to your favourite list

        Args:
            session_id: (required) See Authentication.
            guest_session_id: (optional) See Authentication.

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_id_path("account_states")

        response = self._GET(path, kwargs)
        self._set_attrs_to_values(response)
        return response

    def alternative_titles(self, **kwargs):
        """
        Get all of the alternative titles for a movie.

        Args:
            country: (optional) ISO 3166-1 code.

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_id_path("alternative_titles")

        response = self._GET(path, kwargs)
        self._set_attrs_to_values(response)
        return response

    def changes(self, **kwargs):
        """
        Get the changes for a movie. By default only the last 24 hours are returned.

        You can query up to 14 days in a single query by using the start_date
        and end_date query parameters.

        Args:
            start_date: (optional) Filter the results with a start date.
                Expected format is 'YYYY-MM-DD'.
            end_date: (optional) Filter the results with a end date.
                Expected format is 'YYYY-MM-DD'.
            page: (optional) Minimum 1, maximum 1000, default 1.

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_id_path("changes")

        response = self._GET(path, kwargs)
        self._set_attrs_to_values(response)
        return response

    def credits(self, **kwargs):
        """
        Get the cast and crew for a movie.

        Args:
            None

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_id_path("credits")

        response = self._GET(path, kwargs)
        self._set_attrs_to_values(response)
        return response

    def external_ids(self, **kwargs):
        """
        Get the external ids for a movie. We currently support the following
        external sources.

        Media Databases - IMDb
        Social IDs - Facebok, Instagram, Twitter

        Args:
            None

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_id_path("external_ids")

        response = self._GET(path, kwargs)
        self._set_attrs_to_values(response)
        return response

    def images(self, **kwargs):
        """
        Get the images that belong to a movie.

        Querying images with a language parameter will filter the results. If
        you want to include a fallback language (especially useful for
        backdrops) you can use the include_image_language parameter. This
        should be a comma separated value like so:
        include_image_language=en,null.

        Args:
            language: (optional) ISO 639-1 code.
            include_image_language: (optional) Comma separated, a valid
                                    ISO 69-1.

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_id_path("images")

        response = self._GET(path, kwargs)
        self._set_attrs_to_values(response)
        return response

    def keywords(self):
        """
        Get the keywords that have been added to a movie.

        Args:
            None

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_id_path("keywords")

        response = self._GET(path)
        self._set_attrs_to_values(response)
        return response

    def lists(self, **kwargs):
        """
        Get a list of lists that this movie belongs to.

        Args:
            language: (optional) ISO 639-1 code.
            page: (optional) Minimum 1, maximum 1000, default 1.

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_id_path("lists")

        response = self._GET(path, kwargs)
        self._set_attrs_to_values(response)
        return response

    def recommendations(self, **kwargs):
        """
        Get a list of recommended movies for a movie.

        Args:
            language: (optional) ISO 639-1 code.
            page: (optional) Minimum 1, maximum 1000, default 1.

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_id_path("recommendations")

        response = self._GET(path, kwargs)
        self._set_attrs_to_values(response)
        return response

    def release_dates(self, **kwargs):
        """
        Get the release date along with the certification for a movie.

        Release dates support different types:

            1. Premiere
            2. Theatrical (limited)
            3. Theatrical
            4. Digital
            5. Physical
            6. TV

        Args:
            None

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_id_path("release_dates")

        response = self._GET(path, kwargs)
        self._set_attrs_to_values(response)
        return response

    def reviews(self, **kwargs):
        """
        Get the user reviews for a movie.

        Args:
            language: (optional) ISO 639-1 code.
            page: (optional) Minimum 1, maximum 1000, default 1.

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_id_path("reviews")

        response = self._GET(path, kwargs)
        self._set_attrs_to_values(response)
        return response

    def similar_movies(self, **kwargs):
        """
        Get a list of similar movies. This is not the same as the
        "Recommendation" system you see on the website.

        These items are assembled by looking at keywords and genres.

        Args:
            language: (optional) ISO 639-1 code.
            page: (optional) Minimum 1, maximum 1000, default 1.

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_id_path("similar_movies")

        response = self._GET(path, kwargs)
        self._set_attrs_to_values(response)
        return response

    def translations(self, **kwargs):
        """
        Get a list of translations that have been created for a movie.

        Args:
            None

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_id_path("translations")

        response = self._GET(path, kwargs)
        self._set_attrs_to_values(response)
        return response

    def videos(self, **kwargs):
        """
        Get the videos that have been added to a movie.

        Args:
            language: (optional) ISO 639-1 code.

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_id_path("videos")

        response = self._GET(path, kwargs)
        self._set_attrs_to_values(response)
        return response

    def watch_providers(self, **kwargs):
        """
        Get a list of the availabilities per country by provider for movies.

        Args:
            None

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_id_path("watch_providers")

        response = self._GET(path, kwargs)
        self._set_attrs_to_values(response)
        return response

    def rating(self, **kwargs):
        """
        Rate a movie.

        A valid session or guest session ID is required. You can read more
        about how this works at
        https://developers.themoviedb.org/3/authentication/how-do-i-generate-a-session-id.

        Args:
            session_id: (optional) See Authentication.
            guest_session_id: (optional) See Authentication.
            value: (required) This is the value of the rating you want to
                submit. The value is expected to be between 0.5 and 10.0.

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_id_path("rating")

        payload = {
            "value": kwargs.pop("value", None),
        }

        response = self._POST(path, kwargs, payload)
        self._set_attrs_to_values(response)
        return response

    def rating_delete(self, **kwargs):
        """
        Remove your rating for a movie.

        A valid session or guest session ID is required. You can read more
        about how this works at
        https://developers.themoviedb.org/3/authentication/how-do-i-generate-a-session-id.

        Args:
            session_id: (optional) See Authentication.
            guest_session_id: (optional) See Authentication.

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_id_path("rating_delete")

        payload = {
            "value": kwargs.pop("value", None),
        }

        response = self._DELETE(path, kwargs, payload)
        self._set_attrs_to_values(response)
        return response

    def latest(self, **kwargs):
        """
        Get the most newly created movie. This is a live response and will
        continuously change.

        Args:
            language: (optional) ISO 639-1 code.

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_path("latest")

        response = self._GET(path, kwargs)
        self._set_attrs_to_values(response)
        return response

    def now_playing(self, **kwargs):
        """
        Get a list of movies in theatres. This is a release type query that
        looks for all movies that have a release type of 2 or 3 within the
        specified date range.

        You can optionally specify a region parameter which will narrow the
        search to only look for theatrical release dates within the specified
        country.

        Args:
            language: (optional) ISO 639-1 code.
            page: (optional) Minimum 1, maximum 1000, default 1.
            region: (optional) Specify a ISO 3166-1 code to filter release
                dates. Must be uppercase.

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_path("now_playing")

        response = self._GET(path, kwargs)
        self._set_attrs_to_values(response)
        return response

    def popular(self, **kwargs):
        """
        Get a list of the current popular movies on TMDb. This list updates
        daily.

        Args:
            language: (optional) ISO 639-1 code.
            page: (optional) Minimum 1, maximum 1000, default 1.
            region: (optional) Specify a ISO 3166-1 code to filter release
                dates. Must be uppercase.

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_path("popular")

        response = self._GET(path, kwargs)
        self._set_attrs_to_values(response)
        return response

    def top_rated(self, **kwargs):
        """
        Get the top rated movies on TMDb.

        Args:
            language: (optional) ISO 639-1 code.
            page: (optional) Minimum 1, maximum 1000, default 1.
            region: (optional) Specify a ISO 3166-1 code to filter release
                dates. Must be uppercase.

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_path("top_rated")

        response = self._GET(path, kwargs)
        self._set_attrs_to_values(response)
        return response

    def upcoming(self, **kwargs):
        """
        Get a list of upcoming movies in theatres. This is a release type query
        that looks for all movies that have a release type of 2 or 3 within the
        specified date range.

        You can optionally specify a region parameter which will narrow the
        search to only look for theatrical release dates within the specified
        country.

        Args:
            language: (optional) ISO 639-1 code.
            page: (optional) Minimum 1, maximum 1000, default 1.
            region: (optional) Specify a ISO 3166-1 code to filter release
                dates. Must be uppercase.

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_path("upcoming")

        response = self._GET(path, kwargs)
        self._set_attrs_to_values(response)
        return response

    # backward compatibility
    def releases(self, **kwargs):
        """
        Get the release date and certification information by country for a
        specific movie id.

        Args:
            None

        Returns:
            A dict representation of the JSON returned from the API.
        """
        path = self._get_id_path("releases")

        response = self._GET(path, kwargs)
        self._set_attrs_to_values(response)
        return response

account_states(**kwargs)

Parameters:

Name Type Description Default
session_id

(required) See Authentication.

required
guest_session_id

(optional) See Authentication.

required

Returns:

Type Description

A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
def account_states(self, **kwargs):
    """
    Grab the following account states for a session:
        - Movie rating
        - If it belongs to your watchlist
        - If it belongs to your favourite list

    Args:
        session_id: (required) See Authentication.
        guest_session_id: (optional) See Authentication.

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_id_path("account_states")

    response = self._GET(path, kwargs)
    self._set_attrs_to_values(response)
    return response

alternative_titles(**kwargs)

Get all of the alternative titles for a movie.

Parameters:

Name Type Description Default
country

(optional) ISO 3166-1 code.

required

Returns:

Type Description

A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
def alternative_titles(self, **kwargs):
    """
    Get all of the alternative titles for a movie.

    Args:
        country: (optional) ISO 3166-1 code.

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_id_path("alternative_titles")

    response = self._GET(path, kwargs)
    self._set_attrs_to_values(response)
    return response

changes(**kwargs)

Get the changes for a movie. By default only the last 24 hours are returned.

You can query up to 14 days in a single query by using the start_date and end_date query parameters.

Parameters:

Name Type Description Default
start_date

(optional) Filter the results with a start date. Expected format is 'YYYY-MM-DD'.

required
end_date

(optional) Filter the results with a end date. Expected format is 'YYYY-MM-DD'.

required
page

(optional) Minimum 1, maximum 1000, default 1.

required

Returns:

Type Description

A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
def changes(self, **kwargs):
    """
    Get the changes for a movie. By default only the last 24 hours are returned.

    You can query up to 14 days in a single query by using the start_date
    and end_date query parameters.

    Args:
        start_date: (optional) Filter the results with a start date.
            Expected format is 'YYYY-MM-DD'.
        end_date: (optional) Filter the results with a end date.
            Expected format is 'YYYY-MM-DD'.
        page: (optional) Minimum 1, maximum 1000, default 1.

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_id_path("changes")

    response = self._GET(path, kwargs)
    self._set_attrs_to_values(response)
    return response

credits(**kwargs)

Get the cast and crew for a movie.

Returns:

Type Description

A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
def credits(self, **kwargs):
    """
    Get the cast and crew for a movie.

    Args:
        None

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_id_path("credits")

    response = self._GET(path, kwargs)
    self._set_attrs_to_values(response)
    return response

external_ids(**kwargs)

Get the external ids for a movie. We currently support the following external sources.

Media Databases - IMDb Social IDs - Facebok, Instagram, Twitter

Returns:

Type Description

A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
def external_ids(self, **kwargs):
    """
    Get the external ids for a movie. We currently support the following
    external sources.

    Media Databases - IMDb
    Social IDs - Facebok, Instagram, Twitter

    Args:
        None

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_id_path("external_ids")

    response = self._GET(path, kwargs)
    self._set_attrs_to_values(response)
    return response

images(**kwargs)

Get the images that belong to a movie.

Querying images with a language parameter will filter the results. If you want to include a fallback language (especially useful for backdrops) you can use the include_image_language parameter. This should be a comma separated value like so: include_image_language=en,null.

Parameters:

Name Type Description Default
language

(optional) ISO 639-1 code.

required
include_image_language

(optional) Comma separated, a valid ISO 69-1.

required

Returns:

Type Description

A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
def images(self, **kwargs):
    """
    Get the images that belong to a movie.

    Querying images with a language parameter will filter the results. If
    you want to include a fallback language (especially useful for
    backdrops) you can use the include_image_language parameter. This
    should be a comma separated value like so:
    include_image_language=en,null.

    Args:
        language: (optional) ISO 639-1 code.
        include_image_language: (optional) Comma separated, a valid
                                ISO 69-1.

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_id_path("images")

    response = self._GET(path, kwargs)
    self._set_attrs_to_values(response)
    return response

info(**kwargs)

Get the primary information about a movie.

Supports append_to_response. Read more about this at https://developers.themoviedb.org/3/getting-started/append-to-response.

Parameters:

Name Type Description Default
language

(optional) ISO 639-1 code.

required
append_to_response

(optional) Append requests within the same namespace to the response.

required

Returns:

Type Description

A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
def info(self, **kwargs):
    """
    Get the primary information about a movie.

    Supports append_to_response. Read more about this at
    https://developers.themoviedb.org/3/getting-started/append-to-response.

    Args:
        language: (optional) ISO 639-1 code.
        append_to_response: (optional) Append requests within the same
            namespace to the response.

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_id_path("info")

    response = self._GET(path, kwargs)
    self._set_attrs_to_values(response)
    return response

keywords()

Get the keywords that have been added to a movie.

Returns:

Type Description

A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
def keywords(self):
    """
    Get the keywords that have been added to a movie.

    Args:
        None

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_id_path("keywords")

    response = self._GET(path)
    self._set_attrs_to_values(response)
    return response

latest(**kwargs)

Get the most newly created movie. This is a live response and will continuously change.

Parameters:

Name Type Description Default
language

(optional) ISO 639-1 code.

required

Returns:

Type Description

A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
def latest(self, **kwargs):
    """
    Get the most newly created movie. This is a live response and will
    continuously change.

    Args:
        language: (optional) ISO 639-1 code.

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_path("latest")

    response = self._GET(path, kwargs)
    self._set_attrs_to_values(response)
    return response

lists(**kwargs)

Get a list of lists that this movie belongs to.

Parameters:

Name Type Description Default
language

(optional) ISO 639-1 code.

required
page

(optional) Minimum 1, maximum 1000, default 1.

required

Returns:

Type Description

A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
def lists(self, **kwargs):
    """
    Get a list of lists that this movie belongs to.

    Args:
        language: (optional) ISO 639-1 code.
        page: (optional) Minimum 1, maximum 1000, default 1.

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_id_path("lists")

    response = self._GET(path, kwargs)
    self._set_attrs_to_values(response)
    return response

now_playing(**kwargs)

Get a list of movies in theatres. This is a release type query that looks for all movies that have a release type of 2 or 3 within the specified date range.

You can optionally specify a region parameter which will narrow the search to only look for theatrical release dates within the specified country.

Parameters:

Name Type Description Default
language

(optional) ISO 639-1 code.

required
page

(optional) Minimum 1, maximum 1000, default 1.

required
region

(optional) Specify a ISO 3166-1 code to filter release dates. Must be uppercase.

required

Returns:

Type Description

A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
def now_playing(self, **kwargs):
    """
    Get a list of movies in theatres. This is a release type query that
    looks for all movies that have a release type of 2 or 3 within the
    specified date range.

    You can optionally specify a region parameter which will narrow the
    search to only look for theatrical release dates within the specified
    country.

    Args:
        language: (optional) ISO 639-1 code.
        page: (optional) Minimum 1, maximum 1000, default 1.
        region: (optional) Specify a ISO 3166-1 code to filter release
            dates. Must be uppercase.

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_path("now_playing")

    response = self._GET(path, kwargs)
    self._set_attrs_to_values(response)
    return response

popular(**kwargs)

Get a list of the current popular movies on TMDb. This list updates daily.

Parameters:

Name Type Description Default
language

(optional) ISO 639-1 code.

required
page

(optional) Minimum 1, maximum 1000, default 1.

required
region

(optional) Specify a ISO 3166-1 code to filter release dates. Must be uppercase.

required

Returns:

Type Description

A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
def popular(self, **kwargs):
    """
    Get a list of the current popular movies on TMDb. This list updates
    daily.

    Args:
        language: (optional) ISO 639-1 code.
        page: (optional) Minimum 1, maximum 1000, default 1.
        region: (optional) Specify a ISO 3166-1 code to filter release
            dates. Must be uppercase.

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_path("popular")

    response = self._GET(path, kwargs)
    self._set_attrs_to_values(response)
    return response

rating(**kwargs)

Rate a movie.

A valid session or guest session ID is required. You can read more about how this works at https://developers.themoviedb.org/3/authentication/how-do-i-generate-a-session-id.

Parameters:

Name Type Description Default
session_id

(optional) See Authentication.

required
guest_session_id

(optional) See Authentication.

required
value

(required) This is the value of the rating you want to submit. The value is expected to be between 0.5 and 10.0.

required

Returns:

Type Description

A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
def rating(self, **kwargs):
    """
    Rate a movie.

    A valid session or guest session ID is required. You can read more
    about how this works at
    https://developers.themoviedb.org/3/authentication/how-do-i-generate-a-session-id.

    Args:
        session_id: (optional) See Authentication.
        guest_session_id: (optional) See Authentication.
        value: (required) This is the value of the rating you want to
            submit. The value is expected to be between 0.5 and 10.0.

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_id_path("rating")

    payload = {
        "value": kwargs.pop("value", None),
    }

    response = self._POST(path, kwargs, payload)
    self._set_attrs_to_values(response)
    return response

rating_delete(**kwargs)

Remove your rating for a movie.

A valid session or guest session ID is required. You can read more about how this works at https://developers.themoviedb.org/3/authentication/how-do-i-generate-a-session-id.

Parameters:

Name Type Description Default
session_id

(optional) See Authentication.

required
guest_session_id

(optional) See Authentication.

required

Returns:

Type Description

A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
def rating_delete(self, **kwargs):
    """
    Remove your rating for a movie.

    A valid session or guest session ID is required. You can read more
    about how this works at
    https://developers.themoviedb.org/3/authentication/how-do-i-generate-a-session-id.

    Args:
        session_id: (optional) See Authentication.
        guest_session_id: (optional) See Authentication.

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_id_path("rating_delete")

    payload = {
        "value": kwargs.pop("value", None),
    }

    response = self._DELETE(path, kwargs, payload)
    self._set_attrs_to_values(response)
    return response

recommendations(**kwargs)

Get a list of recommended movies for a movie.

Parameters:

Name Type Description Default
language

(optional) ISO 639-1 code.

required
page

(optional) Minimum 1, maximum 1000, default 1.

required

Returns:

Type Description

A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
def recommendations(self, **kwargs):
    """
    Get a list of recommended movies for a movie.

    Args:
        language: (optional) ISO 639-1 code.
        page: (optional) Minimum 1, maximum 1000, default 1.

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_id_path("recommendations")

    response = self._GET(path, kwargs)
    self._set_attrs_to_values(response)
    return response

release_dates(**kwargs)

Get the release date along with the certification for a movie.

Release dates support different types:

1. Premiere
2. Theatrical (limited)
3. Theatrical
4. Digital
5. Physical
6. TV

Returns:

Type Description

A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
def release_dates(self, **kwargs):
    """
    Get the release date along with the certification for a movie.

    Release dates support different types:

        1. Premiere
        2. Theatrical (limited)
        3. Theatrical
        4. Digital
        5. Physical
        6. TV

    Args:
        None

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_id_path("release_dates")

    response = self._GET(path, kwargs)
    self._set_attrs_to_values(response)
    return response

releases(**kwargs)

Get the release date and certification information by country for a specific movie id.

Returns:

Type Description

A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
def releases(self, **kwargs):
    """
    Get the release date and certification information by country for a
    specific movie id.

    Args:
        None

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_id_path("releases")

    response = self._GET(path, kwargs)
    self._set_attrs_to_values(response)
    return response

reviews(**kwargs)

Get the user reviews for a movie.

Parameters:

Name Type Description Default
language

(optional) ISO 639-1 code.

required
page

(optional) Minimum 1, maximum 1000, default 1.

required

Returns:

Type Description

A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
def reviews(self, **kwargs):
    """
    Get the user reviews for a movie.

    Args:
        language: (optional) ISO 639-1 code.
        page: (optional) Minimum 1, maximum 1000, default 1.

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_id_path("reviews")

    response = self._GET(path, kwargs)
    self._set_attrs_to_values(response)
    return response

similar_movies(**kwargs)

Get a list of similar movies. This is not the same as the "Recommendation" system you see on the website.

These items are assembled by looking at keywords and genres.

Parameters:

Name Type Description Default
language

(optional) ISO 639-1 code.

required
page

(optional) Minimum 1, maximum 1000, default 1.

required

Returns:

Type Description

A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
def similar_movies(self, **kwargs):
    """
    Get a list of similar movies. This is not the same as the
    "Recommendation" system you see on the website.

    These items are assembled by looking at keywords and genres.

    Args:
        language: (optional) ISO 639-1 code.
        page: (optional) Minimum 1, maximum 1000, default 1.

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_id_path("similar_movies")

    response = self._GET(path, kwargs)
    self._set_attrs_to_values(response)
    return response

top_rated(**kwargs)

Get the top rated movies on TMDb.

Parameters:

Name Type Description Default
language

(optional) ISO 639-1 code.

required
page

(optional) Minimum 1, maximum 1000, default 1.

required
region

(optional) Specify a ISO 3166-1 code to filter release dates. Must be uppercase.

required

Returns:

Type Description

A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
def top_rated(self, **kwargs):
    """
    Get the top rated movies on TMDb.

    Args:
        language: (optional) ISO 639-1 code.
        page: (optional) Minimum 1, maximum 1000, default 1.
        region: (optional) Specify a ISO 3166-1 code to filter release
            dates. Must be uppercase.

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_path("top_rated")

    response = self._GET(path, kwargs)
    self._set_attrs_to_values(response)
    return response

translations(**kwargs)

Get a list of translations that have been created for a movie.

Returns:

Type Description

A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
def translations(self, **kwargs):
    """
    Get a list of translations that have been created for a movie.

    Args:
        None

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_id_path("translations")

    response = self._GET(path, kwargs)
    self._set_attrs_to_values(response)
    return response

upcoming(**kwargs)

Get a list of upcoming movies in theatres. This is a release type query that looks for all movies that have a release type of 2 or 3 within the specified date range.

You can optionally specify a region parameter which will narrow the search to only look for theatrical release dates within the specified country.

Parameters:

Name Type Description Default
language

(optional) ISO 639-1 code.

required
page

(optional) Minimum 1, maximum 1000, default 1.

required
region

(optional) Specify a ISO 3166-1 code to filter release dates. Must be uppercase.

required

Returns:

Type Description

A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
def upcoming(self, **kwargs):
    """
    Get a list of upcoming movies in theatres. This is a release type query
    that looks for all movies that have a release type of 2 or 3 within the
    specified date range.

    You can optionally specify a region parameter which will narrow the
    search to only look for theatrical release dates within the specified
    country.

    Args:
        language: (optional) ISO 639-1 code.
        page: (optional) Minimum 1, maximum 1000, default 1.
        region: (optional) Specify a ISO 3166-1 code to filter release
            dates. Must be uppercase.

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_path("upcoming")

    response = self._GET(path, kwargs)
    self._set_attrs_to_values(response)
    return response

videos(**kwargs)

Get the videos that have been added to a movie.

Parameters:

Name Type Description Default
language

(optional) ISO 639-1 code.

required

Returns:

Type Description

A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
def videos(self, **kwargs):
    """
    Get the videos that have been added to a movie.

    Args:
        language: (optional) ISO 639-1 code.

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_id_path("videos")

    response = self._GET(path, kwargs)
    self._set_attrs_to_values(response)
    return response

watch_providers(**kwargs)

Get a list of the availabilities per country by provider for movies.

Returns:

Type Description

A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/movies.py
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
def watch_providers(self, **kwargs):
    """
    Get a list of the availabilities per country by provider for movies.

    Args:
        None

    Returns:
        A dict representation of the JSON returned from the API.
    """
    path = self._get_id_path("watch_providers")

    response = self._GET(path, kwargs)
    self._set_attrs_to_values(response)
    return response