https://github.com/golift/starr
Starr Library: Fully functional go package to interact with Lidarr, Prowlarr, Radarr, Readarr, and Sonarr APIs.
https://github.com/golift/starr
golang golang-library lidarr prowlarr radarr readarr sonarr
Last synced: 6 months ago
JSON representation
Starr Library: Fully functional go package to interact with Lidarr, Prowlarr, Radarr, Readarr, and Sonarr APIs.
- Host: GitHub
- URL: https://github.com/golift/starr
- Owner: golift
- License: mit
- Created: 2019-01-24T02:16:32.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-03-20T04:22:37.000Z (7 months ago)
- Last Synced: 2025-03-30T20:11:19.580Z (6 months ago)
- Topics: golang, golang-library, lidarr, prowlarr, radarr, readarr, sonarr
- Language: Go
- Homepage: https://golift.io/discord
- Size: 750 KB
- Stars: 78
- Watchers: 5
- Forks: 18
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Starr Library
[](https://pkg.go.dev/golift.io/starr)
[](https://goreportcard.com/report/golift.io/starr)
[](https://github.com/golift/starr/blob/main/LICENSE)
[](https://golift.io/discord)
## The correct way to say `*arr`.
**Go library to interact with APIs in all the Starr apps.**
- [Lidarr](https://lidarr.audio) ([over 80 methods](https://pkg.go.dev/golift.io/starr@main/lidarr))
- [Prowlarr](https://prowlarr.com) ([over 20 methods](https://pkg.go.dev/golift.io/starr@main/prowlarr))
- [Radarr](https://radarr.video) ([over 100 methods](https://pkg.go.dev/golift.io/starr@main/radarr))
- [Readarr](https://readarr.com) ([over 70 methods](https://pkg.go.dev/golift.io/starr@main/readarr))
- [Sonarr](https://sonarr.tv) ([over 100 methods](https://pkg.go.dev/golift.io/starr@main/sonarr))
[Custom Scripts support](https://wiki.servarr.com/radarr/custom-scripts) is also included.
[Check out the types and methods](https://pkg.go.dev/golift.io/starr@main/starrcmd) to get that data.
## One 🌟 To Rule Them All
This library is slowly updated as new methods are needed or requested. If you have
specific needs this library doesn't currently meet, but should or could, please
[let us know](https://github.com/golift/starr/issues/new)!
This library is currently in use by:
- [Toolbarr](https://github.com/Notifiarr/toolbarr/) (all of it)
- [Unpackerr](https://github.com/Unpackerr/unpackerr/) (queue only)
- [Notifiarr](https://github.com/Notifiarr/notifiarr/) (a lot of it)
- [Checkrr](https://github.com/aetaric/checkrr/)
- [telegram-bot](https://github.com/woiza/telegram-bot-radarr) (radarr)
- [telegram-bot2](https://github.com/woiza/telegram-bot-sonarr) (sonarr)
# Usage
Get it:
```shell
go get golift.io/starr
```
Use it:
```go
import "golift.io/starr"
```
## Example
```go
package main
import (
"fmt"
"golift.io/starr"
"golift.io/starr/lidarr"
)
func main() {
// Get a starr.Config that can plug into any Starr app.
// starr.New(apiKey, appURL string, timeout time.Duration)
c := starr.New("abc1234ahsuyka123jh12", "http://localhost:8686", 0)
// Lets make a lidarr server with the default starr Config.
l := lidarr.New(c)
// In addition to GetSystemStatus, you have things like:
// * l.GetAlbum(albumID int)
// * l.GetQualityDefinition()
// * l.GetQualityProfiles()
// * l.GetRootFolders()
// * l.GetQueue(maxRecords int)
// * l.GetAlbum(albumUUID string)
// * l.GetArtist(artistUUID string)
status, err := l.GetSystemStatus()
if err != nil {
panic(err)
}
fmt.Println(status)
}
```