Series

class arrapi.objs.reload.Series(sonarr, data=None, series_id=None, tvdb_id=None)[source]

Represents a single Series.

Variables:

  • id (int) – ID of the Series.

  • title (str) – Title of the Series.

  • sortTitle (str) – Sort Title of the Series.

  • status (str) – Status of the Series.

  • overview (str) – Overview of the Series.

  • seasons (List[Season]) – List of Seasons in the Series.

  • nextAiring (datetime) – Date the next Episode in the Series Airs.

  • previousAiring (datetime) – Date the latest Episode in the Series Aired.

  • network (str) – Network the Series Airs on.

  • airTime (str) – Time Series Airs.

  • images (List[Image]) – List of Images for the Series.

  • year (int) – Year of the Series.

  • path (str) – Path of the Series.

  • languageProfileId (int) – Language Profile ID of the Series.

  • languageProfile (LanguageProfile)) – Language Profile of the Series.

  • seasonFolder (bool) – If the Series has Season Folders.

  • monitored (bool) – If the Series is monitored.

  • useSceneNumbering (bool) – If the Series uses Scene Numbering.

  • folder (str) – Folder name.

  • runtime (int) – Runtime of the Series.

  • cleanTitle (str) – Clean Title of the Series.

  • imdbId (str) – IMDb ID of the Series.

  • tvdbId (int) – TVDb ID of the Series.

  • tvRageId (int) – TV Rage ID of the Series.

  • tvMazeId (int) – TV Maze ID of the Series.

  • titleSlug (str) – Title Slug of the Series.

  • firstAired (datetime) – Date the Series First Aired.

  • seriesType (str) – Series Type of the Series.

  • certification (str) – Certification of the Series.

  • genres (List[str]) – List of genres for the Series.

  • tags (List[Tag]) – List of tags for the Movie.

  • added (datetime) – Date the Movie was added to Radarr.

  • tagsIds (List[int]) – List of tag ids for the Movie.

  • rating_votes (int) – Number of votes for the Series.

  • rating_value (float) – Rating of the Series.

  • seasonCount (int) – Number of Seasons in the Series.

  • totalEpisodeCount (int) – Total Episodes in the Series.

  • episodeCount (int) – Episodes in the Series.

  • episodeFileCount (int) – Episode File Count for the Series.

  • sizeOnDisk (int) – Size on Disk for the Series.

  • ended (bool) – If the Series has ended. (Sonarr v3 Only)

  • rootFolderPath (str) – Root Folder Path for the Series. (Sonarr v3 Only)

  • qualityProfileId (int) – Quality Profile ID of the Series. (Sonarr v3 Only)

  • qualityProfile (QualityProfile) – Quality Profile of the Series. (Sonarr v3 Only)

  • percentOfEpisodes (float) – Percent of Episodes obtained. (Sonarr v3 Only)

  • profileId (int) – Quality Profile ID of the Series. (Sonarr v2 Only)

  • profile (QualityProfile) – Quality Profile of the Series. (Sonarr v2 Only)

add(root_folder: str | int | RootFolder, quality_profile: str | int | QualityProfile, language_profile: str | int | LanguageProfile | None = None, monitor: str = 'all', season_folder: bool = True, search: bool = True, unmet_search: bool = True, series_type: str = 'standard', tags: List[str | int | Tag] | None = None) → None[source]

Add this Series to Sonarr.

Parameters:

  • root_folder (Union[str, int, RootFolder]) – Root Folder for the Series.

  • quality_profile (Union[str, int, QualityProfile]) – Quality Profile for the Series.

  • language_profile (Optional[Union[str, int, LanguageProfile]]) – Language Profile for the Series. Required for older versions.

  • monitor (bool) – How to monitor the Series. Valid options are all, future, missing, existing, pilot, firstSeason, latestSeason, or none.

  • season_folder (bool) – Use Season Folders for the Series.

  • search (bool) – Start search for missing episodes of the Series after adding.

  • unmet_search (bool) – Start search for cutoff unmet episodes of the Series after adding.

  • series_type (str) – Series Type for the Series. Valid options are standard, daily, or anime.

  • tags (Optional[List[Union[str, int, Tag]]]) – Tags to be added to the Series.

Raises:

  • Invalid – When one of the options given is invalid.

  • Exists – When the Series already Exists in Sonarr.

