mirror/Radarr
1
0
Fork 0
mirror of https://github.com/Radarr/Radarr synced 2025-01-21 23:20:45 +00:00
Code Issues Releases Wiki Activity
Page: API:Movie
Pages
API API:Calendar API:Command API:Diskspace API:History API:List Exclusions API:Movie Lookup API:Movie API:Queue API:System Status AppData Directory Autostart on Linux Backup and Restore Built In Qualities Clear Cache Cookies and Local Storage Command Line Options Common Problems Connections Create a Folder for Each Movie Custom Formats Aphrodite Custom Formats Examples Custom Formats Custom Post Processing Scripts Docker FAQ Health Checks Home How to Create a Folder for Each Movie How to make sure Radarr doesn't snatch full Blu Rays Import Plex Movie Database to Radarr Importing IMDb lists into TMDb Indexer Flags Installation Installing Multiple Instances of Radarr on Windows Mass Delete via API Minimum Availability New Profiles Release Branches Remote Path Mappings explained Reverse Proxy Running Multiple Instances on Windows Setup Guide Sorting and Renaming Supported DownloadClients Supported Indexers Supported NetImports Supported Notifications Twitter Notifications Useful Tools Users Guide Webhook Schema Webhook
0 API:Movie
ta264 edited this page 2020-05-14 11:43:48 +01:00
Unescape Escape
Table of Contents
This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Endpoint: "/movie"

GET

Summary

Returns all Movies in your collection

Parameters

None

Returns JsonArray
[
  {
    "title": "Assassin's Creed",
    "sortTitle": "assassins creed",
    "sizeOnDisk": 0,
    "status": "released",
    "overview": "Lynch discovers he is a descendant of the secret Assassins society through unlocked genetic memories that allow him to relive the adventures of his ancestor, Aguilar, in 15th Century Spain. After gaining incredible knowledge and skills he’s poised to take on the oppressive Knights Templar in the present day.",
    "inCinemas": "2016-12-21T00:00:00Z",
    "images": [
      {
        "coverType": "poster",
        "url": "/radarr/MediaCover/1/poster.jpg?lastWrite=636200219330000000"
      },
      {
        "coverType": "banner",
        "url": "/radarr/MediaCover/1/banner.jpg?lastWrite=636200219340000000"
      }
    ],
    "website": "https://www.ubisoft.com/en-US/",
    "downloaded": false,
    "year": 2016,
    "hasFile": false,
    "youTubeTrailerId": "pgALJgMjXN4",
    "studio": "20th Century Fox",
    "path": "/path/to/Assassin's Creed (2016)",
    "profileId": 6,
    "monitored": true,
    "minimumAvailability": "preDB",
    "runtime": 115,
    "lastInfoSync": "2017-01-23T22:05:32.365337Z",
    "cleanTitle": "assassinscreed",
    "imdbId": "tt2094766",
    "tmdbId": 121856,
    "titleSlug": "assassins-creed-121856",
    "genres": [
      "Action",
      "Adventure",
      "Fantasy",
      "Science Fiction"
    ],
    "tags": [],
    "added": "2017-01-14T20:18:52.938244Z",
    "ratings": {
      "votes": 711,
      "value": 5.2
    },
    "alternativeTitles": [
      "Assassin's Creed: The IMAX Experience"
    ],
    "qualityProfileId": 6,
    "id": 1
  }
]

GET/{id}

Summary

Returns the movie with the matching ID or 404 if no matching movie is found

Parameters

id (int)

Returns JsonObject
{
  "title": "Assassin's Creed",
  "sortTitle": "assassins creed",
  "sizeOnDisk": 0,
  "status": "released",
  "overview": "Lynch discovers he is a descendant of the secret Assassins society through unlocked genetic memories that allow him to relive the adventures of his ancestor, Aguilar, in 15th Century Spain. After gaining incredible knowledge and skills he’s poised to take on the oppressive Knights Templar in the present day.",
  "inCinemas": "2016-12-21T00:00:00Z",
  "images": [
    {
      "coverType": "poster",
      "url": "/radarr/MediaCover/1/poster.jpg?lastWrite=636200219330000000"
    },
    {
      "coverType": "banner",
      "url": "/radarr/MediaCover/1/banner.jpg?lastWrite=636200219340000000"
    }
  ],
  "website": "https://www.ubisoft.com/en-US/",
  "downloaded": false,
  "year": 2016,
  "hasFile": false,
  "youTubeTrailerId": "pgALJgMjXN4",
  "studio": "20th Century Fox",
  "path": "/path/to/Assassin's Creed (2016)",
  "profileId": 6,
  "monitored": true,
  "minimumAvailability": "preDb",
  "runtime": 115,
  "lastInfoSync": "2017-01-23T22:05:32.365337Z",
  "cleanTitle": "assassinscreed",
  "imdbId": "tt2094766",
  "tmdbId": 121856,
  "titleSlug": "assassins-creed-121856",
  "genres": [
    "Action",
    "Adventure",
    "Fantasy",
    "Science Fiction"
  ],
  "tags": [],
  "added": "2017-01-14T20:18:52.938244Z",
  "ratings": {
    "votes": 711,
    "value": 5.2
  },
  "alternativeTitles": [
    "Assassin's Creed: The IMAX Experience"
  ],
  "qualityProfileId": 6,
  "id": 1
}

