n8n-nodes-lidarr

This is an n8n community node for interacting with the Lidarr API. It allows you to automate your music library management through n8n workflows.

n8n is a fair-code licensed workflow automation platform.

Lidarr is a music collection manager for Usenet and BitTorrent users.

Installation

Follow the installation guide in the n8n community nodes documentation.

npm

npm install n8n-nodes-lidarr

Manual installation

1. Clone this repository
2. Run npm install to install dependencies
3. Run npm run build to build the node
4. Copy the built files to your n8n custom nodes directory

Operations

The Lidarr node supports the following resources and operations:

Artist

• Create: Add a new artist to your library
• Delete: Remove an artist from your library
• Get: Retrieve information about a specific artist
• Get All: Get all artists in your library
• Lookup: Search for an artist to add
• Update: Update an existing artist

Album

• Create: Add a new album (requires Foreign Album ID from Lookup operation)
• Delete: Remove an album
• Get: Get information about a specific album
• Get All: Get all albums (optionally filtered by artist)
• Lookup: Search for an album to add (returns MusicBrainz IDs needed for Create)
• Update: Update an existing album

Calendar

• Get: Get upcoming album releases

Command

• Execute: Execute a Lidarr command (e.g., Refresh Artist, Album Search, RSS Sync)
• Get: Get the status of a command
• Get All: Get all commands

Queue

• Get All: Get all items in the download queue
• Delete: Remove an item from the queue

System

• Get Status: Get system status information

Wanted

• Get Cutoff: Get albums that don't meet the quality cutoff

Credentials

To use this node, you need to configure Lidarr API credentials:

1. Go to your Lidarr instance
2. Navigate to Settings > General > Security
3. Copy your API Key
4. In n8n, create new Lidarr API credentials with:
   • Host: Your Lidarr URL (default: http://localhost:8686)
   • API Key: The API key from Lidarr

Usage Examples

Adding an Album

To add an album to your Lidarr library, you need to use a two-step process:

1. Lookup: Use the Album Lookup operation to search for the album you want to add

   • Set Resource to "Album"
   • Set Operation to "Lookup"
   • Enter your search term (e.g., "Dark Side of the Moon Pink Floyd")
   • This returns results with foreignAlbumId (MusicBrainz ID)

2. Create: Use the Album Create operation to add the album

   • Set Resource to "Album"
   • Set Operation to "Create"
   • Enter the foreignAlbumId from the Lookup result
   • Optionally set Artist ID, Monitored status, and other options
   • Set "Search for New Album" to true to automatically search for the album after adding

The same workflow applies to adding artists (Artist Lookup → Artist Create).

Compatibility

• Lidarr API v1
• n8n version 0.174.0 or higher

Resources

• n8n community nodes documentation
• Lidarr API documentation
• Lidarr website

License

MIT

Author

Martien - [email protected]