Torrent Client API

Get/Update data fom various torrent clients. Created as an exercise to understand different api types.

Inspired from: scttcper/qbittorrent

Supported clients:

Deluge, QBittorent, rTorrent (incomplete), Transmission, uTorrent.

No warranty Please read and understand code then use it at your own risk. Bug fix and feature request messages are welcome and appreciated.

API / Example usage:

import {
  TorrentClientApi,
  torrentClientTypes,
  torrentFields,
  torrentFilters,
} from "./src/index.mjs";

const qBittorent = new TorrentClientApi({
  clientType: torrentClientTypes.qBittorent,
  baseUrl: "127.0.0.1:10000", // port must be included here
  apiPath: "", // custom api path after baseUrl
  username: "admin",
  password: "",
  timeoutS: 5, // request timeout in seconds. default = 5
  agent: null, // custom agent for use in http request
  xmlrpc: null, // xmlrpc module. only needed for rTorrent.
  cacheDir: "C:/test-data/cache",
  memCacheTimeout: 5,
  // clear memory cache after this many seconds. default = 60
});

const hash = "A torrent infohash";
const hashes = [hash];

console.log(
  await qBittorent.getTorrents({
    perPage: 1,
    searchTerm: "abc",
    hashes,
    filter: torrentFilters.completed,
    sort: torrentFields[0], // sort by any field
    reverse: false,
    //
    raw: false,
    // if true then data will not be normalized and
    // sort, filter, cache not applied on raw result
    //
    currentPage: 1,
    //
    fresh: false,
    // if true then fresh data from client will be fetched, 
    // else cache data will be returned
  })
);

console.log(
  await qBittorent.getTorrentFiles(hash, {
    asTree: false,
    // to return files as hierarchical tree object instead of array
    //
    raw: false,
    // for getting raw data
    //
    fresh: false,
    // for ignoring cache and getting fresh data
  })
);

console.log(
  await qBittorent.getApiVersion(),
  await qBittorent.getAppVersion(),
  qBittorent.clientType,
  qBittorent.host
);

await qBittorent.renameFile(hash, "old-path", "new-path");

const preferences = await qBittorent.getPreferences();

await qBittorent.setPreferences(preferences);
// This only works with data format of raw preferences that are 
// returned from getPreferences() method
    
await qBittorent.setTorrentUploadSpeed(hashes, 50); // limit in KBps
await qBittorent.startTorrents(hashes);
await qBittorent.stopTorrents(hashes);

qBittorent.clearTimers();
// clear cache save timers so process can exit during testing