Get torrents

Use this action to get the current torrents from one of your qBittorrent instances, for example to show them on a dashboard or send a summary in a notification. 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 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 torrents.
6. Choose the qBittorrent Device and the Torrent filter you want.
7. Select Save.

This action does not support targets. Select the qBittorrent instance using the Device option.

Options in the UI

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_torrents. Store the result in a response variable so you can use it in later steps:

action: qbittorrent.get_torrents
data:
  device_id: YOUR_DEVICE_ID
  torrent_filter: active
response_variable: torrents

This returns the active torrents from the selected qBittorrent instance.

Options in YAML

Response data

The action returns a dictionary of torrents that match the filter. Each torrent is keyed by its 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.

Related actions

These actions work well alongside this one:

• Get all torrents: Gets the current torrents from all qBittorrent instances.