Skip to main content

Search Commands

The API command Houndarr issues when the engine triggers a search, per *arr app type. "Default" is the mode shipped with a fresh install; the "Advanced" mode, when available, is selected in the instance's search mode field.

Per-app command contract

AppDefault commandAdvanced command (missing pass)Upgrade pass
RadarrMoviesSearch with movieIdsn/a (always movie-level)MoviesSearch
SonarrEpisodeSearch with episodeIdsSeasonSearch with seriesId + seasonNumberEpisodeSearch or SeasonSearch
LidarrAlbumSearch with albumIdsArtistSearch with artistIdAlbumSearch or ArtistSearch
ReadarrBookSearch with bookIdsAuthorSearch with authorIdBookSearch or AuthorSearch
Whisparr v2EpisodeSearch with episodeIdsSeasonSearch with seriesId + seasonNumberEpisodeSearch or SeasonSearch
Whisparr v3MoviesSearch with movieIdsn/a (always movie-level)MoviesSearch

Wanted-list reads are restricted to monitored items (monitored=true) for both missing and cutoff passes across every app type.

Source of truth

The *arr API contract is vendored in the repo at docs/api/*_openapi.json (Sonarr v3, Radarr v3, Whisparr v2, Whisparr v3, Lidarr v1, Readarr v1). See docs/api/README.md for how to use the vendored specs.

Upgrade pass endpoint differences

The upgrade pass reuses the same search commands above but reads the full library endpoint rather than the wanted/* APIs, because upgrade candidates are items that already have files and meet cutoff. They are not "wanted" by the *arr definition.