edit(path: str | None = None, move_files: bool = False, quality_profile: str | int | QualityProfile | None = None, language_profile: str | int | LanguageProfile | None = None, monitor: str | None = None, monitored: bool | None = None, season_folder: bool | None = None, series_type: str | None = None, tags: List[str | int | Tag] | None = None, apply_tags: str = 'add') → None[source]

Edit this Series in Sonarr.

Parameters:

  • path (Optional[str]) – Path to change the Series to.

  • move_files (bool) – When changing the path do you want to move the files to the new path.

  • quality_profile (Optional[Union[str, int, QualityProfile]]) – Quality Profile to change the Series to.

  • language_profile (Optional[Union[str, int, LanguageProfile]]) – Language Profile to change the Series to.

  • monitor (Optional[str]) – How you want the Series monitored. Valid options are all, future, missing, existing, pilot, firstSeason, latestSeason, or none.

  • monitored (Optional[bool]) – Monitor the Series.

  • season_folder (Optional[bool]) – Use Season Folders for the Series.

  • series_type (Optional[str]) – Series Type to change the Series to. Valid options are standard, daily, or anime.

  • tags (Optional[List[Union[str, int, Tag]]]) – Tags to be added, replaced, or removed from the Series.

  • apply_tags (str) – How you want to edit the Tags. Valid options are add, replace, or remove.

Raises:

  • ValueError – When theres no options given.

  • Invalid – When one of the options given is invalid.

  • NotFound – When the Series hasn’t been added to Sonarr.

delete(addImportListExclusion: bool = False, deleteFiles: bool = False) → None[source]

Delete this Series from Sonarr.

Parameters:

  • addImportListExclusion (bool) – Add Import Exclusion for this Series.

  • deleteFiles (bool) – Delete Files for this Series.

Raises:

NotFound – When the Series hasn’t been added to Sonarr.

Season

class arrapi.objs.simple.Season(arr, data)[source]

Represents a single Season.

Variables:

  • seasonNumber (int) – Season Number of the Tag.

  • monitored (bool) – If the Season is monitored.

  • totalEpisodeCount (int) – Total Episode Count for the Season.

  • episodeCount (int) – Episode Count for the Season.

  • episodeFileCount (int) – Episode File Count for the Season.

  • sizeOnDisk (int) – Size on Disk for the Season.

  • percentOfEpisodes (float) – Percent of Episodes for the Season..

  • nextAiring (datetime) – Next Airing Date for an Episode of this Season.

  • previousAiring (datetime) – Previous Airing Date for the latest Episode of this Season.

Movie

class arrapi.objs.reload.Movie(radarr, data=None, movie_id=None, tmdb_id=None, imdb_id=None)[source]

Represents a single Movie.

Variables:

  • id (int) – ID of the Movie.

  • title (str) – Title of the Movie.

  • sortTitle (str) – Sort Title of the Movie.

  • sizeOnDisk (int) – Movie Size On Disk.

  • status (str) – Status of the Movie.

  • overview (str) – Overview of the Movie.

  • inCinemas (datetime) – Date the Movie was in Cinemas.

  • physicalRelease (datetime) – Date the Movie was Physically Released.

  • digitalRelease (datetime) – Date the Movie was Digitally Released.

  • images (List[Image]) – List of Images for the Movie.

  • website (str) – Website of the Movie.

  • year (int) – Year of the Movie.

  • hasFile (bool) – If the Movie has a file.

  • youTubeTrailerId (str) – YouTube Trailer ID for the Movie.

  • studio (str) – Studio of the Movie.

  • path (str) – Path of the Movie.

  • monitored (bool) – If the Movie is monitored.

  • minimumAvailability (str) – Minimum Availability of the Movie.

  • isAvailable (bool) – If the Movie is Available.

  • folderName (str) – Folder Name of the Movie.

  • folder (str) – Folder name.

  • runtime (int) – Runtime of the Movie.

  • cleanTitle (str) – Clean Title of the Movie.

  • imdbId (str) – IMDb ID of the Movie.

  • tmdbId (int) – TMDb ID of the Movie.

  • titleSlug (str) – Title Slug of the Movie.

  • certification (str) – Certification of the Movie.

  • genres (List[str]) – List of genres for the Movie.

  • tags (List[Tag]) – List of tags for the Movie.

  • added (datetime) – Date the Movie was added to Radarr.

  • tagsIds (List[int]) – List of tag ids for the Movie.

  • rating_votes (int) – Number of votes for the Movie.

  • rating_value (float) – Rating of the Movie.

  • originalTitle (str) – Original Title of the Movie. (Radarr v3 Only)

  • digitalRelease – Date the Movie was Released Digitally. (Radarr v3 Only)

  • qualityProfileId (int) – Quality Profile ID of the Movie. (Radarr v3 Only)

  • qualityProfile (QualityProfile) – Quality Profile of the Movie. (Radarr v3 Only)

  • collection_name (str) – Collection Name of the Movie. (Radarr v3 Only)

  • collection_tmdbId (int) – TMDb Collection ID for the Movie. (Radarr v3 Only)

  • downloaded (bool) – If the Movie has been Downloaded. (Radarr v2 Only)

  • profileId (int) – Quality Profile ID of the Movie. (Radarr v2 Only)

  • profile (QualityProfile) – Quality Profile of the Movie. (Radarr v2 Only)

