🍿 @lorenzopant/tmdb

Common

Shared types used across multiple API methods.

These types are shared across multiple API namespaces. Rather than duplicating definitions, they are centralised here and referenced throughout the API reference and other type pages.

Media

These types represent core media entities returned across multiple API methods. They are shared between movie and TV series responses.


Genre

A single genre entry with an ID and localized name.

Prop

Type


GenresResponse

The response shape returned by genres.movie_list() and genres.tv_list().

Prop

Type


ProductionCompany

A production company involved in creating a movie or TV show.

Prop

Type


ProductionCountry

A country where a movie or TV show was produced.

Prop

Type


SpokenLanguage

A spoken language featured in a movie or TV show.

Prop

Type


MovieCollection

A named collection of related movies (e.g., a franchise or saga).

Prop

Type


Credit

Base type shared by Cast and Crew, containing common person fields.

Prop

Type


Cast

A cast member in a movie or TV show. Extends Credit.

Prop

Type


Crew

A crew member in a movie or TV show. Extends Credit.

Prop

Type


Keyword

A keyword tag associated with a movie or TV show.

Prop

Type


Certifications

A list of content ratings for a movie or TV show, grouped by country.

Prop

Type


CertificationItem

A single content rating entry for a specific country.

Prop

Type


Changes

Prop

Type

ChangeResultItem

Prop

Type

Change

Prop

Type


ChangeItem

Prop

Type


AlternativeTitle

An alternative or regional title for a movie or TV show.

Prop

Type


AlternativeName

An alternative or regional name for different entities (Companies, Networks, ecc...).

Prop

Type


AlternativeNamesResult

The response shape returned by TMDB alternative names endpoints (companies and networks).

Prop

Type


VideoItem

Metadata for a video asset (trailer, teaser, clip, etc.) associated with a movie or TV show.

Prop

Type


WatchMonetizationType

Monetization filter values used by TMDB discover endpoints when filtering by watch providers.

type WatchMonetizationType = "flatrate" | "free" | "ads" | "rent" | "buy";

ContentRating

A content or age rating for a specific country.

Prop

Type


Review

A user-submitted review for a movie or TV show.

Prop

Type


ReviewAuthorDetails

Author metadata for a Review.

Prop

Type


Translation

A translation entry for a specific language and region.

Prop

Type


MediaWatchProviders

Watch provider availability grouped by country for a movie or TV show.

Prop

Type


WatchProvider

Streaming, rental, and purchase options for a specific country.

Prop

Type


WatchProviderItem

An individual streaming or purchase provider with logo and display metadata.

Prop

Type


KnownForItem

A union type representing either a movie or TV show in a person's known_for list. Use the media_type discriminator to narrow the type.

type KnownForItem = KnownForMovie | KnownForTV;

KnownForMovie

Prop

Type

KnownForTV

Prop

Type


MediaType

A discriminator union for media entries that can be either a movie or a TV show.

type MediaType = "movie" | "tv";

Params

These utility types are used as parameters across multiple API methods. They are derived from TMDBQueryParams using Pick, ensuring consistency and reducing duplication.

TMDBQueryParams

The base parameter type from which all utility param types are derived.

Prop

Type


WithLanguage

A parameter type for methods that accept a language override.

Prop

Type


WithPage

A parameter type for methods that support pagination.

Prop

Type


WithRegion

A parameter type for methods that accept a region override.

Prop

Type


WithLanguagePage

A parameter type for methods that accept both a language override and pagination.

Prop

Type


DateRange

A parameter type for methods that accept a date range filter.

Prop

Type


WithParams

A generic utility type that picks one or more keys from TMDBQueryParams. Used internally to construct all the With* types above.

type WithParams<T extends keyof TMDBQueryParams> = Pick<TMDBQueryParams, T>;

Pagination

The PaginatedResponse type wraps all list-based API responses that support pagination.

PaginatedResponse<T>

A generic wrapper returned by any endpoint that paginates its results. The results array type varies per endpoint — refer to each method's return type for the specific item type.

Prop

Type

TMDB caps pagination at 500 pages regardless of total_pages. Requests beyond page 500 will return an error.

On this page