Transfer#

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

Bases: qbittorrentapi.app.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_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_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)#

Alows 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()

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

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_toggle_speed_limits_mode()

property upload_limit#: Implements transfer_upload_limit()

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

Bases: qbittorrentapi.definitions.Dictionary

Response to transfer_info()