https://github.com/golift/nzbget
Go Library to interact with NZBGet API
https://github.com/golift/nzbget
golang-package nzbget nzbget-api
Last synced: 6 months ago
JSON representation
Go Library to interact with NZBGet API
- Host: GitHub
- URL: https://github.com/golift/nzbget
- Owner: golift
- License: mit
- Created: 2022-06-27T06:02:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-31T16:40:46.000Z (6 months ago)
- Last Synced: 2025-04-15T03:55:36.278Z (6 months ago)
- Topics: golang-package, nzbget, nzbget-api
- Language: Go
- Homepage: https://golift.io/discord
- Size: 39.1 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NZBGet Go Module
[](https://pkg.go.dev/golift.io/nzbget)
[](https://goreportcard.com/report/golift.io/nzbget)
[](https://github.com/golift/nzbget/blob/main/LICENSE)
[](https://golift.io/discord)
Full-featured Go Library to interact with NZBGet's JSON RPC interface. See exposed [methods](#methods) below.
If you'd like new features, please open a GitHub issue or pull request.
## Examples
Simple example to print some logs.
```golang
package main
import (
"fmt"
"golift.io/nzbget"
)
func main() {
nzb := nzbget.New(&nzbget.Config{
URL: "http://nzbget.server.io:6789/",
User: "userName",
Pass: "passWord",
})
events, err := nzb.Log(0, 100)
if err != nil {
panic(err)
}
nzbVer, err := nzb.Version()
if err != nil {
panic(err)
}
fmt.Println("NZBGet Version: ", nzbVer)
for _, event := range events {
fmt.Println(event.ID, event.Kind, event.Time, event.Text)
}
}
// Output:
// NZBGet Version: 21.1
// 47 INFO 2022-06-27 01:42:19 -0700 PDT Renaming 0b710bf619488ca0a1b5f83f53fde577.15 to eQ7Aq0DBEhHGCgSXy3PZ.part16.rar
// 103 INFO 2022-06-27 01:42:23 -0700 PDT Unrar: Extracting from eQ7Aq0DBEhHGCgSXy3PZ.part28.rar
// 104 INFO 2022-06-27 01:42:24 -0700 PDT Unrar: All OK
// 105 INFO 2022-06-27 01:42:24 -0700 PDT Deleting archive files
// 106 INFO 2022-06-27 01:42:24 -0700 PDT Deleting file eQ7Aq0DBEhHGCgSXy3PZ.part21.rar
```
## Methods
Official NZBGet API reference can be [found here](https://nzbget.net/api/).
All of these methods are exposed.
### Program Control
- [x] [version](https://nzbget.net/api/version)
- [x] [shutdown](https://nzbget.net/api/shutdown)
- [x] [reload](https://nzbget.net/api/reload)
### Queue and History
- [x] [listgroups](https://nzbget.net/api/listgroups)
- [x] [listfiles](https://nzbget.net/api/listfiles)
- [x] [history](https://nzbget.net/api/history)
- [x] [append](https://nzbget.net/api/append)
- [x] [editqueue](https://nzbget.net/api/editqueue)
- [x] [scan](https://nzbget.net/api/scan)
### Status, Logging and Statistics
- [x] [status](https://nzbget.net/api/status)
- [x] [log](https://nzbget.net/api/log)
- [x] [writelog](https://nzbget.net/api/writelog)
- [x] [loadlog](https://nzbget.net/api/loadlog)
- [x] [servervolumes](https://nzbget.net/api/servervolumes)
- [x] [resetservervolume](https://nzbget.net/api/resetservervolume)
### Pause and Speed Limit
- [x] [rate](https://nzbget.net/api/rate)
- [x] [pausedownload](https://nzbget.net/api/pausedownload)
- [x] [resumedownload](https://nzbget.net/api/resumedownload)
- [x] [pausepost](https://nzbget.net/api/pausepost)
- [x] [resumepost](https://nzbget.net/api/resumepost)
- [x] [pausescan](https://nzbget.net/api/pausescan)
- [x] [resumescan](https://nzbget.net/api/resumescan)
- [x] [scheduleresume](https://nzbget.net/api/scheduleresume)
### Configuration
- [x] [config](https://nzbget.net/api/config)
- [x] [loadconfig](https://nzbget.net/api/loadconfig)
- [x] [saveconfig](https://nzbget.net/api/saveconfig)
- [x] [configtemplates](https://nzbget.net/api/configtemplates)