- Source:
Raw API calls to the tmdb api end points for Movies.
These calls return the raw data from the calls to the tmdb api
Members
(static, constant) boolConversion
- Source:
criteriaObj { genres: [] // genre Ids genreCompareType: string // "AND" (,) if want movies with all ids or "OR" (|) for movies with any releaseYear: int // Primary Release Year releaseDateGTE: date // movies with release date >= date YYYY-MM-DD releaseDateLTE: date // movies with release date <= date YYYY-MM-DD cast: [] // person Ids. Only include movies that have one of the Id's added as an actor. castCompareType: string // "AND" if want movies with all ids or "OR" for movies with any crew: [] // person Ids. Only include movies that have one of the Id's added as a crew member. crewCompareType: string // "AND" if want movies with all ids or "OR" for movies with any watchProviders: [string] // ids of watch providers that movie is located on. watchProviderCompareType: string // "AND" if want movies with all ids or "OR" for movies with any (defaults to OR) watchRegions: [string] // In initial test (2/2021) only US worked and if not region sent then the results were not filtered by the passed watchProviders array. Chose to default to US region if none sent over.
sortBy: one of the following:
- popularity.asc
- popularity.desc **Default
- release_date.asc
- release_date.desc
- revenue.asc
- revenue.desc
- primary_release_date.asc
- primary_release_date.desc
- original_title.asc
- original_title.desc
- vote_average.asc
- vote_average.desc
- vote_count.asc
- vote_count.desc }
Methods
(static) rawMovieWatchProviders(movieId) → {object}
- Source:
Returns data for providers of movies
Parameters:
| Name | Type | Description |
|---|---|---|
movieId |
string | Movie id of movie to find providers for |
Returns:
response object {data, msg} on success { data: data from api call, apiCall: API call} on error { data: 'ERROR', msg: error message, }
- Type
- object
(static) rawMovieSearchByTitle(searchString, pageopt) → {object}
- Source:
Returns data from search by searchString
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
searchString |
string | String of title to search for |
||
page |
number |
<optional> |
1
|
page number to return if multiple pages from search |
Returns:
response object {data, msg} on success { data: data from api call, apiCall: API call} on error { data: 'ERROR', msg: error message, }
- Type
- object
(static) rawMovieGetDetails(movieId) → {object}
- Source:
Returns movie details for passed TMDb movieId The return data will include a video key with videos attached to movieId
Parameters:
| Name | Type | Description |
|---|---|---|
movieId |
string | TMDb movie id |
Returns:
response object {data, msg} on success { data: data from api call, apiCall: API call} on error { data: 'ERROR', msg: error message, }
- Type
- object
(static) rawMovieGetVideos(movieId) → {object}
- Source:
Returns the videos that have been added to the passed movieId.
https://developers.themoviedb.org/3/movies/get-movie-videos
Parameters:
| Name | Type | Description |
|---|---|---|
movieId |
string | TMDb movie id |
Returns:
response object {data, msg} on success { data: data from api call, apiCall: API call} on error { data: 'ERROR', msg: error message, }
- Type
- object
(static) rawMovieGetRecommendations(movieId, pageopt) → {object}
- Source:
Get a list of recommended movies based on passed movieId
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
movieId |
string | TMDb movie id |
||
page |
number |
<optional> |
1
|
optional |
Returns:
response object {data, msg} on success { data: data from api call, apiCall: API call} on error { data: 'ERROR', msg: error message, }
- Type
- object
(static) rawMovieGetNowPlaying(pageopt, languageopt) → {object}
- Source:
Get a list of Now Playing movies
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
page |
number |
<optional> |
1
|
optional, defaults to 1 |
language |
string |
<optional> |
'en-US'
|
optional, defaults to 'en-US' |
Returns:
response object {data, msg} on success { data: data from api call, apiCall: API call} on error { data: 'ERROR', msg: error message, }
- Type
- object
(static) rawMovieUpcoming(pageopt, languageopt) → {object}
- Source:
Get a list of Upcoming movies
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
page |
number |
<optional> |
1
|
optional, defaults to 1 |
language |
string |
<optional> |
'en-US'
|
optional, defaults to 'en-US' |
Returns:
response object {data, msg} on success { data: data from api call, apiCall: API call} on error { data: 'ERROR', msg: error message, }
- Type
- object
(static) rawMovieGetPopular(pageopt, languageopt) → {object}
- Source:
Get a list of Popular movies
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
page |
number |
<optional> |
1
|
optional, defaults to 1 |
language |
string |
<optional> |
'en-US'
|
optional, defaults to 'en-US' |
Returns:
response object {data, msg} on success { data: data from api call, apiCall: API call} on error { data: 'ERROR', msg: error message, }
- Type
- object
(static) rawMovieGetImages(movieId) → {object}
- Source:
Returns show images for passed movieId from TMDb.
Parameters:
| Name | Type | Description |
|---|---|---|
movieId |
string | TMDb show id |
Returns:
response object {data, msg} on success { data: data from api call, apiCall: API call} on error { data: 'ERROR', msg: error message, }
- Type
- object
(static) rawMovieGetPersonCredits(personId) → {object}
- Source:
Returns Person Details for Movies from TMDb. Person Id can be found in getCredits results cast: [ { id: this is the personId ... } ]
Parameters:
| Name | Type | Description |
|---|---|---|
personId |
number | TMDb personId |
Returns:
response object on success { data: data from api call, apiCall: API call}
- Type
- object
(static) rawMovieGetCredits(movieId) → {object}
- Source:
Returns the credits for Movies from TMDb. Person Id can be found in getCredits results cast: [ { id: this is the personId ... } ], crew: [ { id: this is the personId ... } ]
Parameters:
| Name | Type | Description |
|---|---|---|
movieId |
number | TMDb movieId |
Returns:
response object on success { data: data from api call, apiCall: API call}
- Type
- object