README

PHP QBITTORRENT API is a Qbittorrent application client for managing qbittorrent applications using Webui API.

Name	Information
Application	QBittorrent
Api version	API v4.x

Help and docs

We use GitHub issues only to discuss bugs and new features. For support please refer to:

comming soon

The recommended way to install PHP QBITTORRENT API is through Composer.

composer require fatkulnurk/php-qbittorrent-api

Authentication

Name	Status Development	Status Testing
Login	✅	❌
Logout	✅	❌

Application

Name	Status Development	Status Testing
Get application version	✅	❌
Get API version	✅	❌
Get build info	✅	❌
Shutdown application	✅	❌
Get application preferences	✅	❌
Set application preferences	✅	❌
Get default save path	✅	❌

Log

Name	Status Development	Status Testing
Get log	✅	❌
Get peer log	✅	❌

Sync

Name	Status Development	Status Testing
Get main data	✅	❌
Get torrent peers data	✅	❌

Transfer info

Name	Status Development	Status Testing
Get global transfer info	✅	❌
Get alternative speed limits state	✅	❌
Toggle alternative speed limits	✅	❌
Get global download limit	✅	❌
Set global download limit	✅	❌
Get global upload limit	✅	❌
Set global upload limit	✅	❌
Ban peers	✅	❌

Torrent management

Name	Status Development	Status Testing
Get torrent list	❌	❌
Get torrent generic properties	❌	❌
Get torrent trackers	❌	❌
Get torrent web seeds	❌	❌
Get torrent contents	❌	❌
Get torrent pieces' states	❌	❌
Get torrent pieces' hashes	❌	❌
Pause torrents	❌	❌
Resume torrents	❌	❌
Delete torrents	❌	❌
Recheck torrents	❌	❌
Reannounce torrents	❌	❌
Edit trackers	❌	❌
Remove trackers	❌	❌
Add peers	❌	❌
Add new torrent	❌	❌
Add trackers to torrent	❌	❌
Increase torrent priority	❌	❌
Decrease torrent priority	❌	❌
Maximal torrent priority	❌	❌
Minimal torrent priority	❌	❌
Set file priority	❌	❌
Get torrent download limit	❌	❌
Set torrent download limit	❌	❌
Set torrent share limit	❌	❌
Get torrent upload limit	❌	❌
Set torrent upload limit	❌	❌
Set torrent location	❌	❌
Set torrent name	❌	❌
Set torrent category	❌	❌
Get all categories	❌	❌
Add new category	❌	❌
Edit category	❌	❌
Remove categories	❌	❌
Add torrent tags	❌	❌
Remove torrent tags	❌	❌
Get all tags	❌	❌
Create tags	❌	❌
Delete tags	❌	❌
Set automatic torrent management	❌	❌
Toggle sequential download	❌	❌
Set first/last piece priority	❌	❌
Set force start	❌	❌
Set super seeding	❌	❌
Rename file	❌	❌

RSS (experimental)

Name	Status Development	Status Testing
Add folder	✅	❌
Add feed	✅	❌
Remove item	✅	❌
Move item	✅	❌
Get all items	✅	❌
Mark as read	✅	❌
Refresh item	✅	❌
Set auto-downloading rule	✅	❌
Rename auto-downloading rule	✅	❌
Remove auto-downloading rule	✅	❌
Get all auto-downloading rules	✅	❌
Get all articles matching a rule	✅	❌

Search

Version	Status	Packagist	Namespace	Repo	Docs	PSR-7	PHP Version