POST

Summary

Adds a new movie to your collection

Parameters

NOTE: if you do not add the required params, then the movie addition wont function. Some of these without the others can indeed make a "movie". But it wont function properly in Radarr.

Required:

  • title (string)
  • qualityProfileId (int)
  • titleSlug (string)
  • images (array)
  • tmdbId (int)
  • profileId (int)
  • year (int) release year. Very important needed for the correct path!
  • path (string) - full path to the movie on disk or rootFolderPath (string) - full path will be created by combining the rootFolderPath with the movie title

Optional:

  • monitored (bool) - whether the movie should be monitored or not.
  • addOptions (object) - should contain a searchForMovie (string) key with a bool value whether Radarr should search for the movie upon being added. For example:
"addOptions" : {
  "searchForMovie" : true
}
Returns JsonObject
{
  "title": "Minions (2015)",
  "sortTitle": "minions 2015",
  "sizeOnDisk": 0,
  "status": "tba",
  "images": [
    {
      "coverType": "poster",
      "url": "/radarr/MediaCover/11/poster.jpg"
    },
    {
      "coverType": "banner",
      "url": "/radarr/MediaCover/11/banner.jpg"
    }
  ],
  "downloaded": false,
  "year": 0,
  "hasFile": false,
  "path": "/path/to/Minions (2015)",
  "profileId": 6,
  "monitored": true,
  "minimumAvailability": "preDb",
  "runtime": 0,
  "cleanTitle": "minions2015",
  "imdbId": "tt2293640",
  "tmdbId": 211672,
  "titleSlug": "minions-211672",
  "genres": [],
  "tags": [],
  "added": "2017-01-24T14:26:55.165661Z",
  "alternativeTitles": [],
  "qualityProfileId": 6,
  "id": 11
}

PUT/{id}

Summary

Update an existing movie

Parameters

Required: All parameters (you should perform a GET/{id} and submit the full body with the changes

Returns JsonObject
{
  "title": "Assassin's Creed",
  "sortTitle": "assassins creed",
  "sizeOnDisk": 0,
  "status": "released",
  "overview": "Lynch discovers he is a descendant of the secret Assassins society through unlocked genetic memories that allow him to relive the adventures of his ancestor, Aguilar, in 15th Century Spain. After gaining incredible knowledge and skills he’s poised to take on the oppressive Knights Templar in the present day.",
  "inCinemas": "2016-12-21T00:00:00Z",
  "images": [
    {
      "coverType": "poster",
      "url": "/radarr/MediaCover/1/poster.jpg?lastWrite=636200219330000000"
    },
    {
      "coverType": "banner",
      "url": "/radarr/MediaCover/1/banner.jpg?lastWrite=636200219340000000"
    }
  ],
  "website": "https://www.ubisoft.com/en-US/",
  "downloaded": false,
  "year": 2016,
  "hasFile": false,
  "youTubeTrailerId": "pgALJgMjXN4",
  "studio": "20th Century Fox",
  "path": "/path/to/Assassin's Creed (2016)",
  "profileId": 6,
  "monitored": true,
  "minimumAvailability": "preDb",
  "runtime": 115,
  "lastInfoSync": "2017-01-23T22:05:32.365337Z",
  "cleanTitle": "assassinscreed",
  "imdbId": "tt2094766",
  "tmdbId": 121856,
  "titleSlug": "assassins-creed-121856",
  "genres": [
    "Action",
    "Adventure",
    "Fantasy",
    "Science Fiction"
  ],
  "tags": [],
  "added": "2017-01-14T20:18:52.938244Z",
  "ratings": {
    "votes": 711,
    "value": 5.2
  },
  "alternativeTitles": [
    "Assassin's Creed: The IMAX Experience"
  ],
  "qualityProfileId": 6,
  "id": 1
}

DELETE/{id}

Summary

Delete the movie with the given ID

Parameters

Required: id (int)

Optional:

  • deleteFiles (bool) - if true the movie folder and all files will be deleted when the movie is deleted
  • addExclusion (bool) - if true the movie TMDBID will be added to the import exclusions list when the movie is deleted
Returns JsonObject
{}

Examples

Getting a downloaded movie info with Curl on Linux

Example of instructing Radarr to give us the JSON formatted info of a movie available in local database. Note: Your movie ID is not TMDB or IMDB id. It will be generated and assigned to your movie by your radarr installation. In post processing scripts you can get it via $radarr_movie_id environment variable or by running the below command without /{id}. In this example my movie {id} is 166

curl -X GET "http://RADARRIP:RADARRPORT/api/movie/166?apikey=RADARRAPIKEY"

Getting Started

Troubleshooting

Additional Configuration

API