API Reference

Prevents Sonarr/Radarr from downloading media already available for your region on streaming services (e.g., Netflix, Amazon Prime Video)
💥 Report Bug 💥 · ✨ Request Feature ✨

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation with Docker compose
3. Roadmap
4. Contributing

About The Project

Proxarr is a lightweight proxy server for automatically qualify requested media items based in countries served by watching providers. It uses TMDB to find out which streaming services are available in the selected region.

Getting Started

Prerequisites

• Acquire TMDB API KEY How
• Obtain SONARR/RADARR API KEY
  

Installation with Docker compose

1. Prepare your config.yml to fit your setup

2. On your Radarr/Sonarr instances we have to do some changes

   • tag all indexers by the TAG_NAME defined in your config.yml (q by default)
     
   • specify Application URL: is essential because it is used by Proxarr to determine to which instance should return the response
     
   • establish a Webhook connection between Sonarr/Radarr and Proxarr
     
     Note : Webhook URL is `http://<Proxarr_Instance>/api/qualifier

3. Add the following to your docker-compose.yml (to be adapted according to your stack)
   docker-compose.yml is an another full example of how to integrate Proxarr with Sonarr and Radarr.

      proxarr:
        image: synker/proxarr:latest
        container_name: proxarr
        restart: unless-stopped
        depends_on:
          sonarr:
            condition: service_healthy
          radarr:
            condition: service_healthy
        healthcheck:
          test: curl --fail http://localhost:8880/health || exit 1
          interval: 10s
          retries: 3
          start_period: 5s
          timeout: 3s
        ports:
          - "8880:8880"
        environment:
          - LOG_LEVEL=Information
          - TZ="Europe/Paris"
        volumes:
          - ./:/app/config
          - ./logs:/logs"

4. Run

    docker compose -f docker-compose.yml up -d

Standalone docker container example

docker run -itd --rm -e LOG_LEVEL=Debug -p 8880:8880 -v ${PWD}/config:/app/config --name proxarr synker/proxarr:latest

Watching providers configuration

For the lazy ones, all available regions and providers are available here.

For the curious ones, you can use the following APIs to get the available regions and providers:

• TMDB API to get available regions
• TMDB API to get available movie providers by region
• TMDB API to get available tv providers by region

Roadmap

• Add Api versioning

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. Don't forget to give the project a ⭐ star ⭐ ! Thanks again!

For further information, click here

Top contributors