Get all torrents

Use this action to get the current torrents from all of your qBittorrent instances at once, for example to show a combined overview on a dashboard. You can narrow the result down with a filter, such as only the active or paused torrents.

This action returns its result in a response variable, which you can use in later steps of the same automation or script.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To get the torrents from all instances in an automation or a script:

  1. Go to Settings > Automations & scenes.
  2. Open an existing automation or script, or select Create automation > Create new automation.
  3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
  4. In the Then do section, select Add action.
  5. From the search box, search for and select qBittorrent: Get all torrents.
  6. Choose the Torrent filter you want.
  7. Select Save.

This action does not support targets. In the UI, you are not prompted to choose an area, device, entity, or label.

Options in the UI

Torrent filter

Which torrents to return, such as all, active, inactive, paused, seeding, started, or errored.

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as qbittorrent.get_all_torrents. Store the result in a response variable so you can use it in later steps:

ActionActions 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]
action: qbittorrent.get_all_torrents
data:
  torrent_filter: active
response_variable: all_torrents

This returns the active torrents from every configured qBittorrent instance.

Options in YAML

torrent_filter string Required

Which torrents to return. One of all, active, inactive, paused, seeding, started, or errored.

Response data

The action returns a dictionary keyed by each qBittorrent instance, and each instance contains a dictionary of matching torrents keyed by torrent name.

Try it yourself

Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.

Tip

AI assistants like ChatGPT or Claude can also explain actions or suggest the right one when you describe what you want in plain language.

Related actions

These actions work well alongside this one:

  • Get torrents: Gets the current torrents from one qBittorrent instance.