https://github.com/scttcper/transmission
Transmission torrent client API wrapper
https://github.com/scttcper/transmission
transmission transmission-web
Last synced: 2 months ago
JSON representation
Transmission torrent client API wrapper
- Host: GitHub
- URL: https://github.com/scttcper/transmission
- Owner: scttcper
- License: mit
- Created: 2018-12-16T02:59:58.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-07-23T05:30:50.000Z (3 months ago)
- Last Synced: 2025-08-02T00:26:48.510Z (3 months ago)
- Topics: transmission, transmission-web
- Language: TypeScript
- Homepage: https://transmission.vercel.app
- Size: 1.34 MB
- Stars: 29
- Watchers: 2
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# transmission [](https://www.npmjs.com/package/@ctrl/transmission) [](https://codecov.io/gh/scttcper/transmission)
> TypeScript api wrapper for [transmission](https://transmissionbt.com/) using [ofetch](https://github.com/unjs/ofetch)
### Install
```sh
npm install @ctrl/transmission
```
### Use
```ts
import { Transmission } from '@ctrl/transmission';
const client = new Transmission({
baseUrl: 'http://localhost:9091/',
password: '',
});
async function main() {
const res = await client.getAllData();
console.log(res);
}
```
### Api
Docs: https://transmission.vercel.app
API Docs: https://github.com/transmission/transmission/blob/master/extras/rpc-spec.txt
### Normalized API
These functions have been normalized between torrent clients. Can easily support multiple torrent clients. See below for alternative supported torrent clients
##### getAllData
Returns all torrent data and an array of label objects. Data has been normalized and does not match the output of native `listTorrents()`.
```ts
const data = await client.getAllData();
console.log(data.torrents);
```
##### getTorrent
Returns one torrent data
```ts
const data = await client.getTorrent();
console.log(data);
```
##### pauseTorrent and resumeTorrent
Pause or resume a torrent
```ts
const paused = await client.pauseTorrent();
console.log(paused);
const resumed = await client.resumeTorrent();
console.log(resumed);
```
##### removeTorrent
Remove a torrent. Does not remove data on disk by default.
```ts
// does not remove data on disk
const result = await client.removeTorrent('torrent_id', false);
console.log(result);
// remove data on disk
const res = await client.removeTorrent('torrent_id', true);
console.log(res);
```
##### export and create from state
If you're shutting down the server often (serverless?) you can export the state
```ts
const state = client.exportState()
const client = Transmission.createFromState(config, state);
```
### See Also
All of the following npm modules provide the same normalized functions along with supporting the unique apis for each client.
deluge - https://github.com/scttcper/deluge
qbittorrent - https://github.com/scttcper/qbittorrent
utorrent - https://github.com/scttcper/utorrent
### Start a test docker container
```
docker run -d \
--name=transmission \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-p 9091:9091 \
-p 51413:51413 \
-p 51413:51413/udp \
-v ~/Documents/transmission/config:/config \
-v ~/Documents/transmission/downloads:/downloads \
-v ~/Documents/transmission/watch:/watch \
--restart unless-stopped \
lscr.io/linuxserver/transmission:latest
```