Qbittorrent WebUI Api

Asynchronous Rust wrapper for Qbittorrent Web API, supporting all documented endpoints.

Supported Qbittorrent version: 5.1

Usage

Add it using cargo:

cargo add qbit

Add it manually:

[dependencies]
qbit = "0.2"

Basic usage to get all torrents:

use qbit::API;
use qbit::Credentials;

let cred = Credentials::new("username", "secret_password");
let client = API::new_login("http://qBittorrent.server:6969", cred).await.unwrap();

let torrents = client.torrents(None).await.unwrap();

Implemented

WebUI 5.0 documentation

Authentication

• Login
• Logout

Application

• Get application version
• Get API version
• Get build info
• Shutdown application
• Get application preferences
• Set application preferences
• Get default save path
• Get cookies
• Set cookies

Log

• Get log
• Get peer log

Sync

• Get main data
• Get torrent peers data // Incomplete documentation for API

Transfer info

• Get global transfer info
• Get alternative speed limits state
• Toggle alternative speed limits
• Get global download limit
• Set global download limit
• Get global upload limit
• Set global upload limit
• Ban peers

Torrent management

• Get torrent list
• Get torrent generic properties
• Get torrent trackers
• Get torrent web seeds
• Get torrent contents
• Get torrent pieces' states
• Get torrent pieces' hashes
• Stop torrents
• Start torrents
• Delete torrents
• Recheck torrents
• Reannounce torrents
• Add new torrent
• Add trackers to torrent
• Edit trackers
• Remove trackers
• Add peers
• Increase torrent priority
• Decrease torrent priority
• Maximal torrent priority
• Minimal torrent priority
• Set file priority
• Get torrent download limit
• Set torrent download limit
• Set torrent share limit
• Get torrent upload limit
• Set torrent upload limit
• Set torrent location
• Set torrent name
• Set torrent category
• Get all categories
• Add new category
• Edit category
• Remove categories
• Add torrent tags
• Remove torrent tags
• Get all tags
• Create tags
• Delete tags
• Set automatic torrent management
• Toggle sequential download
• Set first/last piece priority
• Set force start
• Set super seeding
• Rename file // Unsure if this is for the file or the torrent
• Rename folder // Unsure if this is for the file or the torrent

RSS (experimental)

• Add folder
• Add feed
• Remove item
• Move item
• Get all items
• Mark as read
• Refresh item
• Set auto-downloading rule
• Rename auto-downloading rule
• Remove auto-downloading rule
• Get all auto-downloading rules
• Get all articles matching a rule

Search

• Start search
• Stop search
• Get search status
• Get search results
• Delete search
• Get search plugins
• Install search plugin
• Uninstall search plugin
• Enable search plugin
• Update search plugins