Class MovieClient

Constructors

constructor

new MovieClient(axiosInstance: AxiosInstance): MovieClient
Parameters
- axiosInstance: AxiosInstance
Returns MovieClient
- Defined in client/movie/index.ts:43

Methods

addRating

addRating(
    id: number,
    params: AddRatingParams,
    request: AddRatingRequest,
): Promise<TMDBResponse>
Rate a movie and save it to your rated list.
Parameters
- id: number
- params: AddRatingParams
- request: AddRatingRequest
Returns Promise<TMDBResponse>
See
https://developer.themoviedb.org/reference/movie-add-rating
- Defined in client/movie/index.ts:258

deleteRating

deleteRating(id: number, params: DeleteRatingParams): Promise<TMDBResponse>
Delete a user rating for a movie.
Parameters
- id: number
- params: DeleteRatingParams
Returns Promise<TMDBResponse>
See
https://developer.themoviedb.org/reference/movie-delete-rating
- Defined in client/movie/index.ts:275

getAccountStates

getAccountStates(
id: number,
params?: MovieAccountStatesParams,
): Promise<MovieAccountStates>
Get the rating, watchlist and favourite status of an account.
Parameters
- id: number
- Optionalparams: MovieAccountStatesParams
Returns Promise<MovieAccountStates>
See
https://developer.themoviedb.org/reference/movie-account-states
- Defined in client/movie/index.ts:102

getAlternativeTitles

getAlternativeTitles(
id: number,
params?: MovieAlternativeTitlesParams,
): Promise<MovieAlternativeTitlesResponse>
Get the alternative titles for a movie.
Parameters
- id: number
- Optionalparams: MovieAlternativeTitlesParams
Returns Promise<MovieAlternativeTitlesResponse>
See
https://developer.themoviedb.org/reference/movie-alternative-titles
- Defined in client/movie/index.ts:114

getChanges

getChanges(
id: number,
params?: MovieChangesParams,
): Promise<MovieChangesResponse>
Get the recent changes for a movie.
Parameters
- id: number
- Optionalparams: MovieChangesParams
Returns Promise<MovieChangesResponse>
See
https://developer.themoviedb.org/reference/movie-changes
- Defined in client/movie/index.ts:126

getCredits

getCredits(
id: number,
params?: MovieCreditsParams,
): Promise<MovieCreditsResponse>
Get the cast and crew for a movie.
Parameters
- id: number
- Optionalparams: MovieCreditsParams
Returns Promise<MovieCreditsResponse>
See
https://developer.themoviedb.org/reference/movie-credits
- Defined in client/movie/index.ts:135

getDetails

getDetails<T extends readonly MovieAppendToResponseValue[] = never>(
id: number,
params?: MovieDetailsParams & { append_to_response?: T },
): Promise<MovieAppendToResponseResult<T>>
Get the top level details of a movie by ID.
Type Parameters
- T extends readonly MovieAppendToResponseValue[] = never
Parameters
- id: number
- Optionalparams: MovieDetailsParams & { append_to_response?: T }
Returns Promise<MovieAppendToResponseResult<T>>
See
https://developer.themoviedb.org/reference/movie-details
- Defined in client/movie/index.ts:85

getExternalIds

getExternalIds(id: number): Promise<MovieExternalIdsResponse>
Get the external IDs for a movie (IMDb, Facebook, etc.).
Parameters
- id: number
Returns Promise<MovieExternalIdsResponse>
See
https://developer.themoviedb.org/reference/movie-external-ids
- Defined in client/movie/index.ts:144

getImages

getImages(id: number, params?: MovieImagesParams): Promise<MovieImagesResponse>
Get the images (backdrops, posters, logos) that belong to a movie.
Parameters
- id: number
- Optionalparams: MovieImagesParams
Returns Promise<MovieImagesResponse>
See
https://developer.themoviedb.org/reference/movie-images
- Defined in client/movie/index.ts:153

getKeywords

getKeywords(id: number): Promise<MovieKeywordsResponse>
Get the keywords for a movie.
Parameters
- id: number
Returns Promise<MovieKeywordsResponse>
See
https://developer.themoviedb.org/reference/movie-keywords
- Defined in client/movie/index.ts:162

getLatest

getLatest(): Promise<MovieDetails>
Get the newest movie ID.

Returns Promise<MovieDetails>
See
https://developer.themoviedb.org/reference/movie-latest-id
- Defined in client/movie/index.ts:171

getLists

getLists(id: number, params?: MovieListsParams): Promise<MovieListsResponse>
Get the lists that a movie has been added to.
Parameters
- id: number
- Optionalparams: MovieListsParams
Returns Promise<MovieListsResponse>
See
https://developer.themoviedb.org/reference/movie-lists
- Defined in client/movie/index.ts:180

getNowPlaying

getNowPlaying(params?: MovieListParams): Promise<MovieListResponse>
Get a list of movies that are currently in theatres.
Parameters
- Optionalparams: MovieListParams
Returns Promise<MovieListResponse>
See
https://developer.themoviedb.org/reference/movie-now-playing-list
- Defined in client/movie/index.ts:49

