Radarr

    The Radarr integration pulls data from a given Radarr instance. Your API key can be found in Settings > General in the Radarr Web UI.

    配置

    此集成可通过 UI 配置。前往 设置 > 设备与服务 添加。

    Integration entities

    Binary sensor

    • Health: Shows if the Radarr instance is healthy. This is determined to have a problem if Radarr cannot communicate with any enabled download clients or no indexers are available for RSS feeds or searches.

    Calendar

    A calendar entity will also be created indicating the day of release and the type of release, such as Cinemas, Digital, or Physical.

    A calendar entity will be created indicating the day of release and the type of release, such as Cinemas, Digital, or Physical.

    Sensors

    • Disk space: Shows the disk space available to Radarr in gigabytes. A separate sensor is created for each storage path configured in Radarr (for example: sensor.radarr_disk_space_movies).
    • Movies: Shows the number of movies in the Radarr database. (disabled by default)
    • Queue: The number of movies in the download queue. (disabled by default)
    • Start time: The time when Radarr was last restarted. (disabled by default)

    Actions

    Action radarr.get_movies

    Get the list of all movies in Radarr with their details and statistics.

    Data attributeOptionalDescription
    entry_idnoThe Radarr config entry to use.

    Response data

    The response is a dictionary with a single key movies containing a dictionary of movie objects indexed by movie title.

    Return attributeDescription
    idInternal Radarr movie ID.
    titleMovie title.
    yearRelease year.
    tmdb_idThe Movie Database (TMDB) ID.
    imdb_idInternet Movie Database (IMDb) ID.
    statusMovie status (e.g., "released", "announced").
    monitoredWhether the movie is monitored.
    has_fileWhether the movie file exists.
    pathPath where the movie is stored.
    movie_file_countNumber of movie files.
    size_on_diskSize of movie files in bytes.
    imagesDictionary of image URLs by type (poster, fanart).

    Example action

    action: radarr.get_movies
data:
  entry_id: "01234567890abcdef1234567890abcde"

    Example response

    movies:
  The Amateur:
    id: 3
    title: The Amateur
    year: 2025
    tmdb_id: 1087891
    imdb_id: tt0899043
    status: released
    monitored: true
    has_file: true
    size_on_disk: 0
    path: /data/media/movies/The Amateur (2025) {tmdb-1087891}
    movie_file_count: 0
    images:
      poster: https://image.tmdb.org/t/p/original/SNEoUInCa5fAgwuEBMIMBGvkkh.jpg
      fanart: https://image.tmdb.org/t/p/original/aD7FXrm2GErTmzrIFBntPyhAqS9.jpg
  The Maze Runner:
    id: 4
    title: The Maze Runner
    year: 2014
    tmdb_id: 198663
    imdb_id: tt1790864
    status: released
    monitored: true
    has_file: true
    size_on_disk: 0
    path: /data/media/movies/The Maze Runner (2014) {tmdb-198663}
    movie_file_count: 0
    images:
      poster: https://image.tmdb.org/t/p/original/ode14q7WtDugFDp78fo9lCsmay9.jpg
      fanart: https://image.tmdb.org/t/p/original/eTlcNXGv32zkVI7ZDHhfeaKHXKQ.jpg

    Action radarr.get_queue

    Get all movies currently in the download queue with their progress and details.

    Data attributeOptionalDescription
    entry_idnoThe Radarr config entry to use.

    Response data

    The response is a dictionary with a single key movies containing a dictionary of queue item objects indexed by download title.

    Return attributeDescription
    idInternal queue item ID.
    movie_idInternal Radarr movie ID.
    titleMovie title.
    download_titleDownload release name.
    progressDownload progress percentage.
    sizeTotal download size in bytes.
    size_leftRemaining download size in bytes.
    statusDownload status (e.g., "downloading", "queued").
    tracked_download_statusTracked download status.
    tracked_download_stateTracked download state.
    qualityQuality profile name (e.g., "WEBDL-1080p").
    languagesList of language names.
    download_clientDownload client name.
    download_idDownload client's ID for this download.
    indexerIndexer name.
    protocolDownload protocol (torrent/usenet).
    estimated_completion_timeEstimated completion timestamp.
    time_leftTime remaining.
    custom_format_scoreCustom format score.

    Example action

    action: radarr.get_queue
data:
  entry_id: "01234567890abcdef1234567890abcde"
response_variable: queue_data

    Example response

    movies:
  "The.Matrix.1999.1080p.BluRay.x264":
    id: 123456789
    movie_id: 1
    title: "The Matrix"
    download_title: "The.Matrix.1999.1080p.BluRay.x264"
    progress: "45.32%"
    size: 8589934592
    size_left: 4697620070
    status: "downloading"
    tracked_download_status: "ok"
    tracked_download_state: "downloading"
    quality: "Bluray-1080p"
    languages:
      - "English"
    download_client: "qBittorrent"
    download_id: "ABC123DEF456"
    indexer: "My Indexer"
    protocol: "torrent"
    estimated_completion_time: "2024-01-15T18:30:00Z"
    time_left: "01:23:45"
    custom_format_score: 100