add(root_folder: str | int | RootFolder, quality_profile: str | int | QualityProfile, monitor: bool = True, search: bool = True, minimum_availability: str = 'announced', tags: List[str | int | Tag] | None = None) → None[source]

Add this Movie to Radarr.

Parameters:

  • root_folder (Union[str, int, RootFolder]) – Root Folder for the Movie.

  • quality_profile (Union[str, int, QualityProfile]) – Quality Profile for the Movie.

  • monitor (bool) – Monitor the Movie.

  • search (bool) – Search for the Movie after adding.

  • minimum_availability (str) – Minimum Availability for the Movie. Valid options are announced, inCinemas, released, or preDB.

  • tags (Optional[List[Union[str, int, Tag]]]) – Tags to be added to the Movie.

Raises:

  • Invalid – When one of the options given is invalid.

  • Exists – When the Movie already Exists in Radarr.

edit(path: str | None = None, move_files: bool = False, quality_profile: str | int | QualityProfile | None = None, monitored: bool | None = None, minimum_availability: str | None = None, tags: List[str | int | Tag] | None = None, apply_tags: str = 'add') → None[source]

Edit this Movie in Radarr.

Parameters:

  • path (Optional[str]) – Path to change the Movie to.

  • move_files (bool) – When changing the path do you want to move the files to the new path.

  • quality_profile (Optional[Union[str, int, QualityProfile]]) – Quality Profile to change the Movie to.

  • monitored (Optional[bool]) – Monitor the Movie.

  • minimum_availability (Optional[str]) – Minimum Availability to change the Movie to. Valid options are announced, inCinemas, released, or preDB.

  • tags (Optional[List[Union[str, int, Tag]]]) – Tags to be added, replaced, or removed from the Movie.

  • apply_tags (str) – How you want to edit the Tags. Valid options are add, replace, or remove.

Raises:

  • ValueError – When theres no options given.

  • Invalid – When one of the options given is invalid.

  • NotFound – When the Movie hasn’t been added to Radarr.

delete(addImportExclusion: bool = False, deleteFiles: bool = False) → None[source]

Delete this Movie from Radarr.

Parameters:

  • addImportExclusion (bool) – Add Import Exclusion for this Movie.

  • deleteFiles (bool) – Delete Files for this Movie.

Raises:

NotFound – When the Movie hasn’t been added to Radarr.

RadarrExclusion

class arrapi.objs.simple.RadarrExclusion(arr, data)[source]

Represents a single Radarr Exclusion.

Variables:

  • tmdbId (int) – TMDb ID of the Excluded Movie.

  • title (str) – Title of the Excluded Movie.

  • year (int) – Year of the Excluded Movie.

SonarrExclusion

class arrapi.objs.simple.SonarrExclusion(arr, data)[source]

Represents a single Sonarr Exclusion.

Variables:

  • tvdbId (int) – TVDb ID of the Excluded Series.

  • title (str) – Title of the Excluded Series.

Root Folder

class arrapi.objs.simple.RootFolder(arr, data)[source]

Represents a single Root Folder.

Variables:

  • id (int) – ID of the Root Folder.

  • path (str) – Path of the Root Folder.

  • freeSpace (int) – Free Space in the Root Folder.

  • name (str) – Name of the Root Folder. (Only when loaded using LidarrAPI or ReadarrAPI)

  • defaultMetadataProfileId (int) – Default Metadata Profile ID of the Root Folder. (Only when loaded using LidarrAPI or ReadarrAPI)

  • defaultQualityProfileId (int) – Default Quality Profile ID of the Root Folder. (Only when loaded using LidarrAPI or ReadarrAPI)

  • defaultMonitorOption (int) – Default Monitor Option of the Root Folder. (Only when loaded using LidarrAPI or ReadarrAPI)

  • defaultTags (int) – Default Tags of the Root Folder. (Only when loaded using LidarrAPI or ReadarrAPI)

  • isCalibreLibrary (bool) – If the Root Folder is a Calibre Library. (Only when loaded using ReadarrAPI)

  • unmappedFolders (List[UnmappedFolder]) – Unmapped Folders in the Root Folder. (Only when loaded using SonarrAPI V3 or RadarrAPI V3)

