Indexers#

Indexers are used to monitor for new releases of media on external trackers. When a suitable release has been found, Sonarr registers it for download on one of the configured download clients.

sonarr:
  config:
    indexers:
      minimum_age: 0
      retention: 0
      maximum_size: 0
      rss_sync_interval: 15
      delete_unmanaged: false # Better to leave off for the most part
      definitions:
        Nyaa: # Indexer name
          type: "nyaa" # Type of indexer
          # Configuration common to all indexers
          enable_rss: true
          enable_automatic_search: true
          enable_interactive_search: true
          anime_standard_format_search: true
          indexer_priority: 25
          download_client: null
          tags:
            - "example"
          # Nyaa-specific configuration
          website_url: "https://example.com"
        # Define more indexers here.

The following parameters are available for configuring indexers and how they are handled by Sonarr.

For more information on how Sonarr finds epsiodes, refer to the FAQ on WikiArr.

minimum_age: int = Field(0, ge=0) class-attribute instance-attribute #

Minimum age (in minutes) of NZBs before they are grabbed. (Usenet only)

Use this to give new releases time to propagate to your Usenet provider.

retention: int = Field(0, ge=0) class-attribute instance-attribute #

Retention of releases. (Usenet only)

Set to 0 for unlimited retention.

maximum_size: int = Field(0, ge=0) class-attribute instance-attribute #

Maximum size for a release to be grabbed, in megabytes (MB).

Set to 0 to set for unlimited size.

rss_sync_interval: int = Field(15, ge=0) class-attribute instance-attribute #

Interval (in minutes) to sync RSS feeds with indexers.

Set to 0 to disable syncing. This also disables automatic release grabbing.

delete_unmanaged: bool = False class-attribute instance-attribute #

Automatically delete indexers not configured by Buildarr.

Take care when enabling this option, as it will also delete indexers created by external applications such as Prowlarr.

If unsure, leave set at the default of false.

definitions: Dict[str, Annotated[IndexerType, Field(discriminator='type')]] = {} class-attribute instance-attribute #

Indexers to manage via Buildarr are defined here.

Configuring indexers#

Here is an example of an indexer being configured in the indexers configuration block in Buildarr.

...
  indexers:
    definitions:
      Nyaa: # Indexer name
        type: "nyaa" # Type of indexer
        # Configuration common to all indexers
        enable_rss: true
        enable_automatic_search: true
        enable_interactive_search: true
        anime_standard_format_search: true
        indexer_priority: 25
        download_client: null
        tags:
          - "example"
        # Nyaa-specific configuration
        website_url: "https://example.com"
      # Define more indexers here.

There are configuration parameters common to all indexer types, and parameters common to only specific types of indexers.

The following configuration attributes can be defined on all indexer types.

enable_rss: bool = True class-attribute instance-attribute #

If enabled, use this indexer to watch for files that are wanted and missing or have not yet reached their cutoff.

If enabled, use this indexer for automatic searches, including Search on Add.

If enabled, use this indexer for manual interactive searches.

priority: int = Field(25, ge=1, le=50, alias='indexer_priority') class-attribute instance-attribute #

Priority of this indexer to prefer one indexer over another in release tiebreaker scenarios.

1 is highest priority and 50 is lowest priority.

Changed in version 0.4.1: Renamed from indexer_priority to priority. The original name is still available as an alias.

download_client: Optional[NonEmptyStr] = None class-attribute instance-attribute #

The name of the download client to use for grabs from this indexer.

tags: List[NonEmptyStr] = [] class-attribute instance-attribute #

Only use this indexer for series with at least one matching tag. Leave blank to use with all series.

Fanzub#

An indexer which uses a Fanzub-compatible RSS feed to monitor for releases.

type: Literal['fanzub'] = 'fanzub' class-attribute instance-attribute #

Type value associated with this kind of indexer.

rss_url: RssUrl instance-attribute #

A URL to a Fanzub compatible RSS feed.

Also search for anime using the standard numbering. Only applies for Anime series types.

Newznab#

An indexer for monitoring a Newznab-compliant Usenet indexing site.

Sonarr defines presets for several popular sites.

type: Literal['newznab'] = 'newznab' class-attribute instance-attribute #

Type value associated with this kind of indexer.

url: AnyHttpUrl instance-attribute #

URL of the Newznab-compatible indexing site.

api_path: NonEmptyStr = '/api' class-attribute instance-attribute #

Newznab API endpoint. Usually /api.

categories: Set[Union[NabCategory, int]] = {NabCategory.TV_SD, NabCategory.TV_HD} class-attribute instance-attribute #

Categories to monitor for standard/daily shows. Define as empty to disable.

