sok.apis.video.tmdb_api
TMDB API client implementation.
Provides access to The Movie Database (TMDB) API for searching and retrieving detailed metadata about movies and TV series.
TMDBApi
class TMDBApi(access_token: str, session_id: Optional[str] = None)Bases: BaseAPI
TMDB API implementation using JWT Bearer token (v4) for API v3.
Initializes the TMDB API.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
access_token | str | The TMDB v4 Read Access Token (Bearer JWT) | |
session_id | Optional[str] | None | Optional Session ID for user actions |
Attributes
| Name | Description |
|---|---|
access_token | The TMDB v4 Read Access Token. |
session_id | Optional session ID for user actions. |
supported_content_typesproperty
List[ContentType]
Return content types supported by TMDB.
supported_media_typesproperty
List[MediaType]
Return media types supported by TMDB.
get_detailsasync
async def get_details( item_id: str, content_type: ContentType, **kwargs,) -> Dict[str, Any]:Get details for a movie or series.
Parameters
| Name | Type | Description |
|---|---|---|
item_id | str | TMDB ID of the item. |
content_type | ContentType | Type of content (MOVIE or TV_SERIES). |
**kwargs | Additional parameters including 'language'. |
Returns
Dict[str, Any]Dictionary with item metadata.
Raises
ValueErrorIf content_type is not supported.
get_movie_detailsasync
async def get_movie_details( movie_id: str, language: str = 'en',) -> Dict[str, Any]:Get detailed movie information.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
movie_id | str | TMDB movie ID. | |
language | str | 'en' | Language code for results. |
Returns
Dict[str, Any]Dictionary with movie metadata.
get_related_itemsasync
async def get_related_items( item_id: str, content_type: ContentType, **kwargs,) -> List[Dict[str, Any]]:Get related items (episodes for a series).
Parameters
| Name | Type | Description |
|---|---|---|
item_id | str | TMDB ID of the series. |
content_type | ContentType | Content type (only TV_SERIES supported). |
**kwargs | Additional parameters including 'language', 'season_number'. |
Returns
List[Dict[str, Any]]List of episode dictionaries for TV_SERIES, empty list otherwise.
get_tv_detailsasync
async def get_tv_details(tv_id: str, language: str = 'en') -> Dict[str, Any]:Get detailed TV series information.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
tv_id | str | TMDB series ID. | |
language | str | 'en' | Language code for results. |
Returns
Dict[str, Any]Dictionary with series metadata.
get_tv_episodesasync
async def get_tv_episodes( tv_id: str, season_number: int, language: str = 'en',) -> List[Dict[str, Any]]:Get episodes for a season.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
tv_id | str | TMDB series ID. | |
season_number | int | Season number to fetch. | |
language | str | 'en' | Language code for results. |
Returns
List[Dict[str, Any]]List of episode dictionaries.
searchasync
async def search( query: str, content_type: ContentType, **kwargs,) -> Dict[str, Any]:Search for movies or TV series.
Parameters
| Name | Type | Description |
|---|---|---|
query | str | Search query string. |
content_type | ContentType | Type to search (MOVIE or TV_SERIES). |
**kwargs | Additional parameters including 'language'. |
Returns
Dict[str, Any]Dictionary with 'results' list of matches.
Raises
ValueErrorIf content_type is not supported.
search_movieasync
async def search_movie(title: str, language: str = 'en') -> Dict[str, Any]:Search for a movie on TMDB.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
title | str | Movie title to search for. | |
language | str | 'en' | Language code for results. |
Returns
Dict[str, Any]Dictionary with 'results' list of matching movies.
search_tvasync
async def search_tv(title: str, language: str = 'en') -> Dict[str, Any]:Search for a TV series on TMDB.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
title | str | Series title to search for. | |
language | str | 'en' | Language code for results. |
Returns
Dict[str, Any]Dictionary with 'results' list of matching series.