Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@jc21/nzbget-jsonrpc-api

jc2111MIT1.0.0TypeScript support: included

An API Client for NzbGet JSONRPC

nzb, nzbget, jsonrpc, api

readme

NzbGet JSONRPC API Client

See: https://nzbget.net/api/

This client is designed for NZBGet v18+

Usage

const NzbGet = require('@jc21/nzbget-jsonrpc-api').Client;

let ng = new NzbGet('http://username:password@localhost:6789/jsonrpc');

// Using the helper method:
ng.listgroups()
    .then(groups => {
        console.log(groups);
    })
    .catch(err => {
        console.error('ERR:', err);
    });

// Or using the custom call method:
ng.call('listgroups')
    .then(groups => {
        console.log(result);
    })
    .catch(err => {
        console.error('ERR:', err);
    });

Helper Methods

These methods have the same method signature as the API Documentation

  • ng.version()
  • ng.shutdown()
  • ng.reload()
  • ng.listgroups()
  • ng.listfiles()
  • ng.history()
  • ng.append()
  • ng.editqueue()
  • ng.scan()
  • ng.status()
  • ng.getlog()
  • ng.writelog()
  • ng.loadlog()
  • ng.servervolumes()
  • ng.resetservervolume()
  • ng.rate()
  • ng.pausedownload()
  • ng.resumedownload()
  • ng.pausepost()
  • ng.resumepost()
  • ng.pausescan()
  • ng.resumescan()
  • ng.scheduleresume()
  • ng.config()
  • ng.loadconfig()
  • ng.saveconfig()
  • ng.configtemplates()

Compiling

npm install
tsc --project tsconfig.build.json