Tsarr Documentation - v1.8.0
    Preparing search index...

    Class RadarrClient

    Radarr API client for movie management

    const radarr = new RadarrClient({
    baseUrl: 'http://localhost:7878',
    apiKey: 'your-api-key'
    });

    const movies = await radarr.getMovies();
    Index

    Constructors

    Methods

    getSystemStatus getHealth getMovies getMovie addMovie updateMovie deleteMovie searchMovies runCommand getCommands getRootFolders addRootFolder deleteRootFolder getFilesystem getMediaFiles importMovies getQualityProfiles getQualityProfile addQualityProfile updateQualityProfile deleteQualityProfile getQualityProfileSchema getCustomFormats getCustomFormat addCustomFormat updateCustomFormat deleteCustomFormat updateCustomFormatsBulk deleteCustomFormatsBulk getCustomFormatSchema getDownloadClients getDownloadClient addDownloadClient updateDownloadClient deleteDownloadClient updateDownloadClientsBulk deleteDownloadClientsBulk getDownloadClientSchema testDownloadClient testAllDownloadClients getNotifications getNotification addNotification updateNotification deleteNotification getNotificationSchema testNotification testAllNotifications getCalendar getCalendarFeed getQueue removeQueueItem removeQueueItemsBulk grabQueueItem grabQueueItemsBulk getQueueDetails getQueueStatus getImportLists getImportList addImportList updateImportList deleteImportList getImportListSchema testImportList testAllImportLists getIndexers getIndexer addIndexer updateIndexer deleteIndexer getIndexerSchema testIndexer testAllIndexers getHistory getHistorySince getMovieHistory markHistoryItemFailed getHostConfig getHostConfigById updateHostConfig getNamingConfig getNamingConfigById updateNamingConfig getNamingConfigExamples getMediaManagementConfig getMediaManagementConfigById updateMediaManagementConfig getUiConfig getUiConfigById updateUiConfig restartSystem shutdownSystem getSystemBackups deleteSystemBackup restoreSystemBackup uploadSystemBackup getSystemLogs getLogFiles getLogFileByName getDiskSpace getTags addTag getTag updateTag deleteTag getTagDetails getTagDetailById updateConfig

    Constructors

    Methods

    • Get Radarr system status and version information

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.SystemResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get system health check results

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.HealthResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get all movies in the library

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: MovieResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get a specific movie by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: MovieResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Add a new movie to the library

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: MovieResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: MovieResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Search for movies using TMDB database

      Parameters

      • term: string

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: MovieResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Execute a Radarr command (scan, search, etc.)

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.CommandResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.CommandResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get all configured root folders

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.RootFolderResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Parameters

      • path: string

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.RootFolderResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Parameters

      • Optionalpath: string

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Parameters

      • path: string

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Import physical movie files into the library

      Parameters

      • movies: any[]

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: MovieResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get all quality profiles

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.QualityProfileResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get a specific quality profile by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.QualityProfileResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Delete a quality profile

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get quality profile schema for creating new profiles

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.QualityProfileResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get all custom formats

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.CustomFormatResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get a specific custom format by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.CustomFormatResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Delete a custom format

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Bulk delete custom formats

      Parameters

      • ids: number[]

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get custom format schema for creating new formats

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get all download clients

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.DownloadClientResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get a specific download client by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.DownloadClientResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Delete a download client

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Bulk delete download clients

      Parameters

      • ids: number[]

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get download client schema for available client types

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.DownloadClientResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Test a download client configuration

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Test all download clients

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get all notification providers

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.NotificationResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get a specific notification provider by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.NotificationResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Update an existing notification provider

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.NotificationResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Delete a notification provider

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get notification schema for available notification types

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.NotificationResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Test a notification configuration

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Test all notifications

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get upcoming movie releases in calendar format

      Parameters

      • OptionalstartDate: string
      • OptionalendDate: string
      • Optionalunmonitored: boolean

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: MovieResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get calendar feed in iCal format

      Parameters

      • OptionalpastDays: number
      • OptionalfutureDays: number
      • Optionaltags: string

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get download queue with optional filtering

      Parameters

      • Optionalpage: number
      • OptionalpageSize: number
      • OptionalsortKey: string
      • OptionalsortDirection: string
      • OptionalincludeUnknownMovieItems: boolean

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.QueueResourcePagingResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Remove an item from the download queue

      Parameters

      • id: number
      • OptionalremoveFromClient: boolean
      • Optionalblocklist: boolean

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Bulk remove items from the download queue

      Parameters

      • ids: number[]
      • OptionalremoveFromClient: boolean
      • Optionalblocklist: boolean

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Force grab/download a queue item

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Force grab/download multiple queue items

      Parameters

      • ids: number[]

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get detailed queue information

      Parameters

      • OptionalmovieId: number
      • OptionalincludeMovie: boolean

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.QueueResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get queue status summary

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.QueueStatusResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get all import lists

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.ImportListResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get a specific import list by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.ImportListResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Update an existing import list

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.ImportListResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Delete an import list

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get import list schema for available list types

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.ImportListResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Test an import list configuration

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Test all import lists

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get all indexers

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.IndexerResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get a specific indexer by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.IndexerResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Add a new indexer

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.IndexerResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Update an existing indexer

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.IndexerResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Delete an indexer

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get indexer schema for available indexer types

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.IndexerResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Test an indexer configuration

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Test all indexers

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get activity history

      Parameters

      • Optionalpage: number
      • OptionalpageSize: number
      • OptionalsortKey: string
      • OptionalsortDirection: string
      • OptionalmovieId: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.HistoryResourcePagingResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get history since a specific date

      Parameters

      • date: string
      • OptionalmovieId: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.HistoryResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get history for a specific movie

      Parameters

      • movieId: number
      • OptionaleventType: any

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.HistoryResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Mark a failed download as failed in history

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get host configuration settings

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.HostConfigResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get host configuration by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.HostConfigResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Update host configuration

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.HostConfigResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get naming configuration settings

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.NamingConfigResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get naming configuration by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.NamingConfigResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get naming configuration examples

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get media management configuration settings

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.MediaManagementConfigResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get media management configuration by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.MediaManagementConfigResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get UI configuration settings

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.UiConfigResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get UI configuration by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.UiConfigResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Update UI configuration

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.UiConfigResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Restart the Radarr application

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Shutdown the Radarr application

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get system backup files

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.BackupResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Delete a system backup by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Restore system backup by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Upload and restore system backup

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get system logs

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.LogResourcePagingResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get log files

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.LogFileResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get specific log file by filename

      Parameters

      • filename: string

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get disk space information

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.DiskSpaceResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get all tags

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.TagResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Add a new tag

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.TagResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get a specific tag by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.TagResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Update an existing tag

      Parameters

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.TagResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Delete a tag

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: unknown; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get detailed tag information

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.TagDetailsResource[]; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Get detailed tag information by ID

      Parameters

      • id: number

      Returns Promise<
          (
              | { data: undefined; error: unknown }
              | { data: Radarr.TagDetailsResource; error: undefined }
          ) & { request: Request; response: Response },
      >

    • Parameters

      Returns {
          baseUrl: string;
          apiKey: string;
          timeout?: number;
          headers?: Record<string, string>;
      }