Support Articles
Server API: Movies
Beta
Movies are a core part of Channels, these are the recordings and imported videos classified as feature films. On this page, we’ll dive into the different movie endpoints you can use to read movie information programmatically from the Channels library.
The movie model
The movie model contains all the information about the movies in your library, such as its title, poster art, release date, duration, watch status, etc.
Note: Properties with null values will be ommited from the response.
Properties
The unique identifier for the movie.
The unique identifier for the movie according to the indexer.
The full path to the video file.
The channel number the movie was recorded from.
The title of the movie.
The short summary of the movie.
The full summary of the movie.
The content rating of the movie. This is typicall a rating such as PG, PG-13, R, etc.
The URL of the poster image for the movie.
The duration of the movie in seconds.
The playback position the movie will resume at in seconds.
The year the movie was released.
The date the movie was released.
An array of strings for the genres of the movie.
An array of strings for the tags of the movie. Tags indicate information about the video file such as HD, 4K, CC, Dolby Digital, etc.
An array of strings for the labels of the movie. Labels are self assigned strings used for organizing items in the library.
An array of strings for the categories of the movie. Categories describe the type of content the movie is such as Feature Film.
An array of strings for the cast of the movie.
An array of strings for the directors of the movie.
An array of floats denoting the commercial breaks in the movie.
Whether or not the movie has been watched.
Whether or not the movie has been favorited.
Whether or not the movie's recording was delayed when recording began.
Whether or not the movie's recording was cancelled early.
Whether or not the movie was corrupted while recording.
Whether or not recording of the movie has completed.
Whether or not the recording has completed post-processing.
Whether or not the movie's commercials have been manually verified.
The timestamp of the last time the movie was watched.
The timestamp of when the movie was added to the library.
The timestamp of when the movie was last updated.
GET /api/v1/movies
List all movies
Returns a list of all movies in the library.
Optional Attributes
Only return movies with watch status corresponding to the passed in value.
Only return movies with favorited status corresponding to the passed in value.
Only return movies with verified status corresponding to the passed in value.
Only return movies sourced from the passed in value.
Sorting Attributes
Sort the response based on the passed in value.
Set the order of the response.
[{
"id": "5157",
"program_id": "MV000271070000",
"path": "/media/DVR/Movies/Indiana Jones and the Last Crusade (1989) 2021-09-02-0019.mpg",
"channel": "6004",
"title": "Indiana Jones and the Last Crusade (1989)",
"summary": "Jones (Harrison Ford) and his father (Sean Connery) race Nazis to the Holy Grail.",
"full_summary": "An art collector appeals to Jones to embark on a search for the Holy Grail. He learns that another archaeologist has disappeared while searching for the precious goblet, and the missing man is his own father, Dr. Henry Jones. The artifact is much harder to find than they expected, and its powers are too much for those impure in heart.",
"content_rating": "PG",
"image_url": "https://tmsimg.fancybits.co/assets/p11642_v_v11_az.jpg?w=480&h=720",
"thumbnail_url": "http://192.168.1.3:8089/dvr/files/5157/preview.jpg",
"duration": 7121.096911,
"playback_time": 0,
"release_year": 1989,
"release_date": "1989-05-24",
"genres": [
"Adventure",
"Action"
],
"tags": [
"CC",
"HD 1080i",
"HDTV",
"Stereo"
],
"categories": [
"Movie",
"Feature Film"
],
"cast": [
"Harrison Ford",
"Sean Connery",
"Denholm Elliott"
],
"directors": [
"Steven Spielberg"
],
"watched": true,
"favorited": false,
"delayed": false,
"cancelled": true,
"corrupted": false,
"completed": true,
"processed": true,
"verified": false,
"created_at": 1630556383000,
"updated_at": 1676904245145
},{
"id": "5633",
"program_id": "MV0003793430",
...
}]
GET /api/v1/movies/:id
Retrieve a movie
This endpoint allows you to retrieve a movie by using its unique identifier.
Required Attributes
The unique identifier of the Movie.
{
"id": "5157",
"program_id": "MV000271070000",
"path": "/media/DVR/Movies/Indiana Jones and the Last Crusade (1989) 2021-09-02-0019.mpg",
"channel": "6004",
"title": "Indiana Jones and the Last Crusade (1989)",
"summary": "Jones (Harrison Ford) and his father (Sean Connery) race Nazis to the Holy Grail.",
"full_summary": "An art collector appeals to Jones to embark on a search for the Holy Grail. He learns that another archaeologist has disappeared while searching for the precious goblet, and the missing man is his own father, Dr. Henry Jones. The artifact is much harder to find than they expected, and its powers are too much for those impure in heart.",
"content_rating": "PG",
"image_url": "https://tmsimg.fancybits.co/assets/p11642_v_v11_az.jpg?w=480&h=720",
"thumbnail_url": "http://192.168.1.3:8089/dvr/files/5157/preview.jpg",
"duration": 7121.096911,
"playback_time": 0,
"release_year": 1989,
"release_date": "1989-05-24",
"genres": [
"Adventure",
"Action"
],
"tags": [
"CC",
"HD 1080i",
"HDTV",
"Stereo"
],
"categories": [
"Movie",
"Feature Film"
],
"cast": [
"Harrison Ford",
"Sean Connery",
"Denholm Elliott"
],
"directors": [
"Steven Spielberg"
],
"watched": true,
"favorited": false,
"delayed": false,
"cancelled": true,
"corrupted": false,
"completed": true,
"processed": true,
"verified": false,
"created_at": 1630556383000,
"updated_at": 1676904245145
}