Values:

  • TV
  • TV/WEB-DL
  • TV/Foreign
  • TV/SD
  • TV/HD
  • TV/UHD
  • TV/Other
  • TV/Sport
  • TV/Anime
  • TV/Documentary
  • TV/x265

Changed in version 0.6.1: The Sonarr-native values for Newznab/Torznab categories (e.g. TV/WEB-DL) can now be specified, instead of the Buildarr-native values (e.g. TV-WEBDL). The old values can still be used.

anime_categories: Set[NabCategory] = set() class-attribute instance-attribute #

Categories to monitor for anime. Define as empty to disable.

Values:

  • TV
  • TV/WEB-DL
  • TV/Foreign
  • TV/SD
  • TV/HD
  • TV/UHD
  • TV/Other
  • TV/Sport
  • TV/Anime
  • TV/Documentary
  • TV/x265

Changed in version 0.6.1: The Sonarr-native values for Newznab/Torznab categories (e.g. TV/WEB-DL) can now be specified, instead of the Buildarr-native values (e.g. TV-WEBDL). The old values can still be used.

Also search for anime using the standard numbering. Only applies for Anime series types.

additional_parameters: Optional[str] = None class-attribute instance-attribute #

Additional Newznab API parameters.

OmgWtfNZBs#

An indexer for monitoring OmgWtfNZBs.

type: Literal['omgwtfnzbs'] = 'omgwtfnzbs' class-attribute instance-attribute #

Type value associated with this kind of indexer.

username: NonEmptyStr instance-attribute #

Username for the OmgWtfNZBs account.

api_key: Password instance-attribute #

API key for the OmgWtfNZBs API.

delay: int = Field(30, ge=0) class-attribute instance-attribute #

Time (in minutes) to delay new NZBs before they appear on the RSS feed.

Torrent Indexers#

Configuration attributes common to all torrent indexers.

minimum_seeders: PositiveInt = 1 class-attribute instance-attribute #

The minimum number of seeders required before downloading a release.

seed_ratio: Optional[float] = None class-attribute instance-attribute #

The seed ratio a torrent should reach before stopping.

If unset or set to null, use the download client's defaults.

seed_time: Optional[int] = None class-attribute instance-attribute #

The amount of time (in minutes) a torrent should be seeded before stopping.

If unset or set to null, use the download client's defaults.

seasonpack_seed_time: Optional[int] = None class-attribute instance-attribute #

The amount of time (in minutes) a season-pack torrent should be seeded before stopping.

If unset or set to null, use the download client's defaults.

BroadcasTheNet#

Indexer for monitoring for new releases on BroacasTheNet.

type: Literal['broadcasthenet'] = 'broadcasthenet' class-attribute instance-attribute #

Type value associated with this kind of indexer.

api_url: AnyHttpUrl = 'https://api.broadcasthe.net' class-attribute instance-attribute #

BroadcasTheNet API URL.

api_key: Password instance-attribute #

BroadcasTheNet API key.

Filelist#

Monitor for new releases on FileList.io.

type: Literal['filelist'] = 'filelist' class-attribute instance-attribute #

Type value associated with this kind of indexer.

username: NonEmptyStr instance-attribute #

FileList username.

passkey: Password instance-attribute #

FileList account API key.

api_url: AnyHttpUrl = 'https://filelist.io' class-attribute instance-attribute #

FileList API URL.

Do not change this unless you know what you're doing, as your API key will be sent to this host.

categories: Set[FilelistCategory] = {FilelistCategory.TV_SD, FilelistCategory.TV_HD, FilelistCategory.TV_4K} class-attribute instance-attribute #

Categories to monitor for standard/daily show new releases.

Set to an empty list to not monitor for standard/daily shows.

Values:

  • Anime
  • Animation
  • TV 4K
  • TV HD
  • TV SD
  • Sport
anime_categories: Set[FilelistCategory] = set() class-attribute instance-attribute #

Categories to monitor for anime new releases.

Leave empty to not monitor for anime.

Values:

  • Anime
  • Animation
  • TV 4K
  • TV HD
  • TV SD
  • Sport

HDBits#

Monitor for new releases on HDBits.

type: Literal['hdbits'] = 'hdbits' class-attribute instance-attribute #

Type value associated with this kind of indexer.

username: NonEmptyStr instance-attribute #

HDBits account username.

api_key: Password instance-attribute #

HDBits API key assigned to the account.

api_url: AnyHttpUrl = 'https://hdbits.org' class-attribute instance-attribute #

HDBits API URL.

Do not change this unless you know what you're doing, as your API key will be sent to this host.

IP Torrents#

Monitor for releases using the IP Torrents native API.

