qbittorrent-api - GitLite

KO | EN

gitlite — search

#hacktoberfest #react #ai #llm #android #machine-learning #docker #nodejs #java #windows #cli #kubernetes #vue #awesome-list

qbittorrent-api

(★ 512)

Python client implementation for qBittorrent's Web API

File Explorer

Download Latest Version (.zip)

- - bug_report.yml
  - config.yml
  - feature_request.yml
- - ci.yml
  - pre-commit-update.yml
  - publish.yml
  - release.yml
  - test.yml
- dependabot.yml
- - api.rst
  - async.rst
  - behavior&configuration.rst
  - conf.py
  - exceptions.rst
  - index.rst
  - introduction.rst
  - performance.rst
  - spelling_wordlist
- make.bat
- Makefile
- - __init__.py
  - _attrdict.py
  - _version_support.py
  - app.py
  - auth.py
  - client.py
  - clientdata.py
  - definitions.py
  - exceptions.py
  - log.py
  - py.typed
  - request.py
  - rss.py
  - search.py
  - sync.py
  - torrentcreator.py
  - torrents.py
  - transfer.py
- - kubuntu-22.04.3-desktop-amd64.iso.torrent
  - kubuntu-22.04.4-desktop-amd64.iso.torrent
  - root_folder.torrent
  - server.crt
  - server.key
  - ubuntu-22.04.1-desktop-amd64.iso.torrent
  - xubuntu-22.04.4-desktop-amd64.iso.torrent
- __init__.py
- api_surface.json
- catalog.py
- CLAUDE.md
- conftest.py
- test_api_surface.py
- test_app.py
- test_auth.py
- test_clientdata.py
- test_definitions.py
- test_log.py
- test_request.py
- test_rss.py
- test_search.py
- test_sync.py
- test_torrent.py
- test_torrentcreator.py
- test_torrents.py
- test_transfer.py
- test_version.py
- test_zzz_last_tests.py
- utils.py
.git-blame-ignore-revs
.gitignore
.pre-commit-config.yaml
.readthedocs.yaml
CHANGELOG.md
LICENSE
MANIFEST.in
pyproject.toml
README.md
tox.ini
uv.lock

# Installation Guide

1. Get the code

git clone https://github.com/rmartin16/qbittorrent-api

Downloads the entire project code from GitHub to your computer.

cd qbittorrent-api

Moves into the project folder you just downloaded.

2. Python

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

python -m pip install qbittorrent-api

Installs the Python libraries listed in requirements.txt (or similar).

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">

qBittorrent Web API Client
==========================

Python client implementation for qBittorrent Web API

[![GitHub Workflow Status (branch)](https://img.shields.io/github/checks-status/rmartin16/qbittorrent-api/main?style=flat-square)](https://github.com/rmartin16/qbittorrent-api/actions?query=branch%3Amain) [![Codecov branch](https://img.shields.io/codecov/c/gh/rmartin16/qbittorrent-api/main?style=flat-square)](https://app.codecov.io/gh/rmartin16/qbittorrent-api) [![PyPI](https://img.shields.io/pypi/v/qbittorrent-api?style=flat-square)](https://pypi.org/project/qbittorrent-api/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/qbittorrent-api?style=flat-square)](https://pypi.org/project/qbittorrent-api/)

</div>

Currently supports qBittorrent [v5.2.3](https://github.com/qbittorrent/qBittorrent/releases/tag/release-5.2.3) (Web API v2.15.1) released on July 7, 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()
```