{"library":"qbittorrent-api","title":"qbittorrent-api Python Client","description":"qbittorrent-api is a Python client library for interacting with the qBittorrent v4.1+ Web API. It provides a programmatic interface to manage torrents, retrieve application status, and control various aspects of the qBittorrent client. The library releases frequently, often mirroring updates in qBittorrent server versions or adding new API features, with the current version being 2025.11.1.","language":"python","status":"active","last_verified":"Fri Apr 17","install":{"commands":["pip install qbittorrent-api"],"cli":null},"imports":["from qbittorrentapi import Client"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"import os\nfrom qbittorrentapi import Client, APIError\n\n# Configure connection details using environment variables for security\nQBT_HOST = os.environ.get('QBT_HOST', 'localhost')\nQBT_PORT = int(os.environ.get('QBT_PORT', '8080'))\nQBT_USERNAME = os.environ.get('QBT_USERNAME', 'admin')\nQBT_PASSWORD = os.environ.get('QBT_PASSWORD', 'adminadmin') # Change 'adminadmin' if using a custom password\n\ntry:\n    # Initialize the qBittorrent client\n    qbt_client = Client(\n        host=QBT_HOST,\n        port=QBT_PORT,\n        username=QBT_USERNAME,\n        password=QBT_PASSWORD,\n        verify_data_path=False # Set to True if using HTTPS with a valid certificate\n    )\n\n    # Test connection and authentication by getting the application version\n    app_version = qbt_client.app.version()\n    print(f\"Successfully connected to qBittorrent Web UI (v{app_version}) at {QBT_HOST}:{QBT_PORT}\")\n\n    # Example: Get the transfer info\n    transfer_info = qbt_client.transfer.info()\n    print(f\"Download speed: {transfer_info.dl_info_speed / 1024:.2f} KB/s, Upload speed: {transfer_info.up_info_speed / 1024:.2f} KB/s\")\n\nexcept APIError as e:\n    print(f\"qBittorrent API Error: {e}\")\n    if \"failed to login\" in str(e).lower():\n        print(\"Please check your username and password.\")\nexcept ConnectionError as e:\n    print(f\"Connection Error: {e}. Is qBittorrent running, Web UI enabled, and host/port correct?\")\nexcept Exception as e:\n    print(f\"An unexpected error occurred: {e}\")","lang":"python","description":"This quickstart demonstrates how to connect to a qBittorrent instance using the client library, authenticate, and retrieve basic information like the application version and current transfer speeds. It uses environment variables for sensitive connection details.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}