prowlarr

Documentation

Overview

Package prowlarr provides a client for the Prowlarr API. Prowlarr docs: https://prowlarr.com/docs/api

Index

• type Client
  • func NewClient(url, apiKey string) *Client
  • func (c *Client) GetAPIVersion() (string, error)
  • func (c *Client) GetIndexers() ([]Indexer, error)
  • func (c *Client) Search(config *SearchConfig) ([]SearchResult, error)
• type Indexer
• type SearchConfig
• type SearchResult
  • func (s *SearchResult) IsFreeleech() bool

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(url, apiKey string) *Client

func (*Client) GetAPIVersion

func (c *Client) GetAPIVersion() (string, error)

func (*Client) GetIndexers

func (c *Client) GetIndexers() ([]Indexer, error)

func (*Client) Search

func (c *Client) Search(config *SearchConfig) ([]SearchResult, error)

Search performs a search on Prowlarr.

type Indexer

type Indexer struct {
	ID          int      `json:"id"`
	Protocol    string   `json:"protocol"`
	Name        string   `json:"name"`
	Enable      bool     `json:"enable"`
	IndexerUrls []string `json:"indexerUrls"`
}

Indexer represents a Prowlarr indexer (Tracker).

type SearchConfig

type SearchConfig struct {
	Indexers  []int // Indexer IDs
	Limit     int   // Limit the number of results. Currently not working in Prowlarr
	Offset    int   // Offset the number of results. Currently not working in Prowlarr
	FreeLeech bool  // Only return freeleech torrents
}

SearchConfig represents the search configuration.

type SearchResult

type SearchResult struct {
	Size         uint     `json:"size"`
	IndexerID    int      `json:"indexerId"`
	Title        string   `json:"title"`
	FileName     string   `json:"fileName"`
	DownloadURL  string   `json:"downloadUrl"`
	IndexerFlags []string `json:"indexerFlags"`
	Seeders      int      `json:"seeders"`
	Leechers     int      `json:"leechers"`
	Protocol     string   `json:"protocol"`
}

SearchResult represents a search result from Prowlarr.

func (*SearchResult) IsFreeleech

func (s *SearchResult) IsFreeleech() bool

IsFreeleech returns true if the search result is freeleech.