qBittorrent Web API Client#

Introduction#

Python client implementation for qBittorrent Web API.

Currently supports qBittorrent v4.5.3 (Web API v2.8.19) released on May 27, 2023.

Features#

The entire qBittorrent Web API is implemented.
qBittorrent version checking for an endpoint’s existence/features is automatically handled.
All Python versions are supported.
If the authentication cookie expires, a new one is automatically requested in line with any API call.

Installation#

Install via pip from PyPI:

python -m pip install qbittorrent-api

Install a specific release (e.g. v2022.8.34):

python -m pip install qbittorrent-api==2022.8.34

Install direct from main:

pip install git+https://github.com/rmartin16/qbittorrent-api.git@main#egg=qbittorrent-api

Enable WebUI in qBittorrent: Tools -> Preferences -> Web UI
If the Web API will be exposed to the Internet, follow the recommendations.

Getting Started#

import qbittorrentapi

# instantiate a Client using the appropriate WebUI configuration
conn_info = dict(
    host="localhost",
    port=8080,
    username="admin",
    password="adminadmin",
)
qbt_client = qbittorrentapi.Client(**conn_info)

# the Client will automatically acquire/maintain a logged-in state
# in line with any request. therefore, this is not strictly necessary;
# however, you may want to test the provided login credentials.
try:
    qbt_client.auth_log_in()
except qbittorrentapi.LoginFailed as e:
    print(e)

# if the Client will not be long-lived or many Clients may be created
# in a relatively short amount of time, be sure to log out:
qbt_client.auth_log_out()

# or use a context manager:
with qbittorrentapi.Client(**conn_info) as qbt_client:
    if qbt_client.torrents_add(urls="...") != "Ok.":
        raise Exception("Failed to add torrent.")

# display qBittorrent info
print(f"qBittorrent: {qbt_client.app.version}")
print(f"qBittorrent Web API: {qbt_client.app.web_api_version}")
for k, v in qbt_client.app.build_info.items():
    print(f"{k}: {v}")

# retrieve and show all torrents
for torrent in qbt_client.torrents_info():
    print(f"{torrent.hash[-6:]}: {torrent.name} ({torrent.state})")

# pause all torrents
qbt_client.torrents.pause.all()

Usage#

First, the Web API endpoints are organized in to eight namespaces.

Authentication (auth)
Application (app)
Log (log)
Sync (sync)
Transfer (transfer)
Torrent Management (torrents)
RSS (rss)
Search (search)

Second, this client has two modes of interaction with the qBittorrent Web API.

Each Web API endpoint is implemented one-to-one as a method of the instantiated client.

import qbittorrentapi
qbt_client = qbittorrentapi.Client(host='localhost:8080', username='admin', password='adminadmin')
qbt_client.app_version()
qbt_client.rss_rules()
qbt_client.torrents_info()
qbt_client.torrents_resume(torrent_hashes='...')
# and so on

However, a more robust interface to the endpoints is available via each namespace. This is intended to provide a more seamless and intuitive interface to the Web API.

import qbittorrentapi
qbt_client = qbittorrentapi.Client(host='localhost:8080', username='admin', password='adminadmin')
# changing a preference
is_dht_enabled = qbt_client.app.preferences.dht
qbt_client.app.preferences = dict(dht=not is_dht_enabled)
# stopping all torrents
qbt_client.torrents.pause.all()
# retrieve different views of the log
qbt_client.log.main.warning()
qbt_client.log.main.normal()

Finally, some of the objects returned by the client support methods of their own. This is most pronounced for torrents themselves.

import qbittorrentapi
qbt_client = qbittorrentapi.Client(host='localhost:8080', username='admin', password='adminadmin')

for torrent in qbt_client.torrents.info.active():
    torrent.set_location(location='/home/user/torrents/')
    torrent.reannounce()
    torrent.upload_limit = -1

Introduction#

Python client implementation for qBittorrent Web API.

Currently supports qBittorrent v4.5.3 (Web API v2.8.19) released on May 27, 2023.

Features#

The entire qBittorrent Web API is implemented.
qBittorrent version checking for an endpoint’s existence/features is automatically handled.
All Python versions are supported.
If the authentication cookie expires, a new one is automatically requested in line with any API call.

Installation#

Install via pip from PyPI:

python -m pip install qbittorrent-api

Install a specific release (e.g. v2022.8.34):

python -m pip install qbittorrent-api==2022.8.34

Install direct from main:

pip install git+https://github.com/rmartin16/qbittorrent-api.git@main#egg=qbittorrent-api

Enable WebUI in qBittorrent: Tools -> Preferences -> Web UI
If the Web API will be exposed to the Internet, follow the recommendations.

Getting Started#

import qbittorrentapi

# instantiate a Client using the appropriate WebUI configuration
conn_info = dict(
    host="localhost",
    port=8080,
    username="admin",
    password="adminadmin",
)
qbt_client = qbittorrentapi.Client(**conn_info)

# the Client will automatically acquire/maintain a logged-in state
# in line with any request. therefore, this is not strictly necessary;
# however, you may want to test the provided login credentials.
try:
    qbt_client.auth_log_in()
except qbittorrentapi.LoginFailed as e:
    print(e)

# if the Client will not be long-lived or many Clients may be created
# in a relatively short amount of time, be sure to log out:
qbt_client.auth_log_out()

# or use a context manager:
with qbittorrentapi.Client(**conn_info) as qbt_client:
    if qbt_client.torrents_add(urls="...") != "Ok.":
        raise Exception("Failed to add torrent.")

# display qBittorrent info
print(f"qBittorrent: {qbt_client.app.version}")
print(f"qBittorrent Web API: {qbt_client.app.web_api_version}")
for k, v in qbt_client.app.build_info.items():
    print(f"{k}: {v}")

# retrieve and show all torrents
for torrent in qbt_client.torrents_info():
    print(f"{torrent.hash[-6:]}: {torrent.name} ({torrent.state})")

# pause all torrents
qbt_client.torrents.pause.all()

Usage#

First, the Web API endpoints are organized in to eight namespaces.

Authentication (auth)
Application (app)
Log (log)
Sync (sync)
Transfer (transfer)
Torrent Management (torrents)
RSS (rss)
Search (search)

Second, this client has two modes of interaction with the qBittorrent Web API.

Each Web API endpoint is implemented one-to-one as a method of the instantiated client.

import qbittorrentapi
qbt_client = qbittorrentapi.Client(host='localhost:8080', username='admin', password='adminadmin')
qbt_client.app_version()
qbt_client.rss_rules()
qbt_client.torrents_info()
qbt_client.torrents_resume(torrent_hashes='...')
# and so on

However, a more robust interface to the endpoints is available via each namespace. This is intended to provide a more seamless and intuitive interface to the Web API.

import qbittorrentapi
qbt_client = qbittorrentapi.Client(host='localhost:8080', username='admin', password='adminadmin')
# changing a preference
is_dht_enabled = qbt_client.app.preferences.dht
qbt_client.app.preferences = dict(dht=not is_dht_enabled)
# stopping all torrents
qbt_client.torrents.pause.all()
# retrieve different views of the log
qbt_client.log.main.warning()
qbt_client.log.main.normal()

Finally, some of the objects returned by the client support methods of their own. This is most pronounced for torrents themselves.

import qbittorrentapi
qbt_client = qbittorrentapi.Client(host='localhost:8080', username='admin', password='adminadmin')

for torrent in qbt_client.torrents.info.active():
    torrent.set_location(location='/home/user/torrents/')
    torrent.reannounce()
    torrent.upload_limit = -1

Behavior & Configuration#

Host, Username and Password#

The authentication credentials can be provided when instantiating Client:

qbt_client = Client(host="localhost:8080", username='...', password='...')

The credentials can also be specified after Client is created but calling auth_log_in() is not strictly necessary to authenticate the client; this will happen automatically for any API request.

qbt_client.auth_log_in(username='...', password='...')

Alternatively, the credentials can be specified in environment variables:
- QBITTORRENTAPI_HOST
- QBITTORRENTAPI_USERNAME
- QBITTORRENTAPI_PASSWORD

qBittorrent Session Management#

Any time a connection is established with qBittorrent, it instantiates a session to manage authentication for all subsequent API requests.
This client will transparently manage sessions by ensuring the client is always logged in in-line with any API request including requesting a new session upon expiration of an existing session.
However, each new Client instantiation will create a new session in qBittorrent.
Therefore, if many Client instances will be created be sure to call auth_log_out for each instance or use a context manager.
Otherwise, qBittorrent may experience abnormally high memory usage.

with qbittorrentapi.Client(**conn_info) as qbt_client:
    if qbt_client.torrents_add(urls="...") != "Ok.":
        raise Exception("Failed to add torrent.")

Untrusted WebUI Certificate#

qBittorrent allows you to configure HTTPS with an untrusted certificate; this commonly includes self-signed certificates.
When using such a certificate, instantiate Client with VERIFY_WEBUI_CERTIFICATE=False or set environment variable QBITTORRENTAPI_DO_NOT_VERIFY_WEBUI_CERTIFICATE to a non-null value.
Failure to do this for will cause connections to qBittorrent to fail.
As a word of caution, doing this actually does turn off certificate verification. Therefore, for instance, potential man-in-the-middle attacks will not be detected and reported (since the error is suppressed). However, the connection will remain encrypted.

qbt_client = Client(..., VERIFY_WEBUI_CERTIFICATE=False}

Requests Configuration#

The Requests package is used to issue HTTP requests to qBittorrent to facilitate this API.
Much of Requests configuration for making HTTP requests can be controlled with parameters passed along with the request payload.
For instance, HTTP Basic Authorization credentials can be provided via auth, timeouts via timeout, or Cookies via cookies. See Requests documentation for full details.
These parameters are exposed here in two ways; the examples below tell Requests to use a connect timeout of 3.1 seconds and a read timeout of 30 seconds.
When you instantiate Client, you can specify the parameters to use in all HTTP requests to qBittorrent:

