# qbittorrent-api-client

> JavaScript client for qBittorrent api

Latest version **0.5.3** (published 2026-07-15) · ISC license · 0 weekly downloads

## Install

```sh
npm install qbittorrent-api-client
pnpm add qbittorrent-api-client
yarn add qbittorrent-api-client
bun add qbittorrent-api-client
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.5.3 |
| Published | 2026-07-15 |
| First published | 2022-08-15 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 114.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Clovis de Villars |
| Maintainers | super-bunny |
| Keywords | qBittorrent, api, client |

## Links

- npm: https://www.npmjs.com/package/qbittorrent-api-client
- Repository: https://github.com/super-bunny/qBittorrent-api-client-js
- Homepage: https://github.com/super-bunny/qBittorrent-api-client-js#readme
- Issues: https://github.com/super-bunny/qBittorrent-api-client-js/issues
- npm.io page: https://npm.io/package/qbittorrent-api-client

## Dependencies (3)

- [axios](https://npm.io/package/axios.md) ^0.33.0
- [form-data](https://npm.io/package/form-data.md) ^4.0.6
- [typescript](https://npm.io/package/typescript.md) ^5.4.3

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 0.5.3 (latest) — 2026-07-15
- 0.5.2 — 2026-07-15
- 0.5.1 — 2024-05-25
- 0.5.0 — 2024-04-02
- 0.4.1 — 2023-04-20
- 0.4.0 — 2022-10-09
- 0.3.0 — 2022-10-09
- 0.2.0 — 2022-08-15
- 0.1.0 — 2022-08-15

## README

# qBittorrent API client

This library provides a fully typed API client for qBittorrent.

:warning: This library is still in development and may be unstable. Breaking changes may occur at any time.

## Pre-requisites

Web-UI must be enabled in qBittorrent to be able to use the api with this library.

## Installation

### NPM
```shell
npm install qbittorrent-api-client
```
### Yarn
```shell
yarn add qbittorrent-api-client
```

## Example

```js
import QBittorrentClient from 'qbittorrent-api-client'

const qBittorrentClient = new QBittorrentClient({ baseUrl: 'http://localhost:8080' });

// This will save the session cookie in the client
await qBittorrentClient.authenticate('user', 'password')

// Get all torrents
const [firstTorrent] = await qBittorrentClient.getTorrentInfos()

// Get torrent properties
const { seeds, peers } = await qBittorrentClient.getTorrentProperties(firstTorrent.hash)

console.log(`Torrent "${ firstTorrent.name }" has ${ seeds } seeds and ${ peers } peers`)
// Torrent "Ubuntu 20.04.1 LTS" has 1 seeds and 0 peers
```

---
_Source: https://npm.io/package/qbittorrent-api-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._