hightorrent_api

hightorrent_api provides clients for various Torrenting software APIs. Only QBittorrent is supported at the moment.

Note that hightorrent_api is not a torrenting library. It will not provide any utilities for querying the DHT and/or downloading torrents. It is merely an interface with actual Torrent clients.

It provides the Api trait which various backends can implement, as well as the ApiError struct to represent their error cases. By default, it is built with the qbittorrent feature flag, providing QBittorrentClient API client.

use hightorrent_api::{Api, QBittorrentClient};

let client = QBittorrentClient::login(
  "http://localhost:8080",
  "admin",
  "adminadmin",
).await?;

for torrent in client.list().await? {
  println!("Torrent: {}", &torrent.name);
}

Supported backends

• QBittorrent
• Transmission

QBittorrent notes

The QBittorrent API exists, but is fragile...

• sometimes returns JSON, sometimes plaintext
• may return HTTP 200 "Fails", or 400 "Bad Request"
• does not return the same information in list/get endpoints (issue #18188)
• behaves unexpectedly with v2/hybrid hashes (issue #18185)
• sometimes changes methods on endpoints without bumping the API version to a new major (semantic versioning)

Bittorrent v2 is only supported since v4.4.0 release (January 6th 2022).

Supported features

• List torrents
• Get torrent detailed information
• List, add, and remove trackers to a torrent
• Remove torrents
• Add torrents by magnet link or torrent file

Interacting with a torrent

When interacting with a torrent, you need to use a SingleTarget instance. This may be produced from a parsed InfoHash or from a stringy hash. This SingleTarget may be a full infohash (v1/v2) or a TorrentID (truncated v2 hash or complete v1 hash).

use hightorrent::SingleTarget;
use hightorrent_api::Api;


let target = SingleTarget::from_str("E74C8AEB6F23A0BAEB6563CCF83E52B7094DB18E").unwrap();
if let Some(torrent) = client.get(&target).await? {
  println!("{}", &torrent.name);
}

License

GNU AGPL v3