NZBGet

The NZBGet integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] allows you to monitor and control your downloads with NZBGet from within Home Assistant. It also allows you to set up automation based on the information.

Configuration

To add the NZBGet 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:

Sensor

This integration will create these sensors:

  • nzbget_article_cache: Article cache size in MB.
  • nzbget_average_speed: Average download rate since server start in MB/s.
  • nzbget_download_paused: Whether downloading is paused.
  • nzbget_speed: Current download rate in MB/s.
  • nzbget_queue_size: Remaining size to download in MB.
  • nzbget_disk_free: Free disk space at the storage location of NZBGet.
  • nzbget_post_processing_jobs: Number of Par-Jobs or Post-processing script jobs in the post-processing queue.
  • nzbget_post_processing_paused: Whether post processing is paused.
  • nzbget_uptime: NZBGet server uptime.
  • nzbget_size: Amount of data downloaded since server start in MB.
  • nzbget_speed_limit: Download queue speed limit in MB/s.

Event automation

The NZBGet integration continuously monitors nzbget’s download history. When a download completes, an event usable for automation is triggered on the Home Assistant Bus.

Possible events are:

  • nzbget_download_complete

The event includes the name, category, and status of the downloaded nzb.

Example automation to send a Telegram message on a completed download:

- alias: "Completed Torrent"
  triggers:
    - trigger: event
      event_type: nzbget_download_complete
      event_data:
        category: tv
  actions:
    - action: notify.telegram_notifier
      data:
        title: "Download completed!"
        message: "{{trigger.event.data.name}}"

List of actions

The NZBGet 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.

  • Pause (nzbget.pause) Pauses the NZBGet download queue.

  • Resume (nzbget.resume) Resumes the NZBGet download queue.

  • Set speed (nzbget.set_speed) Sets the NZBGet download queue speed limit.

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