Skip to content

sok.apis.video.imdb_api

IMDb API Implementation (via OMDb) OMDb API (Open Movie Database) is a RESTful API for retrieving movie information.

Documentation: https://www.omdbapi.com/ Note: OMDb requires a free or paid API key depending on usage.

IMDBApi

class IMDBApi(api_key: str)

Bases: BaseAPI

OMDb API implementation for accessing IMDb data.

OMDb provides movie and TV series data from IMDb, with a simple and easy-to-use API.

Note: The free API is limited to 1000 requests per day.

Initialize OMDb API.

Parameters

NameTypeDescription
api_keystrOMDb API key.
Source

supported_content_typesproperty

List[ContentType]

Get supported content types.

supported_media_typesproperty

List[MediaType]

Get supported media types.

get_detailsasync

async def get_details(
item_id: str,
content_type: ContentType,
**kwargs,
) -> Dict[str, Any]:

Get item details via IMDb ID.

Parameters

NameTypeDescription
item_idstrIMDb ID (e.g., 'tt0133093').
content_typeContentTypeContent type.

Returns

  • Dict[str, Any]Item details in standardized format.
Source
async def get_related_items(
item_id: str,
content_type: ContentType,
**kwargs,
) -> List[Dict[str, Any]]:

Get season episodes.

Parameters

NameTypeDescription
item_idstrSeries IMDb ID.
content_typeContentTypeContent type.
**kwargsseason_number for episodes.

Returns

  • List[Dict[str, Any]]Episodes list.
Source

get_season_episodesasync

async def get_season_episodes(
series_id: str,
season_number: int,
) -> List[Dict[str, Any]]:

Get episodes from specific season.

Parameters

NameTypeDescription
series_idstrSeries IMDb ID.
season_numberintSeason number.

Returns

  • List[Dict[str, Any]]Episodes list.
Source
async def search(
query: str,
content_type: ContentType,
**kwargs,
) -> Dict[str, Any]:

Search on OMDb/IMDb.

Parameters

NameTypeDescription
querystrSearch term.
content_typeContentTypeContent type.
**kwargsAdditional arguments (year, type, etc.).

Returns

  • Dict[str, Any]Search results in standardized format.
Source

search_by_titleasync

async def search_by_title(
title: str,
year: Optional[int] = None,
content_type: str = 'movie',
) -> Optional[Dict[str, Any]]:

Direct search by exact title (faster).

Parameters

NameTypeDefaultDescription
titlestrExact title.
yearOptional[int]NoneRelease year.
content_typestr'movie''movie' or 'series'.

Returns

  • Optional[Dict[str, Any]]Item details or None.
Source

Attributes

NameValue
loggerlogging.getLogger(__name__)
Built with Kiln