SABnzbd API

Dart library package providing an abstraction for SABnzbd's public API.

This package is intended to supply a 1:1 mapping of the public API documentation and does not make assumptions on orchestration to execute different workflows.

Preparing SABnzbd

To connect to your instance of SABnzbd, you will need:

1. The host IPv4 address of the machine running SABnzbd
2. The API key of the SABnzbd instance (which can be found in the web GUI under Config → General)

Please note that in order to access SABnzbd from another machine on the network you must ensure that both the SABnzbd executable and the running port are allowed in any running firewalls on the host machine.

Connecting to the API

All classes, models, and types are exported in the main package file:

import 'package:sabnzbd_api/sabnzbd_api.dart';

Now you can instantiate an instance of SABnzbdConfig that is used to instantiate an instance of SABnzbdAPI:

final config = SABnzbdConfig(
  host: '192.168.1.100:8080',
  apiKey: 'asdf123',
);
final api = SABnzbdAPI(config);

You can optionally pass in a Dio BaseOptions instance to the configuration to customize the HTTP client. Note that the baseUrl property will be overwritten with the given host property in the configuration.

And you are ready to make API calls!

final resume = await api.resumeQueue(); // Resume the global queue
final history = await api.getHistory(); // Get items in the history
...

Additional Notes

1. All available API methods can be viewed in the generated Dart documentation
2. All models are immutable freezed-generated classes that can be modified using the <model>.copyWith(...) method
3. All models are JSON serializable using the <model>.toJson() method