Home Assistant Home Assistant

Radarr

This radarr sensor platform pulls data from a given Radarr instance.

Configuration

To use your Radarr sensor in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
sensor:
  - platform: radarr
    api_key: YOUR_API_KEY

Configuration Variables

Looking for your configuration file?
api_key string Required

Your Radarr API key, found in Settings > General in the Radarr Web UI.

host string (Optional, default: localhost)

The host Radarr is running on.

port integer (Optional, default: 7878)

The port Radarr is running on.

urlbase string (Optional)

The base URL Radarr is running under. Defaults to /.

monitored_conditions list (Optional, default: movies)

Conditions to display on the frontend.

movies

The number of movies in Radarr.

upcoming

The number of upcoming movie releases (physical and in cinemas).

commands

The number of commands being run.

diskspace

The available disk space.

status

The current system status information.

days integer (Optional, default: 1)

How many days to look ahead for the upcoming sensor, 1 means today only.

include_paths list (Optional)

Array of file paths to include when calculating diskspace. Leave blank to include all.

unit string (Optional, default: GB)

The unit to display disk space in.

ssl boolean (Optional, default: false)

Whether or not to use SSL for Radarr.

Examples

In this section you find some real-life examples of how to use this sensor.

Show upcoming movie releases in the next 2 days

# Example configuration.yaml entry
sensor:
  - platform: radarr
    api_key: YOUR_API_KEY
    host: 192.168.1.8
    monitored_conditions:
      - upcoming
    days: 2

Enable SSL

SSL may run on a different port than the default (7878). The SSL port can be bound to any port in Radarr, so it should be set in the configuration here (unless it is changed to 7878).

# Example configuration.yaml entry
sensor:
  - platform: radarr
    api_key: YOUR_API_KEY
    host: 192.168.1.8
    port: 9898
    monitored_conditions:
      - upcoming
    days: 2
    ssl: true

Get disk space for all storage locations

# Example configuration.yaml entry
sensor:
  - platform: radarr
    api_key: YOUR_API_KEY
    host: 192.168.1.8
    monitored_conditions:
      - diskspace

Get disk space for listed storage locations

The storage locations Radarr returns are in the system page and in some cases this can list duplicates if sub paths are mounted separately. By listing paths to include, you can choose what data is reported by the sensor.

# Example configuration.yaml entry
sensor:
  - platform: radarr
    api_key: YOUR_API_KEY
    host: 192.168.1.8
    monitored_conditions:
      - diskspace
    include_paths:
      - /tank/plex

Get disk space in different unit

The Radarr API returns available space in bytes, but this sensor will default to reporting it in GB to make the number more manageable. This can be overridden if your storage needs require a different unit. All units from bytes (B) to yottabytes (YB) are supported.

This calculation is done using base 2 math, and may differ from systems calculating using base 10 math.

# Example configuration.yaml entry
sensor:
  - platform: radarr
    api_key: YOUR_API_KEY
    host: 192.168.1.8
    monitored_conditions:
      - diskspace
    unit: TB