Skip to content

TV Series

Bases: TMDB

TV functionality.

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

Source code in src/tmdb_client_py/tv.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
class TV(TMDB):
    """
    TV functionality.

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

    BASE_PATH = "tv"
    URLS = {
        "info": "/{id}",
        "account_states": "/{id}/account_states",
        "alternative_titles": "/{id}/alternative_titles",
        "content_ratings": "/{id}/content_ratings",
        "credits": "/{id}/credits",
        "episode_groups": "/{id}/episode_groups",
        "external_ids": "/{id}/external_ids",
        "images": "/{id}/images",
        "keywords": "/{id}/keywords",
        "recommendations": "/{id}/recommendations",
        "reviews": "/{id}/reviews",
        "screened_theatrically": "/{id}/screened_theatrically",
        "similar": "/{id}/similar",
        "translations": "/{id}/translations",
        "videos": "/{id}/videos",
        "watch_providers": "/{id}/watch/providers",
        "rating": "/{id}/rating",
        "latest": "/latest",
        "airing_today": "/airing_today",
        "on_the_air": "/on_the_air",
        "popular": "/popular",
        "top_rated": "/top_rated",
    }

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

    def info(self, **kwargs):
        """
        Get the primary TV show details by id.

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

        Args:
            language: (optional) ISO 639 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:
            - TV show rating
            - If it belongs to your watchlist
            - If it belongs to your favourite list

        Args:
            language: (optional) ISO 3166-1 code.
            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):
        """
        Returns all of the alternative titles for a TV show.

        Args:
            language: (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 content_ratings(self, **kwargs):
        """
        Get the list of content ratings (certifications) that have been added
        to a TV show.

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

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

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

    def credits(self, **kwargs):
        """
        Get the credits (cast and crew) that have been added to a TV show.

        Args:
            language: (optional) ISO 639 code.

        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 episode_groups(self, **kwargs):
        """
        Get all of the episode groups that have been created for a TV show.
        With a group ID you can call the get TV episode group details  method.

        Args:
            language: (optional) ISO 639 code.

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

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

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

        Media Databases: IMDb ID, TVDB ID, Freebase MID*, Freebase ID*, TVRage
        ID*
        Social IDs: Facebook, Instagram, Twitter

        *Defunct or no longer available as a service.

        Args:
            language: (optional) ISO 639 code.

        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 TV show.

        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 code.

        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, **kwargs):
        """
        Get the keywords that have been added to a TV show.

        Args:
            None

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

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

    def recommendations(self, **kwargs):
        """
        Get the list of TV show recommendations for this item.

        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 reviews(self, **kwargs):
        """
        Get the reviews for a TV show.

        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 screened_theatrically(self, **kwargs):
        """
        Get a list of seasons or episodes that have been screened in a film
        festival or theatre.

        Args:
            None

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

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

    def similar(self, **kwargs):
        """
        Get a list of similar TV shows. 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")

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

    def translations(self, **kwargs):
        """
        Get a list of the translations that exist for a TV show.

        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 TV show.

        Args:
            language: (optional) ISO 639 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 tv.

        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)

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

        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 TV show.

        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")

        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 TV show. This is a live response and will
        continuously change.

        Args:
            language: (optional) ISO 639 code.

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

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

    def airing_today(self, **kwargs):
        """
        Get a list of TV shows that are airing today. This query is purely day
        based as we do not currently support airing times.

        You can specify a timezone to offset the day calculation. Without a
        specified timezone, this query defaults to EST (Eastern Time
        UTC-05:00).

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

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

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

    def on_the_air(self, **kwargs):
        """
        Get a list of shows that are currently on the air.

        This query looks for any TV show that has an episode with an air date
        in the next 7 days.

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

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

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

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

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

        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 a list of the top rated TV shows on TMDb.

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

        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

account_states(**kwargs)

Parameters:

Name Type Description Default
language

(optional) ISO 3166-1 code.

 required
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/tv.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
def account_states(self, **kwargs):
    """
    Grab the following account states for a session:
        - TV show rating
        - If it belongs to your watchlist
        - If it belongs to your favourite list

    Args:
        language: (optional) ISO 3166-1 code.
        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

airing_today(**kwargs)

Get a list of TV shows that are airing today. This query is purely day based as we do not currently support airing times.

You can specify a timezone to offset the day calculation. Without a specified timezone, this query defaults to EST (Eastern Time UTC-05:00).

Parameters:

Name Type Description Default
language

(optional) ISO 639 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/tv.py 
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
def airing_today(self, **kwargs):
    """
    Get a list of TV shows that are airing today. This query is purely day
    based as we do not currently support airing times.

    You can specify a timezone to offset the day calculation. Without a
    specified timezone, this query defaults to EST (Eastern Time
    UTC-05:00).

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

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

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

alternative_titles(**kwargs)

Returns all of the alternative titles for a TV show.

Parameters:

Name Type Description Default
language

