Pyarr: Sonarr and Radarr API Python Wrapper

About • Install • Contribute • Author • Support • Donate • Full Documentation

---

About

Pyarr is a high quality Python API Wrapper that provides access to both Radarr and Sonarr REST APIs.

Install

This package is distributed on PyPI and can be installed with pip:

$ pip install pyarr

To use the package in your Python project, you will need to add the following:

from pyarr import SonarrAPI
from pyarr import RadarrAPI

For more information read the full documentation on installing the package

Example Sonarr Usage:

# Import SonarrAPI Class
from pyarr import SonarrAPI

# Set Host URL and API-Key
host_url = 'http://your-domain.com'

# You can find your API key in Settings > General.
api_key = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

# Instantiate SonarrAPI Object
sonarr = SonarrAPI(host_url, api_key)

# Get and print TV Shows
print(sonarr.get_series())

Example Radarr API Usage:

# Import RadarrAPI Class
from pyarr import RadarrAPI

# Set Host URL and API-Key
host_url = 'http://your-domain.com'

# You can find your API key in Settings > General.
api_key = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

# Instantiate RadarrAPI Object
radarr = RadarrAPI(host_url, api_key)

# Get and print TV Shows
print(radarr.get_root_folder())

Contribute

Got something interesting you'd like to share? Learn about contributing in our contributing guide.

Author

marksie1988 (Steven Marks)

Credits

• Archmonger Some excellent contribution and improvements.

Support

Reach out to me at one of the following places:

• Discord
• Discussions
• Issues

Donate

Please consider supporting this project by sponsoring, or just donating a little via our sponsor page.

License

• Copyright © Total Debug