Repository navigation
Connecting Apps
The Torznab endpoint, *arr synchronization, API keys and live search.
In the Settings page copy the full endpoint:
http://<host>:8788/api?apikey=<API_KEY>
In the client add a Torznab indexer:
| Field | Value |
|---|---|
| URL | http://<host>:8788/api |
| API Key | the key shown in Settings |
| Categories |
5000 TV, 2000 Movies, 3000 Audio, 7000 Books |
The /torznab/api and /newznab/api aliases and the API key in the
X-Api-Key header are also supported. Full details in Torznab API.
In App you connect Sonarr, Radarr, Lidarr, Readarr, Whisparr, Mylar3 and LazyLibrarian. Choose the level:
- Disabled: no contact;
- Add/remove only: creates and removes the indexers;
- Full sync: also updates the existing indexers.
In Advanced you set the profile of the individual app: RSS, automatic search, interactive search, minimum seeders (0 = indexer value) and Torznab categories to send (empty = all supported ones). An indexer with no categories in common is not synchronized with that app. The tag filter decides which sources to send to which app; before every change a snapshot is saved, restorable from the same page.
indexarr creates in the app only the indexers whose name starts with
indexarr · . The rest is not touched.
In Settings → Torznab API the primary key remains the one shown in the
endpoint. Below, Additional API keys lets you create one per client
(Sonarr, Radarr, Lidarr, a script) with name, creation date, last use and
number of requests. Each key can be revoked without touching the others;
.torrent/.nzb links use the key with which the request was made. API
requests per key per minute applies a limit per key (0 = unlimited): above
the threshold the response is HTTP 429 with Retry-After.
With live search enabled (the default), every Torznab search that carries a query or an external id asks the enabled sources that can search — native definitions, families, Torznab and Newznab — at that moment. What arrives within Live search response wait (5 s) is saved and merged with the cache; the answer returns earlier when every indexer has finished. Indexers still running continue in the background up to Live search timeout (20 s), so their results are already in the cache for the next page or the next request. A result stays cached for Live search cache (300 s). RSS feeds and uploader lists do not take part because they do not accept a search term. A request by id alone does not trigger a live search on sites that do not support ids. Turn it off if you prefer an answer from the cache only.
Part of the indexarr documentation.
indexarr
Guides
APIs
Sources
Operations
Project