sonarr

n8n node for Sonarr API integration

Package Information

Released: 10 mo ago
Downloads: 9 weekly / 41 monthly
Latest Version: 0.1.2
Author: Martien

Available Nodes

Sonarr icon
Sonarr
Interact with Sonarr API

Documentation

n8n-nodes-sonarr

This is an n8n community node that lets you interact with the Sonarr API in your n8n workflows.

Sonarr is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them.

n8n is a fair-code licensed workflow automation platform.

Installation

Follow the installation guide in the n8n community nodes documentation.

  1. Go to Settings > Community Nodes.
  2. Select Install.
  3. Enter n8n-nodes-sonarr in Enter npm package name.
  4. Agree to the risks and select Install.

After installing the node, you can use it like any other node. n8n displays the node in search results in the Nodes panel.

Credentials

To use this node, you'll need a Sonarr instance and an API key:

  1. Open your Sonarr web interface
  2. Go to Settings > General > Security
  3. Copy the API Key

In n8n:

  1. Create new credentials of type Sonarr API
  2. Enter your Sonarr host URL (e.g., http://localhost:8989)
  3. Paste your API key

Resources

This node supports the following resources and operations:

Series

  • Get All: Retrieve all series in your library
  • Get: Get details of a specific series
  • Lookup: Search for a series to add
  • Create: Add a new series
  • Update: Update series information
  • Delete: Remove a series

Calendar

  • Get: Get upcoming episodes within a date range
    • Supports filtering by date range
    • Option to include unmonitored episodes
    • Can include series and episode file information

Episode

  • Get All: Get all episodes (can filter by series)
  • Get: Get a specific episode
  • Update: Update episode information

Queue

  • Get All: Get all items currently in the download queue
  • Delete: Remove an item from the queue
    • Option to remove from download client
    • Option to add to blocklist

Command

  • Execute: Run Sonarr commands like:
    • Refresh Series
    • Rescan Series
    • Series Search
    • Season Search
    • Episode Search
    • RSS Sync
    • Downloaded Episodes Scan
    • Rename Series
    • Backup
  • Get: Get status of a specific command
  • Get All: Get all running/recent commands

Wanted

  • Get Missing: Get all missing (wanted) episodes

System

  • Get Status: Get Sonarr system status and version information

Example Workflows

Automatic Episode Search

When a new episode airs (calendar), automatically trigger a search for it.

Monitor Downloads

Check the download queue periodically and send notifications when downloads complete or fail.

Series Management

Automatically add new series from a watchlist or external source.

Missing Episodes Report

Generate a weekly report of missing episodes.

Compatibility

This node has been developed for:

  • n8n version 1.0.0 or later
  • Sonarr v3 API (also compatible with v4)

Resources

Version History

0.1.2

  • Enhancement: Fully implemented Series Create operation
    • Added all required parameters (TVDB ID, Title, Quality Profile ID, Language Profile ID, Root Folder Path)
    • Added optional parameters (Monitored, Season Folder, Search for Missing Episodes)
    • Complete Series CRUD operations now available
    • Improved workflow: use Lookup to find series, then Create with configuration

0.1.1

  • Bug Fix: Fixed "Invalid URL" error when making API requests
    • Added baseURL parameter to all HTTP requests
    • Properly configured credentials to include Sonarr host URL in API calls

0.1.0

  • Initial release
  • Support for Series, Calendar, Episode, Queue, Command, Wanted, and System resources
  • Basic CRUD operations for all main resources

License

MIT

Development

Setup

npm install

Build

npm run build

Development Mode

npm run dev

Link to n8n for local testing

npm run build
cd ~/.n8n/custom
npm link /path/to/n8n-nodes-sonarr

Then restart n8n.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Future Enhancements

Planned features for future releases:

  • Support for Radarr (similar API structure)
  • Webhook triggers for Sonarr events
  • More advanced filtering options
  • Bulk operations support
  • Import list management
  • Quality profile management

Discussion