Quality Profile

class arrapi.objs.reload.QualityProfile(arr, data, load=False)[source]

Represents a single Quality Profile.

Variables:

  • id (int) – ID of the Quality Profile.

  • name (str) – Name of the Quality Profile.

Language Profile

class arrapi.objs.reload.LanguageProfile(arr, data, load=False)[source]

Represents a single Language Profile.

Variables:

  • id (int) – ID of the Language Profile.

  • name (str) – Name of the Language Profile.

Image

class arrapi.objs.simple.Image(arr, data)[source]

Represents a single Image.

Variables:

  • coverType (str) – Cover Type of the Image.

  • url (str) – URL of the Image.

  • remoteUrl (str) – Remote URL of the Image.

Tag

class arrapi.objs.reload.Tag(arr, data, load=False)[source]

Represents a single Tag.

Variables:

  • id (int) – ID of the Tag.

  • label (str) – Label of the Tag.

  • detail (bool) – If the Tag was loaded with details.

  • delayProfileIds (List[int]) – Delay Profile IDs. (Only when loaded with details)

  • notificationIds (List[int]) – Notification IDs. (Only when loaded with details)

  • restrictionIds (List[int]) – Restriction IDs. (Only when loaded with details)

  • importListIds (List[int]) – Import List IDs. (Only when loaded with details)

  • movieIds (List[int]) – Radarr Movie IDs. (Only when loaded with details using RadarrAPI)

  • seriesIds (List[int]) – Sonarr Series IDs. (Only when loaded with details using SonarrAPI)

  • artistIds (List[int]) – Lidarr Artist IDs. (Only when loaded with details using LidarrAPI)

  • authorIds (List[int]) – Readarr Author IDs. (Only when loaded with details using ReadarrAPI)

edit(label: str) → None[source]

Edit the Tag.

Parameters:

label (str) – Label to change tag to.

delete() → None[source]

Delete the Tag.

Command

class arrapi.objs.reload.Command(arr, data, load=False)[source]

Represents a single Command.

Variables:

  • name (str) – Name.

  • commandName (str) – Full named.

  • message (str) – Status Message.

  • body (dict) – Body of dict sent with the command.

  • priority (str) – Priority level.

  • status (str) – Status state.

  • queued (datetime) – Datetime queued.

  • started (datetime) – Datetime started.

  • ended (datetime) – Datetime ended.

  • duration (str) – Duration.

  • exception (str) – Exception message if there is a failure.

  • trigger (str) – Command trigger.

  • stateChangeTime (datetime) – Datetime the sate was cahnged.

  • sendUpdatesToClient (bool) – Send Updates To Client.

  • updateScheduledTask (bool) – Update Scheduled Task.

  • id (int) – ID of the Command.

Collection

class arrapi.objs.simple.Collection(arr, data)[source]

Represents a single Collection.

Variables:

  • name (str) – Name of the Collection.

  • tmdbId (int) – TMDb Collection ID of the Collection.

get_url()[source]

URL of the Collection on TMDb

Remote Path Mapping

class arrapi.objs.simple.RemotePathMapping(arr, data)[source]

Represents a single Remote Path Mapping.

Variables:

  • id (int) – ID of the Remote Path Mapping.

  • host (str) – Host of the Remote Path Mapping.

  • localPath (str) – Local Path of the Remote Path Mapping.

  • remotePath (str) – Remote Path of the Remote Path Mapping.

Unmapped Folder

class arrapi.objs.simple.UnmappedFolder(arr, data)[source]

Represents a single Unmapped Folder.

Variables:

  • name (str) – Name of the Unmapped Folder.

  • path (str) – Path of the Unmapped Folder.

System Status

class arrapi.objs.reload.SystemStatus(arr)[source]

Represents the System Status.

Variables:

version (str) – Version of the Arr Instance.

Check dir(SystemStatus) for all attribute as the rest are auto built.