{"id":13593964,"url":"https://github.com/vaparr/pyoverseerr","last_synced_at":"2025-04-09T05:32:38.173Z","repository":{"id":40236373,"uuid":"326221519","full_name":"vaparr/pyoverseerr","owner":"vaparr","description":"Python interface to Overseerr","archived":false,"fork":false,"pushed_at":"2023-08-06T13:28:33.000Z","size":52,"stargazers_count":8,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-04T16:49:49.717Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vaparr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2021-01-02T16:20:01.000Z","updated_at":"2022-12-20T14:26:16.000Z","dependencies_parsed_at":"2024-01-14T04:36:47.078Z","dependency_job_id":"8c88faff-81ab-4c30-82b7-83e1e2c2e708","html_url":"https://github.com/vaparr/pyoverseerr","commit_stats":{"total_commits":49,"total_committers":4,"mean_commits":12.25,"dds":0.4285714285714286,"last_synced_commit":"864761848d932478309fdbe4693dd07ca93df1c6"},"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaparr%2Fpyoverseerr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaparr%2Fpyoverseerr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaparr%2Fpyoverseerr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vaparr%2Fpyoverseerr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vaparr","download_url":"https://codeload.github.com/vaparr/pyoverseerr/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247987056,"owners_count":21028891,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T16:01:26.967Z","updated_at":"2025-04-09T05:32:37.332Z","avatar_url":"https://github.com/vaparr.png","language":"Python","readme":"[![PyPI version](https://badge.fury.io/py/pyoverseerr.svg)](https://badge.fury.io/py/pyoverseerr)\n[![Downloads](https://pepy.tech/badge/pyoverseerr)](https://pepy.tech/project/pyoverseerr)\n\n# pyoverseerr\n\nThis is a project for retrieving information from an Overseerr instance using their API.\n\n\n# Installation\n\nRun the following to install:\n```python\npip install pyoverseerr\n```\n\n\n# Usage\n\n\n#### Creating an object of your Overseerr instance\n\n**Note:** You have to supply an `api_key` to successfully authenticate.\n\n```python\nimport pyoverseerr\n\noverseerr = pyoverseerr.Overseerr(\n    ssl=True,\n    host=\"192.168.1.120\",\n    port=\"5000\",\n    urlbase=\"overseerr/\",\n    api_key=\"pixf64thuh2m7kbwwgkqp52yznbj4oyo\"\n)\n```\n\n#### Authenticate\n\n```python\noverseerr.authenticate()\n```\n\n#### Testing connection to Overseerr\n\n```python\ntry:\n    overseerr.test_connection()\nexcept pyoverseerr.OverseerrError as e:\n    print(e)\n    return\n```\n\n#### Retrieving data\n```python\nmovies = overseerr.movie_requests\ntv = overseerr.tv_requests\nmusic = overseerr.music_requests\n\ntotal = overseerr.total_requests\n```\n\n#### Searching\n\n```python\nmovie_search = overseerr.search_movie(\"Movie Name\")  \ntv_search = overseerr.search_tv(\"TV show name\")\n```\n\n#### Requesting\n```python\noverseerr.request_movie(\"theMovieDbId\")\noverseerr.request_tv(\"theTvDbId\", request_latest=True)\n```\n\n# License\n\nThis project is licensed under the MIT License - see the LICENSE.txt file for details.\n","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvaparr%2Fpyoverseerr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvaparr%2Fpyoverseerr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvaparr%2Fpyoverseerr/lists"}