Skip to content

Find

Bases: TMDB

Find functionality.

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

Source code in src/tmdb_client_py/find.py
15
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
class Find(TMDB):
    """
    Find functionality.

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

    BASE_PATH = "find"
    URLS = {
        "info": "/{id}",
    }

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

    def info(self, **kwargs):
        """
        The find method makes it easy to search for objects in our database by
        an external id. For example, an IMDB ID.

        This method will search all objects (movies, TV shows and people) and
        return the results in a single response.

        The supported external sources for each object are as follows.
            Media Databases: IMDb ID, TVDB ID, Freebase MID*, Freebase ID*,
                             TVRage ID*
            Social IDs: Facebook, Insagram, Twitter

        Args:
            language: (optional) ISO 639-1 code.
            external_source: Allowed Values: imdb_id, freebase_mid,
                freebase_id, tvdb_id, tvrage_id, facebook_id, twitter_id,
                instagram_id

        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

info(**kwargs)

The find method makes it easy to search for objects in our database by an external id. For example, an IMDB ID.

This method will search all objects (movies, TV shows and people) and return the results in a single response.

The supported external sources for each object are as follows. Media Databases: IMDb ID, TVDB ID, Freebase MID, Freebase ID, TVRage ID* Social IDs: Facebook, Insagram, Twitter

Parameters:

Name Type Description Default
language

(optional) ISO 639-1 code.

required
external_source

Allowed Values: imdb_id, freebase_mid, freebase_id, tvdb_id, tvrage_id, facebook_id, twitter_id, instagram_id

required

Returns:

Type Description

A dict representation of the JSON returned from the API.

Source code in src/tmdb_client_py/find.py
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
def info(self, **kwargs):
    """
    The find method makes it easy to search for objects in our database by
    an external id. For example, an IMDB ID.

    This method will search all objects (movies, TV shows and people) and
    return the results in a single response.

    The supported external sources for each object are as follows.
        Media Databases: IMDb ID, TVDB ID, Freebase MID*, Freebase ID*,
                         TVRage ID*
        Social IDs: Facebook, Insagram, Twitter

    Args:
        language: (optional) ISO 639-1 code.
        external_source: Allowed Values: imdb_id, freebase_mid,
            freebase_id, tvdb_id, tvrage_id, facebook_id, twitter_id,
            instagram_id

    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