README.md

March 22, 2026 · View on GitHub

Release Stargazers codecov

GitHub last release date GitHub last commit

Contributors Forks Issues

Lines of code Code size

MIT License LinkedIn


Logo

Pyarr

A Python library for interacting with the `arr` API's



Report Bug · Request Feature
Table of Contents
  1. About The Project
  2. Getting Started
  3. Features
  4. Compatibility
  5. Roadmap
  6. Sponsor
  7. Contributing
  8. License
  9. Contact
  10. Acknowledgments

About The Project

A Python library for the following arr API's:

  • Sonarr
  • Radarr
  • Readarr
  • Lidarr
  • Prowlarr
  • Dispatcharr
  • Bazarr
  • Whisparr

The library supports both Synchronous and Asynchronous (asyncio) usage, providing a consistent API for both. It returns results in JSON format for ease of use, this also reduces the risk of failue when the arr APIs are updated.

(back to top)

Built With

python

(back to top)

Getting Started

(back to top)

Features

  • Support for multiple Arr APIs
  • Sonarr
  • Radarr
  • Readarr
  • Lidarr
  • Type checking

Compatibility

The below versions are based on our last tests, This will be updated as tests fail and updates are published.

VersionSonarrRadarrReadarrLidarr
v5.0.0from: v3.0.10.1567from: v4.3.2.6857from: v0.1.4.1596from: v1.0.2.2592

(back to top)

Roadmap

See the feature requests for a full list of requested features.

(back to top)

My projects arent possible without the support of the community, please consider donating a small amount to keep these projects alive.

Sponsor

Contributing

Got something you would like to add? check out the contributing guide in the documentation

(back to top)

License

CC BY-NC-SA 4.0

(back to top)

Contact

(back to top)

Acknowledgments

Below are a list of resources that I used to assist with this project.

  • None at this time

(back to top)