seasoned/docs/api.md

Table of Contents

• getMovie
  • Parameters
• getShow
  • Parameters
• getTmdbListByPath
  • Parameters
• searchTmdb
  • Parameters
• searchTorrents
  • Parameters
• addMagnet
  • Parameters
• request
  • Parameters
• elasticSearchMoviesAndShows
  • Parameters

getMovie

Fetches tmdb movie by id. Can optionally include cast credits in result object.

Parameters

• id number
• credits boolean Include credits (optional, default false)

Returns object Tmdb response

getShow

Fetches tmdb show by id. Can optionally include cast credits in result object.

Parameters

• id number
• credits boolean Include credits (optional, default false)

Returns object Tmdb response

getTmdbListByPath

Fetches tmdb list by path.

Parameters

• listPath string Path of list
• page number (optional, default 1)

Returns object Tmdb list response

searchTmdb

Fetches tmdb movies and shows by query.

Parameters

• query string
• page number (optional, default 1)

Returns object Tmdb response

searchTorrents

Search for torrents by query

Parameters

• query string
• authorization_token
• credits boolean Include credits

Returns object Torrent response

addMagnet

Add magnet to download queue.

Parameters

• magnet string Magnet link
• name boolean Name of torrent
• tmdb_id boolean

Returns object Success/Failure response

request

Request a movie or show from id. If authorization token is included the user will be linked to the requested item.

Parameters

• id number Movie or show id
• type string Movie or show type
• authorization_token string? To identify the requesting user (optional, default undefined)

Returns object Success/Failure response

elasticSearchMoviesAndShows

Search elastic indexes movies and shows by query. Doc includes Tmdb daily export of Movies and Tv Shows. See tmdb docs for more info: https://developers.themoviedb.org/3/getting-started/daily-file-exports

Parameters

• query string

Returns object List of movies and shows matching query