getPopular

getPopular(params?: MovieListParams): Promise<MovieListResponse>
Get a list of movies ordered by popularity.
Parameters
- Optionalparams: MovieListParams
Returns Promise<MovieListResponse>
See
https://developer.themoviedb.org/reference/movie-popular-list
- Defined in client/movie/index.ts:58

getRecommendations

getRecommendations(
id: number,
params?: MovieRecommendationsParams,
): Promise<MovieListResponse>
Get the recommended movies for a movie.
Parameters
- id: number
- Optionalparams: MovieRecommendationsParams
Returns Promise<MovieListResponse>
See
https://developer.themoviedb.org/reference/movie-recommendations
- Defined in client/movie/index.ts:189

getReleaseDates

getReleaseDates(id: number): Promise<MovieReleaseDatesResponse>
Get the release dates and certifications for a movie.
Parameters
- id: number
Returns Promise<MovieReleaseDatesResponse>
See
https://developer.themoviedb.org/reference/movie-release-dates
- Defined in client/movie/index.ts:201

getReviews

getReviews(
id: number,
params?: MovieReviewsParams,
): Promise<MovieReviewsResponse>
Get the user reviews for a movie.
Parameters
- id: number
- Optionalparams: MovieReviewsParams
Returns Promise<MovieReviewsResponse>
See
https://developer.themoviedb.org/reference/movie-reviews
- Defined in client/movie/index.ts:210

getSimilar

getSimilar(id: number, params?: MovieSimilarParams): Promise<MovieListResponse>
Get the similar movies based on genres and keywords.
Parameters
- id: number
- Optionalparams: MovieSimilarParams
Returns Promise<MovieListResponse>
See
https://developer.themoviedb.org/reference/movie-similar
- Defined in client/movie/index.ts:219

getTopRated

getTopRated(params?: MovieListParams): Promise<MovieListResponse>
Get a list of movies ordered by rating.
Parameters
- Optionalparams: MovieListParams
Returns Promise<MovieListResponse>
See
https://developer.themoviedb.org/reference/movie-top-rated-list
- Defined in client/movie/index.ts:67

getTranslations

getTranslations(id: number): Promise<MovieTranslationsResponse>
Get the translations for a movie.
Parameters
- id: number
Returns Promise<MovieTranslationsResponse>
See
https://developer.themoviedb.org/reference/movie-translations
- Defined in client/movie/index.ts:231

getUpcoming

getUpcoming(params?: MovieListParams): Promise<MovieListResponse>
Get a list of movies that are being released soon.
Parameters
- Optionalparams: MovieListParams
Returns Promise<MovieListResponse>
See
https://developer.themoviedb.org/reference/movie-upcoming-list
- Defined in client/movie/index.ts:76

getVideos

getVideos(id: number, params?: MovieVideosParams): Promise<MovieVideosResponse>
Get the videos that have been added to a movie.
Parameters
- id: number
- Optionalparams: MovieVideosParams
Returns Promise<MovieVideosResponse>
See
https://developer.themoviedb.org/reference/movie-videos
- Defined in client/movie/index.ts:240

getWatchProviders

getWatchProviders(id: number): Promise<MovieWatchProvidersResponse>
Get the list of streaming providers for a movie.
Parameters
- id: number
Returns Promise<MovieWatchProvidersResponse>
See
https://developer.themoviedb.org/reference/movie-watch-providers
- Defined in client/movie/index.ts:249

Class MovieClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MovieClient

Methods

addRating

Parameters

Returns Promise<TMDBResponse>

See

deleteRating

Parameters

Returns Promise<TMDBResponse>

See

getAccountStates

Parameters

Returns Promise<MovieAccountStates>

See

getAlternativeTitles

Parameters

Returns Promise<MovieAlternativeTitlesResponse>

See

getChanges

Parameters

Returns Promise<MovieChangesResponse>

See

getCredits

Parameters

Returns Promise<MovieCreditsResponse>

See

getDetails

Type Parameters

Parameters

Returns Promise<MovieAppendToResponseResult<T>>

See

getExternalIds

Parameters

Returns Promise<MovieExternalIdsResponse>

See

getImages

Parameters

Returns Promise<MovieImagesResponse>

See

getKeywords

Parameters

Returns Promise<MovieKeywordsResponse>

See

getLatest

Returns Promise<MovieDetails>

See

getLists

Parameters

Returns Promise<MovieListsResponse>

See

getNowPlaying

Parameters

Returns Promise<MovieListResponse>

See

getPopular

Parameters

Returns Promise<MovieListResponse>

See

getRecommendations

Parameters

Returns Promise<MovieListResponse>

See

getReleaseDates

Parameters

Returns Promise<MovieReleaseDatesResponse>

See

getReviews

Parameters

Returns Promise<MovieReviewsResponse>

See

getSimilar

Parameters

Returns Promise<MovieListResponse>