https://github.com/rmartin16/qbittorrent-api
Python client implementation for qBittorrent's Web API
https://github.com/rmartin16/qbittorrent-api
api api-client client python python-client qbittorrent torrents webapi
Last synced: about 2 months ago
JSON representation
Python client implementation for qBittorrent's Web API
- Host: GitHub
- URL: https://github.com/rmartin16/qbittorrent-api
- Owner: rmartin16
- License: mit
- Created: 2019-05-03T18:07:02.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2026-05-01T14:31:48.000Z (2 months ago)
- Last Synced: 2026-05-01T16:26:01.452Z (2 months ago)
- Topics: api, api-client, client, python, python-client, qbittorrent, torrents, webapi
- Language: Python
- Homepage: https://qbittorrent-api.readthedocs.io/
- Size: 3.84 MB
- Stars: 494
- Watchers: 3
- Forks: 73
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
qBittorrent Web API Client
==========================
Python client implementation for qBittorrent Web API
[](https://github.com/rmartin16/qbittorrent-api/actions?query=branch%3Amain) [](https://app.codecov.io/gh/rmartin16/qbittorrent-api) [](https://pypi.org/project/qbittorrent-api/) [](https://pypi.org/project/qbittorrent-api/)
Currently supports qBittorrent [v5.2.0](https://github.com/qbittorrent/qBittorrent/releases/tag/release-5.2.0) (Web API v2.15.1) released on May 03, 2026.
User Guide and API Reference available on [Read the Docs](https://qbittorrent-api.readthedocs.io/).
Features
--------
* The entire qBittorrent [Web API](https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-5.0)) is implemented.
* qBittorrent version checking for an endpoint's existence/features is automatically handled.
* If the authentication cookie expires, a new one is automatically requested in line with any API call.
Installation
------------
Install via pip from [PyPI](https://pypi.org/project/qbittorrent-api/)
```bash
python -m pip install qbittorrent-api
```
Getting Started
---------------
```python
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})")
# stop all torrents
qbt_client.torrents.stop.all()
```