Application

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

Implementation of all Application API methods

app_buildInfo(**kwargs)

Retrieve build info. (alias: app_buildInfo)

Returns:Dictionary of build info. Each piece of info is an attribute. Properties: https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-build-info

app_build_info(**kwargs)

Retrieve build info. (alias: app_buildInfo)

Returns:Dictionary of build info. Each piece of info is an attribute. Properties: https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-build-info

app_defaultSavePath(**kwargs)

Retrieves the default path for where torrents are saved. (alias: app_defaultSavePath)

Returns:string

app_default_save_path(**kwargs)

Retrieves the default path for where torrents are saved. (alias: app_defaultSavePath)

Returns:string

app_preferences(**kwargs)

Retrieve qBittorrent application preferences.

Returns:Dictionary of preferences. Each preference is an attribute. Properties: https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-application-preferences

app_setPreferences(prefs=None, **kwargs)

Set one or more preferences in qBittorrent application. (alias: app_setPreferences)

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

app_set_preferences(prefs=None, **kwargs)

Set one or more preferences in qBittorrent application. (alias: app_setPreferences)

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. (alias: app_webapiVersion)

Returns:string

app_webapiVersion(**kwargs)

Retrieve web API version. (alias: app_webapiVersion)

Returns:string

application

Allows for transparent interaction with Application endpoints. (alias: app)

See Application class for usage. :return: Application object

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

Allows interaction with “Application” API endpoints.

Usage:

>>> from qbittorrentapi import Client
>>> client = Client(host='localhost:8080', username='admin', password='adminadmin')
>>> # this 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.app_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()

buildInfo

build_info

defaultSavePath

default_save_path

preferences

setPreferences(prefs=None, **kwargs)

set_preferences(prefs=None, **kwargs)

shutdown()

version

web_api_version

webapiVersion