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.

Properties

id string

The unique identifier for the movie.

program_id string

The unique identifier for the movie according to the indexer.

path string

The full path to the video file.

channel string

The channel number the movie was recorded from.

title string

The title of the movie.

summary string

The short summary of the movie.

full_summary string

The full summary of the movie.

content_rating string

The content rating of the movie. This is typicall a rating such as PG, PG-13, R, etc.

image_url string

The URL of the poster image for the movie.

duration float

The duration of the movie in seconds.

playback_time integer

The playback position the movie will resume at in seconds.

release_year string

The year the movie was released.

release_date string

The date the movie was released.

genres array

An array of strings for the genres of the movie.

tags array

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.

labels array

An array of strings for the labels of the movie. Labels are self assigned strings used for organizing items in the library.

categories array

An array of strings for the categories of the movie. Categories describe the type of content the movie is such as Feature Film.

cast array

An array of strings for the cast of the movie.

directors array

An array of strings for the directors of the movie.

commercials Array of floats

An array of floats denoting the commercial breaks in the movie.

watched boolean

Whether or not the movie has been watched.

favorited boolean

Whether or not the movie has been favorited.

delayed boolean

Whether or not the movie's recording was delayed when recording began.

cancelled boolean

Whether or not the movie's recording was cancelled early.

corrupted boolean

Whether or not the movie was corrupted while recording.

completed boolean

Whether or not recording of the movie has completed.

processed boolean

Whether or not the recording has completed post-processing.

verified boolean

Whether or not the movie's commercials have been manually verified.

last_watched_at timestamp

The timestamp of the last time the movie was watched.

created_at timestamp

The timestamp of when the movie was added to the library.

updated_at timestamp

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

watched boolean

Only return movies with watch status corresponding to the passed in value.

favorited boolean

Only return movies with favorited status corresponding to the passed in value.

verified boolean

Only return movies with verified status corresponding to the passed in value.

source string

Only return movies sourced from the passed in value.

Options

  • recordings

    Movies recorded directly via Channels.

  • imports

    Movies added to the library via local content sources.

  • playon-cloud

    Movies added to the library from PlayOn Cloud.

  • stream-links

    Movies added to the library via a Stream Link.

  • stream-files

    Movies added to the library via a Stream File.

Sorting Attributes

sort string

Sort the response based on the passed in value.

Options

  • alpha default

    Sort by the title of the movie.

  • date_added

    Sort by the date the movie was added to the library.

  • date_released

    Sort by the date the movie was originally released.

  • date_watched

    Sort by the date the movie was last watched.

  • duration

    Sort by length of the movie.

order string

Set the order of the response.

Options

  • asc default

    Ascending order.

  • desc

    Descending order.

Request
GET /api/v1/movies
curl http://192.168.1.3:8089/api/v1/movies
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

id string

The unique identifier of the Movie.

Request
GET /api/v1/movies/31260
curl http://192.168.1.3:8089/api/v1/movies/31260
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
}