qbit-api-rs

A asynchronous Rust wrapper for qBittorrent Web API (For version above 4.1).

Usage

add dependency

toml [dependencies] qbit-api-rs = "0.1"

sh cargo add qbit-api-rs

usage

```rust use qbitapirs::client::QbitClient;

[tokio::main]

async fn main() -> Result<(), Box> { // initialize client with given username and password let client = QbitClient::newwithuserpwd("http://hostname:port", "admin", "adminadmin").unwrap(); // or from environment variable // QBITHOST, QBITUSERNAME, QBITPASSWORD must be set let client = QbitClient::newfromenv().unwrap();

// login first
client.auth_login().await?;

// call api methods
let v = client.app_version().await?;
println!("{}", v);

//...
Ok(())

} ```

For more usage, please refer to examples.

Note

This crate provides only pure API bindings. There is no such mechanism like reauthentication when the token expires.
qBitTorrent uses cookie to authenticate. The acquired SID token stored in cookie, and will be expired after a while(default 3600 seconds). This expired time can be configured in the Options -> WebUI -> Authentication -> Session timeout. To keep the SID token valid, you can either
- periodically(within the timeout period) call login method to reauthenticate.
- or just enable Bypass authentication for clients in whitelisted IP subnets and configure your IP subnets, then you don't need to call login method anymore.
This crate is at the early stage of development. Things might break in the future.

Supported APIs

Authentication

[x] Login
[x] Logout

Application

[x] Get application version
[x] Get API version
[x] Get build info
[x] Shutdown application
[x] Get application preferences
[x] Set application preferences
[x] Get default save path

Log

[x] Get log
[x] Get peer log

Sync

[x] Get main data
[x] Get torrent peers data

Transfer info

[x] Get global transfer info
[x] Get alternative speed limits state
[x] Toggle alternative speed limits
[x] Get global download limit
[x] Set global download limit
[x] Get global upload limit
[x] Set global upload limit
[x] Ban peers

Torrent management

[x] Get torrent list
[x] Get torrent generic properties
[x] Get torrent trackers
[x] Get torrent web seeds
[x] Get torrent contents
[x] Get torrent pieces' states
[x] Get torrent pieces' hashes
[x] Pause torrents
[x] Resume torrents
[x] Delete torrents
[x] Recheck torrents
[x] Reannounce torrents
[x] Edit trackers
[x] Remove trackers
[x] Add peers
[x] Add new torrent
[x] Add trackers to torrent
[x] Increase torrent priority
[x] Decrease torrent priority
[x] Maximal torrent priority
[x] Minimal torrent priority
[ ] Set file priority
[x] Get torrent download limit
[x] Set torrent download limit
[x] Set torrent share limit
[x] Get torrent upload limit
[x] Set torrent upload limit
[x] Set torrent location
[x] Set torrent name
[x] Set torrent category
[x] Get all categories
[x] Add new category
[x] Edit category
[x] Remove categories
[x] Add torrent tags
[x] Remove torrent tags
[x] Get all tags
[x] Create tags
[x] Delete tags
[x] Set automatic torrent management
[x] Toggle sequential download
[x] Set first/last piece priority
[x] Set force start
[x] Set super seeding
[x] Rename file
[x] Rename folder

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

License

Licensed under either of

Apache License, Version 2.0 (LICENSE-APACHE or http://apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.