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: and 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 – skip hash checking
is_paused –
True
to start torrent(s) pausedis_root_folder –
True
orFalse
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
orFalse
to use automatic torrent managementis_sequential_download –
True
orFalse
for sequential downloadis_first_last_piece_priority –
True
orFalse
for first and last piece download prioritytags – tag(s) to assign to torrent(s) (added in Web API 2.6.2)
content_layout –
Original
,Subfolder
, orNoSubfolder
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
orFalse
whetherdownload_path
should be used…defaults toTrue
ifdownload_path
is specified (added in Web API 2.8.4)stop_condition –
MetadataReceived
orFilesChecked
to stop the torrent when started automatically (added in Web API 2.8.15)
- Returns:
Ok.
for success andFails.
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:
- 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:
- 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:
- 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:
- 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
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:
- 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:
- 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
,completed
,paused
,active
,inactive
,resumed
Added in Web API 2.4.1:stalled
,stalled_uploading
andstalled_downloading
Added Web API 2.8.15: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” param 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:
- Parameters:
torrent_hash – hash for torrent
- Returns:
- torrents_piece_states(torrent_hash=None, **kwargs)#
Retrieve individual torrent’s pieces’ states.
- Raises:
- Parameters:
torrent_hash – hash for torrent
- Returns:
- torrents_properties(torrent_hash=None, **kwargs)#
Retrieve individual torrent’s properties.
- Raises:
- 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:
- 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:
- 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
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.
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_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:
- 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.
- Raises:
- 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:
- torrents_webseeds(torrent_hash=None, **kwargs)#
Retrieve individual torrent’s web seeds.
- Raises:
- 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
. Alows interaction with individual torrents via theTorrents
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()
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 formalized Enumeration for Torrent State instead of the raw string.
- 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
Alows 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)#
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)#
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)#
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)#
Bases:
List
Response to
torrents_info()
- class qbittorrentapi.torrents.TorrentPieceInfoList(list_entries, client)#
Bases:
List
Response to
torrents_piece_states()
andtorrents_piece_hashes()
- class qbittorrentapi.torrents.TorrentPieceData(data=None, client=None)#
Bases:
ListEntry
Item in
TorrentPieceInfoList
- class qbittorrentapi.torrents.TagList(list_entries, client)#
Bases:
List
Response to
torrents_tags()