TV Lists

The tv_lists module provides access to curated and time-sensitive lists of tv series from TMDB.

Parameters

All the tv shows list methods make use of the same parameters, except for the popular and top rated methods which do not use the timezone parameter.

NameTypeRequiredDescription
languagestring❌Language of the results (default: en-US)
pagenumber❌Page number for pagination (default: 1)
timezonestring❌The timezone on which the "today" is calculated

Timezone

When using timezones in conjunction with the /tv/airing_today method, the “midnight” used as the reference point for “today” is offset according to the specified timezone, so that “today” is interpreted relative to the local time of the requested region. For example, if it is 6:49 AM on January 25th in Calgary (America/Edmonton), calling /tv/airing_today with timezone=America/Edmonton returns the shows that air on January 25th in that timezone. Conversely, if it is 12:50 AM on January 26th in Sydney (Australia/Sydney), using timezone=Australia/Sydneyreturns the shows that air on January 26th in that timezone.

Timezones Values

This wrapper already exports all the available timezones in TMDB via the Timezone type If you want to customize the behavior and fetch all the available timezones by yourself you can use the relative configuration method

Airing Today

tmdb.tv_lists.airing_today Get a list of TV shows airing today.

tmdb.tv_lists.airing_today(params: TVSeriesListParams): Promise<PaginatedResponse<TVSeriesResultItem>>

Reference

TMDB - Airing Today TV Shows

On The Air

tmdb.tv_lists.on_the_air Get a list of TV shows that air in the next 7 days.

tmdb.tv_lists.on_the_air(params: TVSeriesListParams): Promise<PaginatedResponse<TVSeriesResultItem>>

Reference

TMDB - On The Air TV Shows

tmdb.tv_lists.popular Get a list of TV shows ordered by popularity.

tmdb.tv_lists.popular(params: TVSeriesListParams): Promise<PaginatedResponse<TVSeriesResultItem>>

Reference

TMDB - Popular TV Shows

Top Rated

tmdb.tv_lists.top_rated Get a list of TV shows ordered by rating.

tmdb.tv_lists.top_rated(params: TVSeriesListParams): Promise<PaginatedResponse<TVSeriesResultItem>>

Reference

TMDB - Top Rated TV Shows

Usage Example

const airing_today = await tmdb.tv_lists.airing_today();
// List the names of all the tv shows airing today
console.log(airing_today.results.map((tv_show) => tv_show.name));

Types

The following TypeScript types are used in the methods above:

type TVSeriesResultItem = {
    backdrop_path: string;
    first_air_date: string;
    genre_ids: number[];
    id: number;
    name: string;
    origin_country: CountryISO3166_1[];
    original_language: string;
    overview: string;
    popularity: number;
    poster_path: string;
    vote_average: number;
    vote_count: number;
    title: string;
    original_title: string;
};

type PaginatedResponse<T> = {
    page: number;
    total_pages: number;
    total_results: number;
    results: T[];
};