Note

IP Torrents' native API does not support automatic searching. It is recommended to instead configure IP Torrents as a Torznab indexer.

type: Literal['iptorrents'] = 'iptorrents' class-attribute instance-attribute #

Type value associated with this kind of indexer.

feed_url: RssUrl instance-attribute #

The full RSS feed url generated by IP Torrents, using only the categories you selected (HD, SD, x264, etc ...).

Nyaa#

Monitor for new anime releases on the configured Nyaa domain.

Nyaa only supports searching for Anime series type releases.

type: Literal['nyaa'] = 'nyaa' class-attribute instance-attribute #

Type value associated with this kind of indexer.

website_url: AnyHttpUrl instance-attribute #

HTTPS URL for accessing Nyaa.

Also search for anime using the standard numbering. Only applies for Anime series types.

additional_parameters: Optional[str] = '&cats=1_0&filter=1' class-attribute instance-attribute #

Parameters to send in the Nyaa search request.

Note that if you change the category, you will have to add required/restricted rules about the subgroups to avoid foreign language releases.

Rarbg#

Monitor for new releases on the RARBG torrent tracker.

type: Literal['rarbg'] = 'rarbg' class-attribute instance-attribute #

Type value associated with this kind of indexer.

api_url: AnyHttpUrl instance-attribute #

RARBG API url.

ranked_only: bool = False class-attribute instance-attribute #

Only include ranked results.

captcha_token: Optional[str] = None class-attribute instance-attribute #

CAPTCHA clearance token used to handle CloudFlare anti-DDoS measures on shared-IP VPNs.

Torrent RSS Feed#

Generic parser for monitoring a torrent RSS feed.

Note

This indexer does not support automatic searching. It is recommended to use an indexer that natively communicates with a tracker using an API.

type: Literal['torrentrssfeed'] = 'torrentrssfeed' class-attribute instance-attribute #

Type value associated with this kind of indexer.

full_rss_feed_url: RssUrl instance-attribute #

RSS feed to monitor.

cookie: Optional[str] = None class-attribute instance-attribute #

Session cookie for accessing the RSS feed.

If the RSS feed requires one, this should be retrieved manually via a web browser.

allow_zero_size: bool = False class-attribute instance-attribute #

Allow access to releases that don't specify release size.

As size checks will not be performed, be careful when enabling this option.

TorrentLeech#

Monitor for new releases on TorrentLeech.

Note

This indexer does not support automatic searching.

type: Literal['torrentleech'] = 'torrentleech' class-attribute instance-attribute #

Type value associated with this kind of indexer.

website_url: AnyHttpUrl = 'http://rss.torrentleech.org' class-attribute instance-attribute #

TorrentLeech feed API URL.

api_key: Password instance-attribute #

TorrentLeech API key.

Torznab#

Monitor and search for new releases on a Torznab-compliant torrent indexing site.

Sonarr defines presets for several popular sites.

type: Literal['torznab'] = 'torznab' class-attribute instance-attribute #

Type value associated with this kind of indexer.

url: AnyHttpUrl instance-attribute #

URL of the Torznab-compatible indexing site.

api_path: NonEmptyStr = '/api' class-attribute instance-attribute #

Tornab API endpoint. Usually /api.

categories: Set[NabCategory] = {NabCategory.TV_SD, NabCategory.TV_HD} class-attribute instance-attribute #

Categories to monitor for standard/daily shows. Define as empty to disable.

Values:

  • TV
  • TV/WEB-DL
  • TV/Foreign
  • TV/SD
  • TV/HD
  • TV/UHD
  • TV/Other
  • TV/Sport
  • TV/Anime
  • TV/Documentary
  • TV/x265

Changed in version 0.6.1: The Sonarr-native values for Newznab/Torznab categories (e.g. TV/WEB-DL) can now be specified, instead of the Buildarr-native values (e.g. TV-WEBDL). The old values can still be used.

anime_categories: Set[NabCategory] = set() class-attribute instance-attribute #

Categories to monitor for anime.

Values:

  • TV
  • TV/WEB-DL
  • TV/Foreign
  • TV/SD
  • TV/HD
  • TV/UHD
  • TV/Other
  • TV/Sport
  • TV/Anime
  • TV/Documentary
  • TV/x265

Changed in version 0.6.1: The Sonarr-native values for Newznab/Torznab categories (e.g. TV/WEB-DL) can now be specified, instead of the Buildarr-native values (e.g. TV-WEBDL). The old values can still be used.

Also search for anime using the standard numbering. Only applies for Anime series types.

additional_parameters: Optional[str] = None class-attribute instance-attribute #

Additional Torznab API parameters.