Search

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

Bases: qbittorrentapi.app.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 emtpy 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: qbittorrentapi.definitions.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: qbittorrentapi.definitions.Dictionary

Response for search_results()

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

Bases: qbittorrentapi.definitions.List

Response for search_status()

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

Bases: qbittorrentapi.definitions.ListEntry

Item in SearchStatusesList

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

Bases: qbittorrentapi.definitions.List

Response for search_categories()

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

Bases: qbittorrentapi.definitions.ListEntry

Item in SearchCategoriesList

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

Bases: qbittorrentapi.definitions.List

Response for search_plugins()

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

Bases: qbittorrentapi.definitions.ListEntry

Item in SearchPluginsList