(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/tv.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
def alternative_titles(self, **kwargs):
    """
    Returns all of the alternative titles for a TV show.

    Args:
        language: (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

content_ratings(**kwargs)

Get the list of content ratings (certifications) that have been added to a TV show.

Parameters:

Name Type Description Default
language

(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/tv.py 
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
def content_ratings(self, **kwargs):
    """
    Get the list of content ratings (certifications) that have been added
    to a TV show.

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

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

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

credits(**kwargs)

Get the credits (cast and crew) that have been added to a TV show.

Parameters:

Name Type Description Default
language

(optional) ISO 639 code.

 required

Returns:

Type Description

A dict representation of the JSON returned from the API.
Source code in src/tmdb_client_py/tv.py 
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
def credits(self, **kwargs):
    """
    Get the credits (cast and crew) that have been added to a TV show.

    Args:
        language: (optional) ISO 639 code.

    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

episode_groups(**kwargs)

Get all of the episode groups that have been created for a TV show. With a group ID you can call the get TV episode group details method.

Parameters:

Name Type Description Default
language

(optional) ISO 639 code.

 required

Returns:

Type Description

A dict representation of the JSON returned from the API.
Source code in src/tmdb_client_py/tv.py 
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
def episode_groups(self, **kwargs):
    """
    Get all of the episode groups that have been created for a TV show.
    With a group ID you can call the get TV episode group details  method.

    Args:
        language: (optional) ISO 639 code.

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

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

external_ids(**kwargs)

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

Media Databases: IMDb ID, TVDB ID, Freebase MID, Freebase ID, TVRage ID* Social IDs: Facebook, Instagram, Twitter

*Defunct or no longer available as a service.

Parameters:

Name Type Description Default
language

(optional) ISO 639 code.

 required

Returns:

Type Description

A dict representation of the JSON returned from the API.
Source code in src/tmdb_client_py/tv.py 
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
def external_ids(self, **kwargs):
    """
    Get the external ids for a TV show. We currently support the following
    external sources.

    Media Databases: IMDb ID, TVDB ID, Freebase MID*, Freebase ID*, TVRage
    ID*
    Social IDs: Facebook, Instagram, Twitter

    *Defunct or no longer available as a service.

    Args:
        language: (optional) ISO 639 code.

    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 TV show.

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 code.

 required

Returns:

Type Description

A dict representation of the JSON returned from the API.
Source code in src/tmdb_client_py/tv.py 
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
def images(self, **kwargs):
    """
    Get the images that belong to a TV show.

    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 code.

    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 TV show details by id.

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 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/tv.py 
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
def info(self, **kwargs):
    """
    Get the primary TV show details by id.

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

    Args:
        language: (optional) ISO 639 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(**kwargs)

Get the keywords that have been added to a TV show.

Returns:

Type Description

A dict representation of the JSON returned from the API.
Source code in src/tmdb_client_py/tv.py 
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
def keywords(self, **kwargs):
    """
    Get the keywords that have been added to a TV show.

    Args:
        None

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

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

latest(**kwargs)

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

Parameters:

Name Type Description Default
language

(optional) ISO 639 code.

 required

Returns:

Type Description

A dict representation of the JSON returned from the API.
Source code in src/tmdb_client_py/tv.py 
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
def latest(self, **kwargs):
    """
    Get the most newly created TV show. This is a live response and will
    continuously change.

    Args:
        language: (optional) ISO 639 code.

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

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

on_the_air(**kwargs)

Get a list of shows that are currently on the air.

This query looks for any TV show that has an episode with an air date in the next 7 days.

Parameters:

Name Type Description Default
language

(optional) ISO 639 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/tv.py 
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
def on_the_air(self, **kwargs):
    """
    Get a list of shows that are currently on the air.

    This query looks for any TV show that has an episode with an air date
    in the next 7 days.

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

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

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

popular(**kwargs)

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

Parameters:

Name Type Description Default
language

(optional) ISO 639 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/tv.py 
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
def popular(self, **kwargs):
    """
    Get a list of the current popular TV shows on TMDb. This list updates
    daily.

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

    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 TV show.

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/tv.py 
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
def rating(self, **kwargs):
    """
    Rate a TV show.

    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 TV show.

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/tv.py 
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
def rating_delete(self, **kwargs):
    """
    Remove your rating for a TV show.

    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")

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

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

recommendations(**kwargs)

Get the list of TV show recommendations for this item.

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/tv.py 
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
def recommendations(self, **kwargs):
    """
    Get the list of TV show recommendations for this item.

    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

reviews(**kwargs)

Get the reviews for a TV show.

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/tv.py 
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
def reviews(self, **kwargs):
    """
    Get the reviews for a TV show.

    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

screened_theatrically(**kwargs)

Get a list of seasons or episodes that have been screened in a film festival or theatre.

Returns:

Type Description

A dict representation of the JSON returned from the API.
Source code in src/tmdb_client_py/tv.py 
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
def screened_theatrically(self, **kwargs):
    """
    Get a list of seasons or episodes that have been screened in a film
    festival or theatre.

    Args:
        None

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

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

similar(**kwargs)

Get a list of similar TV shows. 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/tv.py 
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
def similar(self, **kwargs):
    """
    Get a list of similar TV shows. 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")

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

top_rated(**kwargs)

Get a list of the top rated TV shows on TMDb.

Parameters:

Name Type Description Default
language

(optional) ISO 639 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/tv.py 
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
def top_rated(self, **kwargs):
    """
    Get a list of the top rated TV shows on TMDb.

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

    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 the translations that exist for a TV show.

Returns:

Type Description

A dict representation of the JSON returned from the API.
Source code in src/tmdb_client_py/tv.py 
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
def translations(self, **kwargs):
    """
    Get a list of the translations that exist for a TV show.

    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

videos(**kwargs)

Get the videos that have been added to a TV show.

Parameters:

Name Type Description Default
language

(optional) ISO 639 code.

 required

Returns:

Type Description

A dict representation of the JSON returned from the API.
Source code in src/tmdb_client_py/tv.py 
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
def videos(self, **kwargs):
    """
    Get the videos that have been added to a TV show.

    Args:
        language: (optional) ISO 639 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 tv.

Returns:

Type Description

A dict representation of the JSON returned from the API.
Source code in src/tmdb_client_py/tv.py 
323
324
325
326
327
328
329
330
331
332
333
334
335
336
def watch_providers(self, **kwargs):
    """
    Get a list of the availabilities per country by provider for tv.

    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)