qbt_client = Client(..., REQUESTS_ARGS={'timeout': (3.1, 30)}

Alternatively, parameters can be specified for individual requests:

qbt_client.torrents_info(..., requests_args={'timeout': (3.1, 30))

Additional HTTP Headers#

For consistency, HTTP Headers can be specified using the method above; for backwards compatibility, the methods below are supported as well.
Either way, these additional headers will be incorporated (using clobbering) into the rest of the headers to be sent.
To send a custom HTTP header in all requests made from an instantiated client, declare them during instantiation:

qbt_client = Client(..., EXTRA_HEADERS={'X-My-Fav-Header': 'header value')

Alternatively, you can send custom headers in individual requests:

qbt_client.torrents.add(..., headers={'X-My-Fav-Header': 'header value')

Unimplemented API Endpoints#

Since the qBittorrent Web API has evolved over time, some endpoints may not be available from the qBittorrent host.
By default, if a request is made to endpoint that doesn’t exist for the version of the qBittorrent host (e.g., the Search endpoints were introduced in Web API v2.1.1), there’s a debug logger output and None is returned.
To raise NotImplementedError instead, instantiate Client with:

qbt_client = Client(..., RAISE_NOTIMPLEMENTEDERROR_FOR_UNIMPLEMENTED_API_ENDPOINTS=True)

qBittorrent Version Checking#

It is also possible to either raise an Exception for qBittorrent hosts that are not “fully” supported or manually check for support.
The most likely situation for this to occur is if the qBittorrent team publishes a new release but its changes have not been incorporated in to this client yet.
Instantiate Client like below to raise UnsupportedQbittorrentVersion exception for versions not fully supported:

qbt_client = Client(..., RAISE_ERROR_FOR_UNSUPPORTED_QBITTORRENT_VERSIONS=True)

Additionally, the qbittorrentapi.Version class can be used for manual introspection of the versions.

Version.is_app_version_supported(qbt_client.app.version)

Disable Logging Debug Output#

Instantiate Client with DISABLE_LOGGING_DEBUG_OUTPUT=True or manually disable logging for the relevant packages:

logging.getLogger('qbittorrentapi').setLevel(logging.INFO)
logging.getLogger('requests').setLevel(logging.INFO)
logging.getLogger('urllib3').setLevel(logging.INFO)

Performance#

By default, complex objects are returned from some endpoints. These objects allow for accessing the response’s items as attributes and include methods for contextually relevant actions (such as start() and stop() for a torrent, for example).

This comes at the cost of performance, though. Generally, this cost isn’t large; however, some endpoints, such as torrents_files(), may need to convert a large payload and the cost can be significant.

This client can be configured to always return only the simple JSON if desired. Simply set SIMPLE_RESPONSES=True when instantiating the client.

qbt_client = qbittorrentapi.Client(
    host='localhost:8080',
    username='admin',
    password='adminadmin',
    SIMPLE_RESPONSES=True,
)

Alternatively, SIMPLE_RESPONSES can be set to True to return the simple JSON only for an individual method call.

qbt_client.torrents.files(torrent_hash='...', SIMPLE_RESPONSES=True)

Exceptions#

exception qbittorrentapi.exceptions.APIError#

Bases: Exception

Base error for all exceptions from this Client.

exception qbittorrentapi.exceptions.UnsupportedQbittorrentVersion#

Bases: APIError

Connected qBittorrent is not fully supported by this Client.

exception qbittorrentapi.exceptions.FileError#

Bases: OSError, APIError

Base class for all exceptions for file handling.

exception qbittorrentapi.exceptions.TorrentFileError#

Bases: FileError

Base class for all exceptions for torrent files.

exception qbittorrentapi.exceptions.TorrentFileNotFoundError#

Bases: TorrentFileError

Specified torrent file does not appear to exist.

exception qbittorrentapi.exceptions.TorrentFilePermissionError#

Bases: TorrentFileError

Permission was denied to read the specified torrent file.

exception qbittorrentapi.exceptions.APIConnectionError(*args, **kwargs)#

Bases: RequestException, APIError

Base class for all communications errors including HTTP errors.

exception qbittorrentapi.exceptions.LoginFailed(*args, **kwargs)#

Bases: APIConnectionError

This can technically be raised with any request since log in may be attempted for any request and could fail.

exception qbittorrentapi.exceptions.HTTPError(*args, **kwargs)#

Bases: HTTPError, APIConnectionError

Base error for all HTTP errors.

All errors following a successful connection to qBittorrent are returned as HTTP statuses.

http_status_code = None#

exception qbittorrentapi.exceptions.HTTP4XXError(*args, **kwargs)#

Bases: HTTPError

Base error for all HTTP 4XX statuses.

exception qbittorrentapi.exceptions.HTTP5XXError(*args, **kwargs)#

Bases: HTTPError

Base error for all HTTP 5XX statuses.

exception qbittorrentapi.exceptions.HTTP400Error(*args, **kwargs)#

Bases: HTTP4XXError

HTTP 400 Status.

http_status_code = 400#

exception qbittorrentapi.exceptions.HTTP401Error(*args, **kwargs)#

Bases: HTTP4XXError

HTTP 401 Status.

http_status_code = 401#

exception qbittorrentapi.exceptions.HTTP403Error(*args, **kwargs)#

Bases: HTTP4XXError

HTTP 403 Status.

http_status_code = 403#

exception qbittorrentapi.exceptions.HTTP404Error(*args, **kwargs)#

Bases: HTTP4XXError

HTTP 404 Status.

http_status_code = 404#

exception qbittorrentapi.exceptions.HTTP405Error(*args, **kwargs)#

Bases: HTTP4XXError

HTTP 405 Status.

http_status_code = 405#

exception qbittorrentapi.exceptions.HTTP409Error(*args, **kwargs)#

Bases: HTTP4XXError

HTTP 409 Status.

http_status_code = 409#

exception qbittorrentapi.exceptions.HTTP415Error(*args, **kwargs)#

Bases: HTTP4XXError

HTTP 415 Status.

http_status_code = 415#

exception qbittorrentapi.exceptions.HTTP500Error(*args, **kwargs)#

Bases: HTTP5XXError

HTTP 500 Status.

http_status_code = 500#

exception qbittorrentapi.exceptions.MissingRequiredParameters400Error(*args, **kwargs)#

Bases: HTTP400Error

Endpoint call is missing one or more required parameters.

exception qbittorrentapi.exceptions.InvalidRequest400Error(*args, **kwargs)#

Bases: HTTP400Error

One or more endpoint arguments are malformed.

exception qbittorrentapi.exceptions.Unauthorized401Error(*args, **kwargs)#

Bases: HTTP401Error

Primarily reserved for XSS and host header issues.

exception qbittorrentapi.exceptions.Forbidden403Error(*args, **kwargs)#

Bases: HTTP403Error

Not logged in, IP has been banned, or calling an API method that isn’t public.

exception qbittorrentapi.exceptions.NotFound404Error(*args, **kwargs)#

Bases: HTTP404Error

This should mean qBittorrent couldn’t find a torrent for the torrent hash.

exception qbittorrentapi.exceptions.MethodNotAllowed405Error(*args, **kwargs)#

Bases: HTTP405Error

HTTP method is not supported for the API endpoint.

exception qbittorrentapi.exceptions.Conflict409Error(*args, **kwargs)#

Bases: HTTP409Error

Returned if arguments don’t make sense specific to the endpoint.

exception qbittorrentapi.exceptions.UnsupportedMediaType415Error(*args, **kwargs)#

Bases: HTTP415Error

torrents/add endpoint will return this for invalid URL(s) or files.

exception qbittorrentapi.exceptions.InternalServerError500Error(*args, **kwargs)#

Bases: HTTP500Error

Returned if qBittorrent errors internally while processing the request.

API Reference#

Application#

class qbittorrentapi.app.AppAPIMixIn(host='', port=None, username=None, password=None, **kwargs)#

Bases: AuthAPIMixIn

Implementation of all Application API methods.

Usage:

>>> from qbittorrentapi import Client
>>> client = Client(host='localhost:8080', username='admin', password='adminadmin')
>>> client.app_version()
>>> client.app_preferences()

app_build_info(**kwargs)#

Retrieve build info.

Returns:: BuildInfoDictionary - https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-build-info

app_default_save_path(**kwargs)#

Retrieves the default path for where torrents are saved.

Returns:: string

app_preferences(**kwargs)#

Retrieve qBittorrent application preferences.

Returns:: ApplicationPreferencesDictionary - https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-application-preferences

app_set_preferences(prefs=None, **kwargs)#

Set one or more preferences in qBittorrent application.

Parameters:: prefs – dictionary of preferences to set
Returns:: None

app_shutdown(**kwargs)#: Shutdown qBittorrent.

app_version(**kwargs)#

Retrieve application version.

Returns:: string

app_web_api_version(**kwargs)#

Retrieve web API version.

Returns:: string

class qbittorrentapi.app.Application(*args, **kwargs)#

Allows interaction with Application API endpoints.

Usage:

>>> from qbittorrentapi import Client
>>> client = Client(host='localhost:8080', username='admin', password='adminadmin')
>>> # these are all the same attributes that are available as named in the
>>> #  endpoints or the more pythonic names in Client (with or without 'app_' prepended)
>>> webapiVersion = client.application.webapiVersion
>>> web_api_version = client.application.web_api_version
>>> app_web_api_version = client.application.web_api_version
>>> # access and set preferences as attributes
>>> is_dht_enabled = client.application.preferences.dht
>>> # supports sending a just subset of preferences to update
>>> client.application.preferences = dict(dht=(not is_dht_enabled))
>>> prefs = client.application.preferences
>>> prefs['web_ui_clickjacking_protection_enabled'] = True
>>> client.app.preferences = prefs
>>>
>>> client.application.shutdown()

property build_info#: Implements app_build_info()

property default_save_path#: Implements app_default_save_path()

property preferences#: Implements app_preferences() and app_set_preferences()

set_preferences(prefs=None, **kwargs)#: Implements app_set_preferences()

shutdown()#: Implements app_shutdown()

property version#: Implements app_version()

property web_api_version#: Implements app_web_api_version()

class qbittorrentapi.app.ApplicationPreferencesDictionary(data=None, client=None)#

Bases: Dictionary

Response for app_preferences()

class qbittorrentapi.app.BuildInfoDictionary(data=None, client=None)#

Bases: Dictionary

Response for app_build_info()

AttrDict (internal)#

class qbittorrentapi._attrdict.AttrDict(*args, **kwargs)#

Bases: dict, MutableAttr

A dict that implements MutableAttr.

class qbittorrentapi._attrdict.MutableAttr#

Bases: Attr, MutableMapping

A mixin class for a mapping that allows for attribute-style access of values.

class qbittorrentapi._attrdict.Attr#

Bases: Mapping

A mixin class for a mapping that allows for attribute-style access of values.

A key may be used as an attribute if:

It is a string
It matches ^[A-Za-z][A-Za-z0-9_]*$ (i.e., a public attribute)
The key doesn’t overlap with any class attributes (for Attr, those would be get, items, keys, values, mro, and register).

If a value which is accessed as an attribute is a Sequence-type (and is not a string/bytes), it will be converted to a _sequence_type with any mappings within it converted to Attrs.

NOTE:: This means that if _sequence_type is not None, then a sequence accessed as an attribute will be a different object than if accessed as an attribute than if it is accessed as an item.

Authentication#

class qbittorrentapi.auth.AuthAPIMixIn(host='', port=None, username=None, password=None, **kwargs)#

Bases: Request

Implementation of all Authorization API methods.

Usage:

>>> from qbittorrentapi import Client
>>> client = Client(host='localhost:8080', username='admin', password='adminadmin')
>>> _ = client.is_logged_in
>>> client.auth_log_in(username='admin', password='adminadmin')
>>> client.auth_log_out()

auth_log_in(username=None, password=None, **kwargs)#

Raises:

LoginFailed – if credentials failed to log in
Forbidden403Error – if user is banned…or not logged in

Parameters:

username – username for qBittorrent client
password – password for qBittorrent client

Returns:

None

auth_log_out(**kwargs)#: End session with qBittorrent.

property is_logged_in#

Returns True if low-overhead API call succeeds; False otherwise.

There isn’t a reliable way to know if an existing session is still valid without attempting to use it. qBittorrent invalidates cookies when they expire.

Returns:: True/False if current authorization cookie is accepted by qBittorrent

class qbittorrentapi.auth.Authorization(*args, **kwargs)#

Allows interaction with the Authorization API endpoints.

Usage:

>>> from qbittorrentapi import Client
>>> client = Client(host='localhost:8080', username='admin', password='adminadmin')
>>> is_logged_in = client.auth.is_logged_in
>>> client.auth.log_in(username='admin', password='adminadmin')
>>> client.auth.log_out()

property is_logged_in#: Implements is_logged_in()

log_in(username=None, password=None, **kwargs)#: Implements auth_log_in()

log_out(**kwargs)#: Implements auth_log_out()

Client#

class qbittorrentapi.client.Client(host='', port=None, username=None, password=None, EXTRA_HEADERS=None, REQUESTS_ARGS=None, VERIFY_WEBUI_CERTIFICATE=True, FORCE_SCHEME_FROM_HOST=False, RAISE_NOTIMPLEMENTEDERROR_FOR_UNIMPLEMENTED_API_ENDPOINTS=False, RAISE_ERROR_FOR_UNSUPPORTED_QBITTORRENT_VERSIONS=False, VERBOSE_RESPONSE_LOGGING=False, SIMPLE_RESPONSES=False, DISABLE_LOGGING_DEBUG_OUTPUT=False, **kwargs)#

Bases: LogAPIMixIn, SyncAPIMixIn, TransferAPIMixIn, TorrentsAPIMixIn, RSSAPIMixIn, SearchAPIMixIn

Initialize API for qBittorrent client.

Host must be specified. Username and password can be specified at login. A call to auth_log_in() is not explicitly required if username and password are provided during Client construction.

Usage:

>>> from qbittorrentapi import Client
>>> client = Client(host='localhost:8080', username='admin', password='adminadmin')
>>> torrents = client.torrents_info()

Parameters:

host – hostname for qBittorrent Web API, [http[s]://]localhost[:8080][/path]
port – port number for qBittorrent Web API (ignored if host contains a port)
username – username for qBittorrent Web API
password – password for qBittorrent Web API
SIMPLE_RESPONSES – By default, complex objects are returned from some endpoints. These objects will allow for accessing responses’ items as attributes and include methods for contextually relevant actions. This comes at the cost of performance. Generally, this cost isn’t large; however, some endpoints, such as torrents_files() method, may need to convert a large payload. Set this to True to return the simple JSON back. Alternatively, set this to True only for an individual method call. For instance, when requesting the files for a torrent: client.torrents_files(hash='...', SIMPLE_RESPONSES=True)
VERIFY_WEBUI_CERTIFICATE – Set to False to skip verify certificate for HTTPS connections; for instance, if the connection is using a self-signed certificate. Not setting this to False for self-signed certs will cause a APIConnectionError exception to be raised.
EXTRA_HEADERS – Dictionary of HTTP Headers to include in all requests made to qBittorrent.
REQUESTS_ARGS – Dictionary of configuration for Requests package: https://requests.readthedocs.io/en/latest/api/#requests.request
FORCE_SCHEME_FROM_HOST – If a scheme (i.e. http or https) is specified in host, it will be used regardless of whether qBittorrent is configured for HTTP or HTTPS communication. Normally, this client will attempt to determine which scheme qBittorrent is actually listening on… but this can cause problems in rare cases. Defaults False.
RAISE_NOTIMPLEMENTEDERROR_FOR_UNIMPLEMENTED_API_ENDPOINTS – Some Endpoints may not be implemented in older versions of qBittorrent. Setting this to True will raise a NotImplementedError instead of just returning``None``.
RAISE_ERROR_FOR_UNSUPPORTED_QBITTORRENT_VERSIONS – raise the UnsupportedQbittorrentVersion exception if the connected version of qBittorrent is not fully supported by this client. Defaults False.
DISABLE_LOGGING_DEBUG_OUTPUT – Turn off debug output from logging for this package as well as Requests & urllib3.

Definitions#

class qbittorrentapi.definitions.APINames(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)#

Bases: Enum

API namespaces for API endpoints.

e.g torrents in http://localhost:8080/api/v2/torrents/addTrackers

Application = 'app'#

Authorization = 'auth'#

EMPTY = ''#

Log = 'log'#

RSS = 'rss'#

Search = 'search'#

Sync = 'sync'#

Torrents = 'torrents'#

Transfer = 'transfer'#

class qbittorrentapi.definitions.ClientCache(*args, **kwargs)#

Bases: object

Caches the client.

Subclass this for any object that needs access to the Client.

class qbittorrentapi.definitions.Dictionary(data=None, client=None)#

Bases: ClientCache, AttrDict

Base definition of dictionary-like objects returned from qBittorrent.

class qbittorrentapi.definitions.List(list_entries=None, entry_class=None, client=None)#

Bases: UserList

Base definition for list-like objects returned from qBittorrent.

class qbittorrentapi.definitions.ListEntry(data=None, client=None)#

Bases: Dictionary

Base definition for objects within a list returned from qBittorrent.

class qbittorrentapi.definitions.TorrentState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)#

Bases: Enum

Torrent States as defined by qBittorrent.

Definitions:

Usage:

>>> from qbittorrentapi import Client, TorrentState
>>> client = Client()
>>> # print torrent hashes for torrents that are downloading
>>> for torrent in client.torrents_info():
>>>     # check if torrent is downloading
>>>     if torrent.state_enum.is_downloading:
>>>         print(f'{torrent.hash} is downloading...')
>>>     # the appropriate enum member can be directly derived
>>>     state_enum = TorrentState(torrent.state)
>>>     print(f'{torrent.hash}: {state_enum.value}')

ALLOCATING = 'allocating'#

CHECKING_DOWNLOAD = 'checkingDL'#

CHECKING_RESUME_DATA = 'checkingResumeData'#

CHECKING_UPLOAD = 'checkingUP'#

DOWNLOADING = 'downloading'#

ERROR = 'error'#

FORCED_DOWNLOAD = 'forcedDL'#

FORCED_METADATA_DOWNLOAD = 'forcedMetaDL'#

FORCED_UPLOAD = 'forcedUP'#

METADATA_DOWNLOAD = 'metaDL'#

MISSING_FILES = 'missingFiles'#

MOVING = 'moving'#

PAUSED_DOWNLOAD = 'pausedDL'#

PAUSED_UPLOAD = 'pausedUP'#

QUEUED_DOWNLOAD = 'queuedDL'#

QUEUED_UPLOAD = 'queuedUP'#

STALLED_DOWNLOAD = 'stalledDL'#

STALLED_UPLOAD = 'stalledUP'#

UNKNOWN = 'unknown'#

UPLOADING = 'uploading'#

property is_checking#: Returns True if the State is categorized as Checking.

property is_complete#: Returns True if the State is categorized as Complete.

property is_downloading#: Returns True if the State is categorized as Downloading.

property is_errored#: Returns True if the State is categorized as Errored.

property is_paused#: Returns True if the State is categorized as Paused.

property is_uploading#: Returns True if the State is categorized as Uploading.

class qbittorrentapi.definitions.TrackerStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)#

Bases: Enum

Tracker Statuses as defined by qBittorrent.

Definitions:

Usage:

>>> from qbittorrentapi import Client, TrackerStatus
>>> client = Client()
>>> # print torrent hashes for torrents that are downloading
>>> for torrent in client.torrents_info():
>>>     for tracker in torrent.trackers:
>>>         # display status for each tracker
>>>         print(f"{torrent.hash[-6:]}: {TrackerStatus(tracker.status).display:>13} :{tracker.url}")

DISABLED = 0#

NOT_CONTACTED = 1#

NOT_WORKING = 4#

UPDATING = 3#

WORKING = 2#

property display#: Returns a descriptive display value for status.

Log#

class qbittorrentapi.log.LogAPIMixIn(host='', port=None, username=None, password=None, **kwargs)#

Bases: AppAPIMixIn

Implementation of all Log API methods.

Usage:

>>> from qbittorrentapi import Client
>>> client = Client(host='localhost:8080', username='admin', password='adminadmin')
>>> client.log_main(info=False)
>>> client.log_peers()

log_main(normal=None, info=None, warning=None, critical=None, last_known_id=None, **kwargs)#

Retrieve the qBittorrent log entries. Iterate over returned object.

Parameters:

normal – False to exclude normal entries
info – False to exclude info entries
warning – False to exclude warning entries
critical – False to exclude critical entries
last_known_id – only entries with an ID greater than this value will be returned

Returns:

LogMainList

log_peers(last_known_id=None, **kwargs)#

Retrieve qBittorrent peer log.

Parameters:: last_known_id – only entries with an ID greater than this value will be returned
Returns:: LogPeersList

class qbittorrentapi.log.Log(client)#

Allows interaction with Log API endpoints.

Usage:

>>> from qbittorrentapi import Client
>>> client = Client(host='localhost:8080', username='admin', password='adminadmin')
>>> # this is all the same attributes that are available as named in the
>>> #  endpoints or the more pythonic names in Client (with or without 'log_' prepended)
>>> log_list = client.log.main()
>>> peers_list = client.log.peers(hash='...')
>>> # can also filter log down with additional attributes
>>> log_info = client.log.main.info(last_known_id='...')
>>> log_warning = client.log.main.warning(last_known_id='...')

peers(last_known_id=None, **kwargs)#: Implements log_peers()

class qbittorrentapi.log.LogPeersList(list_entries, client=None)#

Bases: List

Response for log_peers()

class qbittorrentapi.log.LogPeer(data=None, client=None)#

Bases: ListEntry

Item in LogPeersList

class qbittorrentapi.log.LogMainList(list_entries, client=None)#

Bases: List

Response to log_main()

class qbittorrentapi.log.LogEntry(data=None, client=None)#

Bases: ListEntry

Item in LogMainList

Request (internal)#

class qbittorrentapi.request.Request(host='', port=None, username=None, password=None, **kwargs)#

Bases: object

Facilitates HTTP requests to qBittorrent’s Web API.

_cast(response, response_class, **response_kwargs)#

Returns the API response casted to the requested class.

Parameters:

response – requests Response from API
response_class – class to return response as; if none, response is returned
response_kwargs – request-specific configuration for response

Returns:

API response as type of response_class

_get(_name=APINames.EMPTY, _method='', requests_args=None, requests_params=None, headers=None, params=None, data=None, files=None, response_class=None, **kwargs)#

Send GET request.

Parameters:

api_namespace – the namespace for the API endpoint (e.g. APINames or torrents)
api_method – the name for the API endpoint (e.g. add)
kwargs – see _request()

Returns:

Requests Response

static _get_data(http_method, params=None, data=None, files=None, **kwargs)#

Determine data, params, and files for the Requests call.

Parameters:

http_method – get or post
params – key value pairs to send with GET calls
data – key value pairs to send with POST calls
files – dictionary of files to send with request

Returns:

final dictionaries of data to send to qBittorrent

static _get_headers(headers=None, more_headers=None)#

Determine headers specific to this request. Request headers can be specified explicitly or with the requests kwargs. Headers specified in self._EXTRA_HEADERS are merged in Requests itself.

Parameters:

headers – headers specified for this specific request
more_headers – headers from requests_kwargs arguments

Returns:

final dictionary of headers for this specific request

_get_requests_kwargs(requests_args=None, requests_params=None)#

Determine the requests_kwargs for the call to Requests. The global configuration in self._REQUESTS_ARGS is updated by any arguments provided for a specific call.

Parameters:

requests_args – default location to expect Requests requests_kwargs
requests_params – alternative location to expect Requests requests_kwargs

Returns:

final dictionary of Requests requests_kwargs

static _get_response_kwargs(kwargs)#

Determine the kwargs for managing the response to return.

Parameters:: kwargs – extra keywords arguments to be passed along in request
Returns:: sanitized arguments

static _handle_error_responses(data, params, response)#: Raise proper exception if qBittorrent returns Error HTTP Status.

_initialize_context()#

Initialize and/or reset communications context with qBittorrent.

This is necessary on startup or when the authorization cookie needs to be replaced…perhaps because it expired, qBittorrent was restarted, significant settings changes, etc.

_initialize_lesser(EXTRA_HEADERS=None, REQUESTS_ARGS=None, VERIFY_WEBUI_CERTIFICATE=True, FORCE_SCHEME_FROM_HOST=False, RAISE_UNIMPLEMENTEDERROR_FOR_UNIMPLEMENTED_API_ENDPOINTS=False, RAISE_NOTIMPLEMENTEDERROR_FOR_UNIMPLEMENTED_API_ENDPOINTS=False, RAISE_ERROR_FOR_UNSUPPORTED_QBITTORRENT_VERSIONS=False, VERBOSE_RESPONSE_LOGGING=False, PRINT_STACK_FOR_EACH_REQUEST=False, SIMPLE_RESPONSES=False, DISABLE_LOGGING_DEBUG_OUTPUT=False, MOCK_WEB_API_VERSION=None)#: Initialize lesser used configuration.

classmethod _list2string(input_list=None, delimiter='|')#

Convert entries in a list to a concatenated string.

Parameters:

input_list – list to convert
delimiter – delimiter for concatenation

Returns:

if input is a list, concatenated string…else whatever the input was

_post(_name=APINames.EMPTY, _method='', requests_args=None, requests_params=None, headers=None, params=None, data=None, files=None, response_class=None, **kwargs)#

Send POST request.

Parameters:

api_namespace – the namespace for the API endpoint (e.g. APINames or torrents)
api_method – the name for the API endpoint (e.g. add)
kwargs – see _request()

Returns:

Requests Response

_request(http_method, api_namespace, api_method, requests_args=None, requests_params=None, headers=None, params=None, data=None, files=None, response_class=None, **kwargs)#

Meat and potatoes of sending requests to qBittorrent.

Parameters:

http_method – get or post
api_namespace – the namespace for the API endpoint (e.g. APINames or torrents)
api_method – the name for the API endpoint (e.g. add)
requests_args – default location for Requests kwargs
requests_params – alternative location for Requests kwargs
headers – HTTP headers to send with the request
params – key/value pairs to send with a GET request
data – key/value pairs to send with a POST request
files – files to be sent with the request
response_class – class to use to cast the API response
kwargs – arbitrary keyword arguments to send with the request

Returns:

Requests Response

_request_manager(http_method, api_namespace, api_method, _retries=1, _retry_backoff_factor=0.3, requests_args=None, requests_params=None, headers=None, params=None, data=None, files=None, response_class=None, **kwargs)#

Wrapper to manage request retries and severe exceptions.

This should retry at least once to account for the Web API switching from HTTP to HTTPS. During the second attempt, the URL is rebuilt using HTTP or HTTPS as appropriate.

property _session#

Create or return existing HTTP session.

Returns:: Requests Session object

_trigger_session_initialization()#

Effectively resets the HTTP session by removing the reference to it.

During the next request, a new session will be created.

_verbose_logging(http_method, url, data, params, requests_kwargs, response)#

Log verbose information about request.

Can be useful during development.

class qbittorrentapi.request.URL(client)#

Bases: object

Management for the qBittorrent Web API URL.

build_base_url(headers, requests_kwargs=None)#

Determine the Base URL for the Web API endpoints.

A URL is only actually built here if it’s the first time here or the context was re-initialized. Otherwise, the most recently built URL is used.

If the user doesn’t provide a scheme for the URL, it will try HTTP first and fall back to HTTPS if that doesn’t work. While this is probably backwards, qBittorrent or an intervening proxy can simply redirect to HTTPS and that’ll be respected.

Additionally, if users want to augment the path to the API endpoints, any path provided here will be preserved in the returned Base URL and prefixed to all subsequent API calls.

Parameters:

headers – HTTP headers for request
requests_kwargs – arguments from user for HTTP HEAD request

Returns:

base URL as a string for Web API endpoint

build_url(api_namespace, api_method, headers, requests_kwargs)#

Create a fully qualified URL for the API endpoint.

Parameters:

api_namespace – the namespace for the API endpoint (e.g. torrents)
api_method – the specific method for the API endpoint (e.g. info)
headers – HTTP headers for request
requests_kwargs – kwargs for any calls to Requests

Returns:

fully qualified URL string for endpoint

build_url_path(api_namespace, api_method)#

Determine the full URL path for the API endpoint.

Parameters:

api_namespace – the namespace for the API endpoint (e.g. torrents)
api_method – the specific method for the API endpoint (e.g. info)

Returns:

entire URL string for API endpoint (e.g. http://localhost:8080/api/v2/torrents/info or http://example.com/qbt/api/v2/torrents/info)

detect_scheme(base_url, default_scheme, alt_scheme, headers, requests_kwargs)#

Determine if the URL endpoint is using HTTP or HTTPS.

Parameters:

base_url – urllib ParseResult URL object
default_scheme – default scheme to use for URL
alt_scheme – alternative scheme to use for URL if default doesn’t work
headers – HTTP headers for request
requests_kwargs – kwargs for calls to Requests

Returns:

scheme (i.e. HTTP or HTTPS)

RSS#

class qbittorrentapi.rss.RSSAPIMixIn(host='', port=None, username=None, password=None, **kwargs)#

Bases: AppAPIMixIn

Implementation of all RSS API methods.

Usage:

>>> from qbittorrentapi import Client
>>> client = Client(host='localhost:8080', username='admin', password='adminadmin')
>>> rss_rules = client.rss_rules()
>>> client.rss_set_rule(rule_name="...", rule_def={...})

rss_add_feed(url=None, item_path=None, **kwargs)#

Add new RSS feed. Folders in path must already exist.

Raises:

Conflict409Error –

Parameters:

url – URL of RSS feed (e.g https://distrowatch.com/news/torrents.xml)
item_path – Name and/or path for new feed (e.g. Folder\Subfolder\FeedName)

Returns:

None

rss_add_folder(folder_path=None, **kwargs)#

Add an RSS folder. Any intermediate folders in path must already exist.

Raises:: Conflict409Error –
Parameters:: folder_path – path to new folder (e.g. Linux\ISOs)
Returns:: None

rss_items(include_feed_data=None, **kwargs)#

Retrieve RSS items and optionally feed data.

Parameters:: include_feed_data – True or false to include feed data
Returns:: RSSitemsDictionary

rss_mark_as_read(item_path=None, article_id=None, **kwargs)#

Mark RSS article as read. If article ID is not provider, the entire feed is marked as read.

Raises:

NotFound404Error –

Parameters:

item_path – path to item to be refreshed (e.g. Folder\Subfolder\ItemName)
article_id – article ID from rss_items()

Returns:

None

rss_matching_articles(rule_name=None, **kwargs)#

Fetch all articles matching a rule.

Parameters:: rule_name – Name of rule to return matching articles
Returns:: RSSitemsDictionary

rss_move_item(orig_item_path=None, new_item_path=None, **kwargs)#

Move/rename an RSS item (folder, feed, etc).

Raises:

Conflict409Error –

Parameters:

orig_item_path – path to item to be removed (e.g. Folder\Subfolder\ItemName)
new_item_path – path to item to be removed (e.g. Folder\Subfolder\ItemName)

Returns:

None

rss_refresh_item(item_path=None, **kwargs)#

Trigger a refresh for an RSS item.

Note: qBittorrent v4.1.5 thru v4.1.8 all use Web API 2.2. However, this endpoint was introduced with v4.1.8; so, behavior may be undefined for these versions.

Parameters:: item_path – path to item to be refreshed (e.g. Folder\Subfolder\ItemName)
Returns:: None

rss_remove_item(item_path=None, **kwargs)#

Remove an RSS item (folder, feed, etc).

NOTE: Removing a folder also removes everything in it.

Raises:: Conflict409Error –
Parameters:: item_path – path to item to be removed (e.g. Folder\Subfolder\ItemName)
Returns:: None

rss_remove_rule(rule_name=None, **kwargs)#

Delete a RSS auto-downloading rule.

Parameters:: rule_name – Name of rule to delete
Returns:: None

rss_rename_rule(orig_rule_name=None, new_rule_name=None, **kwargs)#

Rename an RSS auto-download rule.

Note: this endpoint did not work properly until qBittorrent v4.3.0

Parameters:

orig_rule_name – current name of rule
new_rule_name – new name for rule

Returns:

None

rss_rules(**kwargs)#

Retrieve RSS auto-download rule definitions.

Returns:: RSSRulesDictionary

rss_setFeedURL(url=None, item_path=None, **kwargs)#

Update the URL for an existing RSS feed.

Raises:

Conflict409Error –

Parameters:

url – URL of RSS feed (e.g https://distrowatch.com/news/torrents.xml)
item_path – Name and/or path for feed (e.g. Folder\Subfolder\FeedName)

Returns:

None

rss_set_feed_url(url=None, item_path=None, **kwargs)#

Update the URL for an existing RSS feed.

Raises:

Conflict409Error –

Parameters:

url – URL of RSS feed (e.g https://distrowatch.com/news/torrents.xml)
item_path – Name and/or path for feed (e.g. Folder\Subfolder\FeedName)

Returns:

None

rss_set_rule(rule_name=None, rule_def=None, **kwargs)#

Create a new RSS auto-downloading rule.

Parameters:

rule_name – name for new rule
rule_def – dictionary with rule fields - https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#set-auto-downloading-rule

Returns:

None

class qbittorrentapi.rss.RSS(client)#

Allows interaction with RSS API endpoints.

Usage:

>>> from qbittorrentapi import Client
>>> client = Client(host='localhost:8080', username='admin', password='adminadmin')
>>> # this is all the same attributes that are available as named in the
>>> #  endpoints or the more pythonic names in Client (with or without 'log_' prepended)
>>> rss_rules = client.rss.rules
>>> client.rss.addFolder(folder_path="TPB")
>>> client.rss.addFeed(url='...', item_path="TPB\Top100")
>>> client.rss.remove_item(item_path="TPB") # deletes TPB and Top100
>>> client.rss.set_rule(rule_name="...", rule_def={...})
>>> items = client.rss.items.with_data
>>> items_no_data = client.rss.items.without_data

add_feed(url=None, item_path=None, **kwargs)#: Implements rss_add_feed()

add_folder(folder_path=None, **kwargs)#: Implements rss_add_folder()

mark_as_read(item_path=None, article_id=None, **kwargs)#: Implements rss_mark_as_read()

matching_articles(rule_name=None, **kwargs)#: Implements rss_matching_articles()

move_item(orig_item_path=None, new_item_path=None, **kwargs)#: Implements rss_move_item()

refresh_item(item_path=None)#: Implements rss_refresh_item()

remove_item(item_path=None, **kwargs)#: Implements rss_remove_item()

remove_rule(rule_name=None, **kwargs)#: Implements rss_remove_rule()

rename_rule(orig_rule_name=None, new_rule_name=None, **kwargs)#: Implements rss_rename_rule()

property rules#: Implements rss_rules()

setFeedURL(url=None, item_path=None, **kwargs)#: Implements rss_set_feed_url()

set_feed_url(url=None, item_path=None, **kwargs)#: Implements rss_set_feed_url()

set_rule(rule_name=None, rule_def=None, **kwargs)#: Implements rss_set_rule()

class qbittorrentapi.rss.RSSitemsDictionary(data=None, client=None)#

Bases: Dictionary

Response for rss_items()

class qbittorrentapi.rss.RSSRulesDictionary(data=None, client=None)#

Bases: Dictionary

Response for rss_rules()

Search#

class qbittorrentapi.search.SearchAPIMixIn(host='', port=None, username=None, password=None, **kwargs)#

Bases: AppAPIMixIn

Implementation for all Search API methods.

Usage:

>>> from qbittorrentapi import Client
>>> client = Client(host='localhost:8080', username='admin', password='adminadmin')
>>> search_job = client.search_start(pattern='Ubuntu', plugins='all', category='all')
>>> client.search_stop(search_id=search_job.id)
>>> # or
>>> search_job.stop()
>>>

search_categories(plugin_name=None, **kwargs)#

Retrieve categories for search.

Note: endpoint was removed in qBittorrent v4.3.0

Parameters:: plugin_name – Limit categories returned by plugin(s) (supports all and enabled)
Returns:: SearchCategoriesList

search_delete(search_id=None, **kwargs)#

Delete a search job.

Raises:: NotFound404Error –
Parameters:: search_id – ID of search to delete
Returns:: None

search_enable_plugin(plugins=None, enable=None, **kwargs)#

Enable or disable search plugin(s).

Parameters:

plugins – list of plugin names
enable – True or False

Returns:

None

search_install_plugin(sources=None, **kwargs)#

Install search plugins from either URL or file.

Parameters:: sources – list of URLs or filepaths
Returns:: None

search_plugins(**kwargs)#

Retrieve details of search plugins.

Returns:: SearchPluginsList - https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-search-plugins

search_results(search_id=None, limit=None, offset=None, **kwargs)#

Retrieve the results for the search.

Raises:

NotFound404Error –
Conflict409Error –

Parameters:

search_id – ID of search job
limit – number of results to return
offset – where to start returning results

Returns:

SearchResultsDictionary - https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-search-results

search_start(pattern=None, plugins=None, category=None, **kwargs)#

Start a search. Python must be installed. Host may limit number of concurrent searches.

Raises:

Conflict409Error –

Parameters:

pattern – term to search for
plugins – list of plugins to use for searching (supports ‘all’ and ‘enabled’)
category – categories to limit search; dependent on plugins. (supports ‘all’)

Returns:

SearchJobDictionary

search_status(search_id=None, **kwargs)#

Retrieve status of one or all searches.

Raises:: NotFound404Error –
Parameters:: search_id – ID of search to get status; leave empty for status of all jobs
Returns:: SearchStatusesList - https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-search-status

search_stop(search_id=None, **kwargs)#

Stop a running search.

Raises:: NotFound404Error –
Parameters:: search_id – ID of search job to stop
Returns:: None

search_uninstall_plugin(names=None, **kwargs)#

Uninstall search plugins.

Parameters:: names – names of plugins to uninstall
Returns:: None

search_update_plugins(**kwargs)#

Auto update search plugins.

Returns:: None

class qbittorrentapi.search.Search(*args, **kwargs)#

Allows interaction with Search API endpoints.

Usage:

>>> from qbittorrentapi import Client
>>> client = Client(host='localhost:8080', username='admin', password='adminadmin')
>>> # this is all the same attributes that are available as named in the
>>> #  endpoints or the more pythonic names in Client (with or without 'search_' prepended)
>>> # initiate searches and retrieve results
>>> search_job = client.search.start(pattern='Ubuntu', plugins='all', category='all')
>>> status = search_job.status()
>>> results = search_job.result()
>>> search_job.delete()
>>> # inspect and manage plugins
>>> plugins = client.search.plugins
>>> cats = client.search.categories(plugin_name='...')
>>> client.search.install_plugin(sources='...')
>>> client.search.update_plugins()

categories(plugin_name=None, **kwargs)#: Implements search_categories()

delete(search_id=None, **kwargs)#: Implements search_delete()

enable_plugin(plugins=None, enable=None, **kwargs)#: Implements search_enable_plugin()

install_plugin(sources=None, **kwargs)#: Implements search_install_plugin()

property plugins#: Implements search_plugins()

results(search_id=None, limit=None, offset=None, **kwargs)#: Implements search_results()

start(pattern=None, plugins=None, category=None, **kwargs)#: Implements search_start()

status(search_id=None, **kwargs)#: Implements search_status()

stop(search_id=None, **kwargs)#: Implements search_stop()

uninstall_plugin(sources=None, **kwargs)#: Implements search_uninstall_plugin()

update_plugins(**kwargs)#: Implements search_update_plugins()

class qbittorrentapi.search.SearchJobDictionary(data, client)#

Bases: Dictionary

Response for search_start()

delete(**kwargs)#: Implements search_delete()

results(limit=None, offset=None, **kwargs)#: Implements search_results()

status(**kwargs)#: Implements search_status()

stop(**kwargs)#: Implements search_stop()

class qbittorrentapi.search.SearchResultsDictionary(data=None, client=None)#

Bases: Dictionary

Response for search_results()

class qbittorrentapi.search.SearchStatusesList(list_entries, client=None)#

Bases: List

Response for search_status()

class qbittorrentapi.search.SearchStatus(data=None, client=None)#

Bases: ListEntry

Item in SearchStatusesList

class qbittorrentapi.search.SearchCategoriesList(list_entries, client=None)#

Bases: List

Response for search_categories()

class qbittorrentapi.search.SearchCategory(data=None, client=None)#

Bases: ListEntry

Item in SearchCategoriesList

class qbittorrentapi.search.SearchPluginsList(list_entries, client=None)#

Bases: List

Response for search_plugins()

class qbittorrentapi.search.SearchPlugin(data=None, client=None)#

Bases: ListEntry

Item in SearchPluginsList

Sync#

class qbittorrentapi.sync.SyncAPIMixIn(host='', port=None, username=None, password=None, **kwargs)#

Bases: AppAPIMixIn

Implementation of all Sync API Methods.

Usage:

>>> from qbittorrentapi import Client
>>> client = Client(host='localhost:8080', username='admin', password='adminadmin')
>>> maindata = client.sync_maindata(rid="...")
>>> torrent_peers = client.sync_torrent_peers(torrent_hash="...'", rid='...')

sync_maindata(rid=0, **kwargs)#

Retrieves sync data.

Parameters:: rid – response ID
Returns:: SyncMainDataDictionary - https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-main-data

sync_torrent_peers(torrent_hash=None, rid=0, **kwargs)#

Retrieves torrent sync data.

Raises:

NotFound404Error –

Parameters:

torrent_hash – hash for torrent
rid – response ID

Returns:

SyncTorrentPeersDictionary - https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-peers-data

class qbittorrentapi.sync.Sync(client)#

Allows interaction with the Sync API endpoints.

Usage:

>>> from qbittorrentapi import Client
>>> client = Client(host='localhost:8080', username='admin', password='adminadmin')
>>> # these are all the same attributes that are available as named in the
>>> #  endpoints or the more pythonic names in Client (with or without 'sync_' prepended)
>>> maindata = client.sync.maindata(rid="...")
>>> # for use when continuously calling maindata for changes in torrents
>>> # this will automatically request the changes since the last call
>>> md = client.sync.maindata.delta()
>>> #
>>> torrentPeers = client.sync.torrentPeers(hash="...'", rid='...')
>>> torrent_peers = client.sync.torrent_peers(hash="...'", rid='...')

class qbittorrentapi.sync.SyncMainDataDictionary(data=None, client=None)#

Bases: Dictionary

Response for sync_maindata()

class qbittorrentapi.sync.SyncTorrentPeersDictionary(data=None, client=None)#

Bases: Dictionary

Response for sync_torrent_peers()

Torrents#

class qbittorrentapi.torrents.TorrentsAPIMixIn(host='', port=None, username=None, password=None, **kwargs)#

Bases: AppAPIMixIn

Implementation of all Torrents API methods.

Usage:

>>> from qbittorrentapi import Client
>>> client = Client(host='localhost:8080', username='admin', password='adminadmin')
>>> client.torrents_add(urls='...')
>>> client.torrents_reannounce()

torrents_add(urls=None, torrent_files=None, save_path=None, cookie=None, category=None, is_skip_checking=None, is_paused=None, is_root_folder=None, rename=None, upload_limit=None, download_limit=None, use_auto_torrent_management=None, is_sequential_download=None, is_first_last_piece_priority=None, tags=None, content_layout=None, ratio_limit=None, seeding_time_limit=None, download_path=None, use_download_path=None, stop_condition=None, **kwargs)#

Add one or more torrents by URLs and/or torrent files.

Raises:

UnsupportedMediaType415Error – if file is not a valid torrent file
TorrentFileNotFoundError – if a torrent file doesn’t exist
TorrentFilePermissionError – if read permission is denied to torrent file

Parameters:

urls – single instance or an iterable of URLs (http://, https://, magnet:, bc://bt/)
torrent_files –
several options are available to send torrent files to qBittorrent:
- single instance of bytes: useful if torrent file already read from disk or downloaded from internet.
- single instance of file handle to torrent file: use open(<filepath>, 'rb') to open the torrent file.
- single instance of a filepath to torrent file: e.g. /home/user/torrent_filename.torrent
- an iterable of the single instances above to send more than one torrent file
- dictionary with key/value pairs of torrent name and single instance of above object
Note: The torrent name in a dictionary is useful to identify which torrent file errored. qBittorrent provides back that name in the error text. If a torrent name is not provided, then the name of the file will be used. And in the case of bytes (or if filename cannot be determined), the value ‘torrent__n’ will be used.
save_path – location to save the torrent data
cookie – cookie to retrieve torrents by URL
category – category to assign to torrent(s)
is_skip_checking – True to skip hash checking
is_paused – True to add the torrent(s) without starting their downloading
is_root_folder – True or False to create root folder (superseded by content_layout with v4.3.2)
rename – new name for torrent(s)
upload_limit – upload limit in bytes/second
download_limit – download limit in bytes/second
use_auto_torrent_management – True or False to use automatic torrent management
is_sequential_download – True or False for sequential download
is_first_last_piece_priority – True or False for first and last piece download priority
tags – tag(s) to assign to torrent(s) (added in Web API 2.6.2)
content_layout – Original, Subfolder, or NoSubfolder to control filesystem structure for content (added in Web API 2.7)
ratio_limit – share limit as ratio of upload amt over download amt; e.g. 0.5 or 2.0 (added in Web API 2.8.1)
seeding_time_limit – number of minutes to seed torrent (added in Web API 2.8.1)
download_path – location to download torrent content before moving to save_path (added in Web API 2.8.4)
use_download_path – True or False whether download_path should be used…defaults to True if download_path is specified (added in Web API 2.8.4)
stop_condition – MetadataReceived or FilesChecked to stop the torrent when started automatically (added in Web API 2.8.15)

Returns:

Ok. for success and Fails. for failure

torrents_add_peers(peers=None, torrent_hashes=None, **kwargs)#

Add one or more peers to one or more torrents.

Raises:

InvalidRequest400Error – for invalid peers

Parameters:

peers – one or more peers to add. each peer should take the form ‘host:port’
torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.

Returns:

TorrentsAddPeersDictionary - {<hash>: {'added': #, 'failed': #}}

torrents_add_tags(tags=None, torrent_hashes=None, **kwargs)#

Add one or more tags to one or more torrents.

Note: Tags that do not exist will be created on-the-fly.

Parameters:

tags – tag name or list of tags
torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.

Returns:

None

torrents_add_trackers(torrent_hash=None, urls=None, **kwargs)#

Add trackers to a torrent.

Raises:

NotFound404Error –

Parameters:

torrent_hash – hash for torrent
urls – tracker URLs to add to torrent

Returns:

None

torrents_bottom_priority(torrent_hashes=None, **kwargs)#

Set torrent as lowest priority. Torrent Queuing must be enabled.

Raises:: Conflict409Error –
Parameters:: torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.
Returns:: None

torrents_categories(**kwargs)#

Retrieve all category definitions.

Note: torrents/categories is not available until v2.1.0

Returns:: TorrentCategoriesDictionary

torrents_create_category(name=None, save_path=None, download_path=None, enable_download_path=None, **kwargs)#

Create a new torrent category.

Raises:

Conflict409Error – if category name is not valid or unable to create

Parameters:

name – name for new category
save_path – location to save torrents for this category (added in Web API 2.1.0)
download_path – download location for torrents with this category
enable_download_path – True or False to enable or disable download path

Returns:

None

torrents_create_tags(tags=None, **kwargs)#

Create one or more tags.

Parameters:: tags – tag name or list of tags
Returns:: None

torrents_decrease_priority(torrent_hashes=None, **kwargs)#

Decrease the priority of a torrent. Torrent Queuing must be enabled.

Raises:: Conflict409Error –
Parameters:: torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.
Returns:: None

torrents_delete(delete_files=False, torrent_hashes=None, **kwargs)#

Remove a torrent from qBittorrent and optionally delete its files.

Parameters:

torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.
delete_files – True to delete the torrent’s files

Returns:

None

torrents_delete_tags(tags=None, **kwargs)#

Delete one or more tags.

Parameters:: tags – tag name or list of tags
Returns:: None

torrents_download_limit(torrent_hashes=None, **kwargs)#

Retrieve the download limit for one or more torrents.

Returns:: TorrentLimitsDictionary - {hash: limit} (-1 represents no limit)

torrents_edit_category(name=None, save_path=None, download_path=None, enable_download_path=None, **kwargs)#

Edit an existing category.

Note: torrents/editCategory was introduced in Web API 2.1.0

Raises:

Conflict409Error – if category name is not valid or unable to create

Parameters:

name – category to edit
save_path – new location to save files for this category
download_path – download location for torrents with this category
enable_download_path – True or False to enable or disable download path

Returns:

None

torrents_edit_tracker(torrent_hash=None, original_url=None, new_url=None, **kwargs)#

Replace a torrent’s tracker with a different one.

Raises:

Parameters:

torrent_hash – hash for torrent
original_url – URL for existing tracker
new_url – new URL to replace

Returns:

None

torrents_export(torrent_hash=None, **kwargs)#

Export a .torrent file for the torrent.

Raises:

NotFound404Error – torrent not found
Conflict409Error – unable to export .torrent file

Parameters:

torrent_hash – hash for torrent

Returns:

bytes .torrent file

torrents_file_priority(torrent_hash=None, file_ids=None, priority=None, **kwargs)#

Set priority for one or more files.

Raises:

InvalidRequest400Error – if priority is invalid or at least one file ID is not an integer
NotFound404Error –
Conflict409Error – if torrent metadata has not finished downloading or at least one file was not found

Parameters:

torrent_hash – hash for torrent
file_ids – single file ID or a list.
priority – priority for file(s) - https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#set-file-priority

Returns:

None

torrents_files(torrent_hash=None, **kwargs)#

Retrieve individual torrent’s files.

Raises:: NotFound404Error –
Parameters:: torrent_hash – hash for torrent
Returns:: TorrentFilesList - https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-contents

torrents_increase_priority(torrent_hashes=None, **kwargs)#

Increase the priority of a torrent. Torrent Queuing must be enabled.

Raises:: Conflict409Error –
Parameters:: torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.
Returns:: None

torrents_info(status_filter=None, category=None, sort=None, reverse=None, limit=None, offset=None, torrent_hashes=None, tag=None, **kwargs)#

Retrieves list of info for torrents.

Parameters:

status_filter – Filter list by torrent status. all, downloading, seeding, completed, paused active, inactive, resumed, errored Added in Web API 2.4.1: stalled, stalled_uploading, and stalled_downloading Added in Web API 2.8.4: checking Added in Web API 2.8.18: moving
category – Filter list by category
sort – Sort list by any property returned
reverse – Reverse sorting
limit – Limit length of list
offset – Start of list (if < 0, offset from end of list)
torrent_hashes – Filter list by hash (separate multiple hashes with a ‘|’) (added in Web API 2.0.1)
tag – Filter list by tag (empty string means “untagged”; no “tag” parameter means “any tag”; added in Web API 2.8.3)

Returns:

TorrentInfoList - https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-list

torrents_pause(torrent_hashes=None, **kwargs)#

Pause one or more torrents in qBittorrent.

Parameters:: torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.
Returns:: None

torrents_piece_hashes(torrent_hash=None, **kwargs)#

Retrieve individual torrent’s pieces’ hashes.

Raises:: NotFound404Error –
Parameters:: torrent_hash – hash for torrent
Returns:: TorrentPieceInfoList

torrents_piece_states(torrent_hash=None, **kwargs)#

Retrieve individual torrent’s pieces’ states.

Raises:: NotFound404Error –
Parameters:: torrent_hash – hash for torrent
Returns:: TorrentPieceInfoList

torrents_properties(torrent_hash=None, **kwargs)#

Retrieve individual torrent’s properties.

Raises:: NotFound404Error –
Parameters:: torrent_hash – hash for torrent
Returns:: TorrentPropertiesDictionary - https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-generic-properties

torrents_reannounce(torrent_hashes=None, **kwargs)#

Reannounce a torrent.

Note: torrents/reannounce introduced in Web API 2.0.2

Parameters:: torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.
Returns:: None

torrents_recheck(torrent_hashes=None, **kwargs)#

Recheck a torrent in qBittorrent.

Parameters:: torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.
Returns:: None

torrents_remove_categories(categories=None, **kwargs)#

Delete one or more categories.

Parameters:: categories – categories to delete
Returns:: None

torrents_remove_tags(tags=None, torrent_hashes=None, **kwargs)#

Add one or more tags to one or more torrents.

Parameters:

tags – tag name or list of tags
torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.

Returns:

None

torrents_remove_trackers(torrent_hash=None, urls=None, **kwargs)#

Remove trackers from a torrent.

Raises:

NotFound404Error –
Conflict409Error –

Parameters:

torrent_hash – hash for torrent
urls – tracker URLs to removed from torrent

Returns:

None

torrents_rename(torrent_hash=None, new_torrent_name=None, **kwargs)#

Rename a torrent.

Raises:

NotFound404Error –

Parameters:

torrent_hash – hash for torrent
new_torrent_name – new name for torrent

Returns:

None

torrents_rename_file(torrent_hash=None, file_id=None, new_file_name=None, old_path=None, new_path=None, **kwargs)#

Rename a torrent file.

Raises:

Parameters:

torrent_hash – hash for torrent
file_id – id for file (removed in Web API 2.7)
new_file_name – new name for file (removed in Web API 2.7)
old_path – path of file to rename (added in Web API 2.7)
new_path – new path of file to rename (added in Web API 2.7)

Returns:

None

torrents_rename_folder(torrent_hash=None, old_path=None, new_path=None, **kwargs)#

Rename a torrent folder.

Raises:

Parameters:

torrent_hash – hash for torrent
old_path – path of file to rename (added in Web API 2.7)
new_path – new path of file to rename (added in Web API 2.7)

Returns:

None

torrents_resume(torrent_hashes=None, **kwargs)#

Resume one or more torrents in qBittorrent.

Parameters:: torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.
Returns:: None

torrents_setDownloadPath(download_path=None, torrent_hashes=None, **kwargs)#

Set the Download Path for one or more torrents.

Raises:

Forbidden403Error – cannot write to directory
Conflict409Error – directory cannot be created

Parameters:

download_path – file path to save torrent contents before torrent finishes downloading
torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.

torrents_setSavePath(save_path=None, torrent_hashes=None, **kwargs)#

Set the Save Path for one or more torrents.

Raises:

Forbidden403Error – cannot write to directory
Conflict409Error – directory cannot be created

Parameters:

save_path – file path to save torrent contents
torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.

torrents_set_auto_management(enable=None, torrent_hashes=None, **kwargs)#

Enable or disable automatic torrent management for one or more torrents.

Parameters:

torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.
enable – True or False

Returns:

None

torrents_set_category(category=None, torrent_hashes=None, **kwargs)#

Set a category for one or more torrents.

Raises:

Conflict409Error – for bad category

Parameters:

torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.
category – category to assign to torrent

Returns:

None

torrents_set_download_limit(limit=None, torrent_hashes=None, **kwargs)#

Set the download limit for one or more torrents.

Parameters:

torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.
limit – bytes/second (-1 sets the limit to infinity)

Returns:

None

torrents_set_download_path(download_path=None, torrent_hashes=None, **kwargs)#

Set the Download Path for one or more torrents.

Raises:

Forbidden403Error – cannot write to directory
Conflict409Error – directory cannot be created

Parameters:

download_path – file path to save torrent contents before torrent finishes downloading
torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.

torrents_set_force_start(enable=None, torrent_hashes=None, **kwargs)#

Force start one or more torrents.

Parameters:

torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.
enable – True or False (False makes this equivalent to torrents_resume())

Returns:

None

torrents_set_location(location=None, torrent_hashes=None, **kwargs)#

Set location for torrents’ files.

Raises:

Forbidden403Error – if the user doesn’t have permissions to write to the location (only before v4.5.2 - write check was removed.)
Conflict409Error – if the directory cannot be created at the location

Parameters:

torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.
location – disk location to move torrent’s files

Returns:

None

torrents_set_save_path(save_path=None, torrent_hashes=None, **kwargs)#

Set the Save Path for one or more torrents.

Raises:

Forbidden403Error – cannot write to directory
Conflict409Error – directory cannot be created

Parameters:

save_path – file path to save torrent contents
torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.

torrents_set_share_limits(ratio_limit=None, seeding_time_limit=None, torrent_hashes=None, **kwargs)#

Set share limits for one or more torrents.

Parameters:

torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.
ratio_limit – max ratio to seed a torrent. (-2 means use the global value and -1 is no limit)
seeding_time_limit – minutes (-2 means use the global value and -1 is no limit)

Returns:

None

torrents_set_super_seeding(enable=None, torrent_hashes=None, **kwargs)#

Set one or more torrents as super seeding.

Parameters:

torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.
enable – True or False

Returns:

torrents_set_upload_limit(limit=None, torrent_hashes=None, **kwargs)#

Set the upload limit for one or more torrents.

Parameters:

torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.
limit – bytes/second (-1 sets the limit to infinity)

Returns:

None

torrents_tags(**kwargs)#

Retrieve all tag definitions.

Returns:: TagList

torrents_toggle_first_last_piece_priority(torrent_hashes=None, **kwargs)#

Toggle priority of first/last piece downloading.

Parameters:: torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.
Returns:: None

torrents_toggle_sequential_download(torrent_hashes=None, **kwargs)#

Toggle sequential download for one or more torrents.

Parameters:: torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.
Returns:: None

torrents_top_priority(torrent_hashes=None, **kwargs)#

Set torrent as highest priority. Torrent Queuing must be enabled.

Raises:: Conflict409Error –
Parameters:: torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.
Returns:: None

torrents_trackers(torrent_hash=None, **kwargs)#

Retrieve individual torrent’s trackers. Tracker status is defined in TrackerStatus.

Raises:: NotFound404Error –
Parameters:: torrent_hash – hash for torrent
Returns:: TrackersList - https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-trackers

torrents_upload_limit(torrent_hashes=None, **kwargs)#

Retrieve the upload limit for one or more torrents.

Parameters:: torrent_hashes – single torrent hash or list of torrent hashes. Or all for all torrents.
Returns:: TorrentLimitsDictionary

torrents_webseeds(torrent_hash=None, **kwargs)#

Retrieve individual torrent’s web seeds.

Raises:: NotFound404Error –
Parameters:: torrent_hash – hash for torrent
Returns:: WebSeedsList - https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-web-seeds

class qbittorrentapi.torrents.Torrents(client)#

Allows interaction with the Torrents API endpoints.

Usage:

>>> from qbittorrentapi import Client
>>> client = Client(host='localhost:8080', username='admin', password='adminadmin')
>>> # these are all the same attributes that are available as named in the
>>> #  endpoints or the more pythonic names in Client (with or without 'torrents_' prepended)
>>> torrent_list = client.torrents.info()
>>> torrent_list_active = client.torrents.info.active()
>>> torrent_list_active_partial = client.torrents.info.active(limit=100, offset=200)
>>> torrent_list_downloading = client.torrents.info.downloading()
>>> # torrent looping
>>> for torrent in client.torrents.info.completed()
>>> # all torrents endpoints with a 'hashes' parameters support all method to apply action to all torrents
>>> client.torrents.pause.all()
>>> client.torrents.resume.all()
>>> # or specify the individual hashes
>>> client.torrents.downloadLimit(torrent_hashes=['...', '...'])

add(urls=None, torrent_files=None, save_path=None, cookie=None, category=None, is_skip_checking=None, is_paused=None, is_root_folder=None, rename=None, upload_limit=None, download_limit=None, use_auto_torrent_management=None, is_sequential_download=None, is_first_last_piece_priority=None, tags=None, content_layout=None, ratio_limit=None, seeding_time_limit=None, download_path=None, use_download_path=None, stop_condition=None, **kwargs)#

class qbittorrentapi.torrents.TorrentDictionary(data, client)#

Bases: Dictionary

Item in TorrentInfoList. Allows interaction with individual torrents via the Torrents API endpoints.

Usage:

>>> from qbittorrentapi import Client
>>> client = Client(host='localhost:8080', username='admin', password='adminadmin')
>>> # these are all the same attributes that are available as named in the
>>> #  endpoints or the more pythonic names in Client (with or without 'transfer_' prepended)
>>> torrent = client.torrents.info()[0]
>>> torrent_hash = torrent.info.hash
>>> # Attributes without inputs and a return value are properties
>>> properties = torrent.properties
>>> trackers = torrent.trackers
>>> files = torrent.files
>>> # Action methods
>>> torrent.edit_tracker(original_url="...", new_url="...")
>>> torrent.remove_trackers(urls='http://127.0.0.2/')
>>> torrent.rename(new_torrent_name="...")
>>> torrent.resume()
>>> torrent.pause()
>>> torrent.recheck()
>>> torrent.torrents_top_priority()
>>> torrent.setLocation(location='/home/user/torrents/')
>>> torrent.setCategory(category='video')

add_tags(tags=None, **kwargs)#: Implements torrents_add_tags()

add_trackers(urls=None, **kwargs)#: Implements torrents_add_trackers()

bottom_priority(**kwargs)#: Implements torrents_bottom_priority()

decrease_priority(**kwargs)#: Implements torrents_decrease_priority()

delete(delete_files=None, **kwargs)#: Implements torrents_delete()

property download_limit#: Implements torrents_set_download_limit()

edit_tracker(orig_url=None, new_url=None, **kwargs)#: Implements torrents_edit_tracker()

export(**kwargs)#: Implements torrents_export()

file_priority(file_ids=None, priority=None, **kwargs)#: Implements torrents_file_priority()

property files#: Implements torrents_files()

increase_priority(**kwargs)#: Implements torrents_increase_priority()

property info#: Implements torrents_info()

pause(**kwargs)#: Implements torrents_pause()

property piece_hashes#: Implements torrents_piece_hashes()

property piece_states#: Implements torrents_piece_states()

property properties#: Implements torrents_properties()

reannounce(**kwargs)#: Implements torrents_reannounce()

recheck(**kwargs)#: Implements torrents_recheck()

remove_tags(tags=None, **kwargs)#: Implements torrents_remove_tags()

remove_trackers(urls=None, **kwargs)#: Implements torrents_remove_trackers()

rename(new_name=None, **kwargs)#: Implements torrents_rename()

rename_file(file_id=None, new_file_name=None, old_path=None, new_path=None, **kwargs)#: Implements torrents_rename_file()

rename_folder(old_path=None, new_path=None, **kwargs)#: Implements torrents_rename_folder()

resume(**kwargs)#: Implements torrents_resume()

setDownloadPath(download_path=None, **kwargs)#: Implements torrents_set_download_path()

setSavePath(save_path=None, **kwargs)#: Implements torrents_set_save_path()

set_auto_management(enable=None, **kwargs)#: Implements torrents_set_auto_management()

set_category(category=None, **kwargs)#: Implements torrents_set_category()

set_download_limit(limit=None, **kwargs)#: Implements torrents_set_download_limit()

set_download_path(download_path=None, **kwargs)#: Implements torrents_set_download_path()

set_force_start(enable=None, **kwargs)#: Implements torrents_set_force_start()

set_location(location=None, **kwargs)#: Implements torrents_set_location()

set_save_path(save_path=None, **kwargs)#: Implements torrents_set_save_path()

set_share_limits(ratio_limit=None, seeding_time_limit=None, **kwargs)#: Implements torrents_set_share_limits()

set_super_seeding(enable=None, **kwargs)#: Implements torrents_set_super_seeding()

set_upload_limit(limit=None, **kwargs)#: Implements torrents_set_upload_limit()

property state_enum#: Returns the state of a TorrentState.

sync_local()#: Update local cache of torrent info.

toggle_first_last_piece_priority(**kwargs)#: Implements torrents_toggle_first_last_piece_priority()

toggle_sequential_download(**kwargs)#: Implements torrents_toggle_sequential_download()

top_priority(**kwargs)#: Implements torrents_top_priority()

property trackers#: Implements torrents_trackers()

property upload_limit#: Implements torrents_upload_limit()

property webseeds#: Implements torrents_webseeds()

class qbittorrentapi.torrents.TorrentCategories(*args, **kwargs)#

Bases: ClientCache

Allows interaction with torrent categories within the Torrents API endpoints.

Usage:

>>> from qbittorrentapi import Client
>>> client = Client(host='localhost:8080', username='admin', password='adminadmin')
>>> # these are all the same attributes that are available as named in the
>>> #  endpoints or the more pythonic names in Client (with or without 'torrents_' prepended)
>>> categories = client.torrent_categories.categories
>>> # create or edit categories
>>> client.torrent_categories.create_category(name='Video', save_path='/home/user/torrents/Video')
>>> client.torrent_categories.edit_category(name='Video', save_path='/data/torrents/Video')
>>> # edit or create new by assignment
>>> client.torrent_categories.categories = dict(name='Video', save_path='/hone/user/')
>>> # delete categories
>>> client.torrent_categories.removeCategories(categories='Video')
>>> client.torrent_categories.removeCategories(categories=['Audio', "ISOs"])

property categories#: Implements torrents_categories()

create_category(name=None, save_path=None, download_path=None, enable_download_path=None, **kwargs)#: Implements torrents_create_category()

edit_category(name=None, save_path=None, download_path=None, enable_download_path=None, **kwargs)#: Implements torrents_edit_category()

remove_categories(categories=None, **kwargs)#: Implements torrents_remove_categories()

class qbittorrentapi.torrents.TorrentTags(*args, **kwargs)#

Bases: ClientCache

Allows interaction with torrent tags within the “Torrent” API endpoints.

Usage:

>>> from qbittorrentapi import Client
>>> client = Client(host='localhost:8080', username='admin', password='adminadmin')
>>> tags = client.torrent_tags.tags
>>> client.torrent_tags.tags = 'tv show'  # create category
>>> client.torrent_tags.create_tags(tags=['tv show', 'linux distro'])
>>> client.torrent_tags.delete_tags(tags='tv show')

add_tags(tags=None, torrent_hashes=None, **kwargs)#: Implements torrents_add_tags()

create_tags(tags=None, **kwargs)#: Implements torrents_create_tags()

delete_tags(tags=None, **kwargs)#: Implements torrents_delete_tags()

remove_tags(tags=None, torrent_hashes=None, **kwargs)#: Implements torrents_remove_tags()

property tags#: Implements torrents_tags()

class qbittorrentapi.torrents.TorrentPropertiesDictionary(data=None, client=None)#

Bases: Dictionary

Response to torrents_properties()

class qbittorrentapi.torrents.TorrentLimitsDictionary(data=None, client=None)#

Bases: Dictionary

Response to torrents_download_limit()

class qbittorrentapi.torrents.TorrentCategoriesDictionary(data=None, client=None)#

Bases: Dictionary

Response to torrents_categories()

class qbittorrentapi.torrents.TorrentsAddPeersDictionary(data=None, client=None)#

Bases: Dictionary

Response to torrents_add_peers()

class qbittorrentapi.torrents.TorrentFilesList(list_entries, client=None)#

Bases: List

Response to torrents_files()

class qbittorrentapi.torrents.TorrentFile(data=None, client=None)#

Bases: ListEntry

Item in TorrentFilesList

class qbittorrentapi.torrents.WebSeedsList(list_entries, client=None)#

Bases: List

Response to torrents_webseeds()

class qbittorrentapi.torrents.WebSeed(data=None, client=None)#

Bases: ListEntry

Item in WebSeedsList

class qbittorrentapi.torrents.TrackersList(list_entries, client=None)#

Bases: List

Response to torrents_trackers()

class qbittorrentapi.torrents.Tracker(data=None, client=None)#

Bases: ListEntry

Item in TrackersList

class qbittorrentapi.torrents.TorrentInfoList(list_entries, client=None)#

Bases: List

Response to torrents_info()

class qbittorrentapi.torrents.TorrentPieceInfoList(list_entries, client=None)#

Bases: List

Response to torrents_piece_states() and torrents_piece_hashes()

class qbittorrentapi.torrents.TorrentPieceData(data=None, client=None)#

Bases: ListEntry

Item in TorrentPieceInfoList

class qbittorrentapi.torrents.TagList(list_entries, client=None)#

Bases: List

Response to torrents_tags()

class qbittorrentapi.torrents.Tag(data=None, client=None)#

Bases: ListEntry

Item in TagList

Transfer#

class qbittorrentapi.transfer.TransferAPIMixIn(host='', port=None, username=None, password=None, **kwargs)#

Bases: AppAPIMixIn

Implementation of all Transfer API methods.

Usage:

>>> from qbittorrentapi import Client
>>> client = Client(host='localhost:8080', username='admin', password='adminadmin')
>>> transfer_info = client.transfer_info()
>>> client.transfer_set_download_limit(limit=1024000)

transfer_ban_peers(peers=None, **kwargs)#

Ban one or more peers.

Parameters:: peers – one or more peers to ban. each peer should take the form ‘host:port’
Returns:: None

transfer_download_limit(**kwargs)#

Retrieves download limit. 0 is unlimited.

Returns:: integer

transfer_info(**kwargs)#

Retrieves the global transfer info found in qBittorrent status bar.

Returns:: TransferInfoDictionary - https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-global-transfer-info

transfer_setSpeedLimitsMode(intended_state=None, **kwargs)#

Sets whether alternative speed limits are enabled.

Parameters:: intended_state – True to enable alt speed and False to disable. Leaving None will toggle the current state.
Returns:: None

transfer_set_download_limit(limit=None, **kwargs)#

Set the global download limit in bytes/second.

Parameters:: limit – download limit in bytes/second (0 or -1 for no limit)
Returns:: None

transfer_set_speed_limits_mode(intended_state=None, **kwargs)#

Sets whether alternative speed limits are enabled.

Parameters:: intended_state – True to enable alt speed and False to disable. Leaving None will toggle the current state.
Returns:: None

transfer_set_upload_limit(limit=None, **kwargs)#

Set the global download limit in bytes/second.

Parameters:: limit – upload limit in bytes/second (0 or -1 for no limit)
Returns:: None

transfer_speed_limits_mode(**kwargs)#

Retrieves whether alternative speed limits are enabled.

Returns:: 1 if alternative speed limits are currently enabled, 0 otherwise

transfer_toggle_speed_limits_mode(intended_state=None, **kwargs)#

Sets whether alternative speed limits are enabled.

Parameters:: intended_state – True to enable alt speed and False to disable. Leaving None will toggle the current state.
Returns:: None

transfer_upload_limit(**kwargs)#

Retrieves upload limit. 0 is unlimited.

Returns:: integer

class qbittorrentapi.transfer.Transfer(*args, **kwargs)#

Allows interaction with the Transfer API endpoints.

Usage:

>>> from qbittorrentapi import Client
>>> client = Client(host='localhost:8080', username='admin', password='adminadmin')
>>> # these are all the same attributes that are available as named in the
>>> #  endpoints or the more pythonic names in Client (with or without 'transfer_' prepended)
>>> transfer_info = client.transfer.info
>>> # access and set download/upload limits as attributes
>>> dl_limit = client.transfer.download_limit
>>> # this updates qBittorrent in real-time
>>> client.transfer.download_limit = 1024000
>>> # update speed limits mode to alternate or not
>>> client.transfer.speedLimitsMode = True

ban_peers(peers=None, **kwargs)#: Implements transfer_ban_peers()

property download_limit#: Implements transfer_download_limit()

property info#: Implements transfer_info()

setSpeedLimitsMode(intended_state=None, **kwargs)#: Implements transfer_set_speed_limits_mode()

set_download_limit(limit=None, **kwargs)#: Implements transfer_set_download_limit()

set_speed_limits_mode(intended_state=None, **kwargs)#: Implements transfer_set_speed_limits_mode()

set_upload_limit(limit=None, **kwargs)#: Implements transfer_set_upload_limit()

property speed_limits_mode#: Implements transfer_speed_limits_mode()

toggle_speed_limits_mode(intended_state=None, **kwargs)#: Implements transfer_set_speed_limits_mode()

property upload_limit#: Implements transfer_upload_limit()

class qbittorrentapi.transfer.TransferInfoDictionary(data=None, client=None)#

Bases: Dictionary

Response to transfer_info()

Version#

class qbittorrentapi._version_support.Version#

Allows introspection for whether this Client supports different versions of the qBittorrent application and its Web API.

Note that if a version is not listed as “supported” here, many (if not all) methods are likely to function properly since the Web API is largely backwards and forward compatible…albeit with some notable exceptions.

classmethod is_api_version_supported(api_version)#

Returns whether a version of the qBittorrent Web API is fully supported by this API client.

Parameters:: api_version – version of qBittorrent Web API version such as 2.8.4
Returns:: True or False for whether version is supported

classmethod is_app_version_supported(app_version)#

Returns whether a version of the qBittorrent application is fully supported by this API client.

Parameters:: app_version – version of qBittorrent application such as v4.4.0
Returns:: True or False for whether version is supported

classmethod latest_supported_api_version()#: Returns the most recent version of qBittorrent Web API that is fully supported.

classmethod latest_supported_app_version()#: Returns the most recent version of qBittorrent application that is fully supported.

classmethod supported_api_versions()#: Set of all supported qBittorrent Web API versions.

classmethod supported_app_versions()#: Set of all supported qBittorrent application versions.