Sonarr

The Sonarr integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] pulls data from a given Sonarr instance.

Configuration

To add the Sonarr service to your Home Assistant instance, use this My button:

Manual configuration steps

If the above My button doesn’t work, you can also perform the following steps manually:

URL

The URL of your Sonarr instance, including the port number and base path if applicable (for example, http://localhost:8989 or http://192.168.1.100:8989/sonarr).

API Key

Your Sonarr API key. To find it, open your Sonarr web interface and navigate to Settings > General. The API key is listed under the Security section.

Sensors

The Sonarr integration will add the following sensors:

  • Upcoming: The number of upcoming episodes.
  • Commands: The number of commands being run. (disabled by default)
  • Disk space: Available disk space in gigabytes. (disabled by default)
  • Queue: The number of episodes in the download queue. (disabled by default)
  • Shows: The number of series in Sonarr. (disabled by default)
  • Wanted: The number of episodes still wanted. (disabled by default)

The sensors provide summary counts. For detailed information about each item, such as series details or download progress, use the corresponding actionsActions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called sequence. [Learn more] described below.

List of actions

The Sonarr integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] provides the following actions. Each link below opens a dedicated page with examples, parameters, and a step-by-step UI walkthrough.

  • Get disk space (sonarr.get_diskspace) Retrieves the disk space information for all storage locations configured in Sonarr.

  • Get episodes (sonarr.get_episodes) Retrieves all episodes for a specific series in your Sonarr library.

  • Get queue (sonarr.get_queue) Retrieves the episodes currently in the Sonarr download queue with their progress and details.

  • Get series (sonarr.get_series) Retrieves all series in your Sonarr library with their details and statistics.

  • Get upcoming (sonarr.get_upcoming) Retrieves upcoming episodes from the Sonarr calendar.

  • Get wanted (sonarr.get_wanted) Retrieves wanted (missing) episodes that Sonarr is searching for.

For an overview of every action across all integrations, see the actions reference.