{"id":15008900,"url":"https://github.com/n4s4/synology-api","last_synced_at":"2025-05-14T15:07:02.310Z","repository":{"id":38855209,"uuid":"138232891","full_name":"N4S4/synology-api","owner":"N4S4","description":"A Python wrapper around Synology API","archived":false,"fork":false,"pushed_at":"2025-04-02T15:48:01.000Z","size":1913,"stargazers_count":431,"open_issues_count":6,"forks_count":151,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-04-04T23:02:33.798Z","etag":null,"topics":["python","python-3","synology","synology-api","synology-nas"],"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/N4S4.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"N4S4","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2018-06-21T23:43:47.000Z","updated_at":"2025-04-02T06:32:16.000Z","dependencies_parsed_at":"2022-07-11T22:46:14.719Z","dependency_job_id":"d282b556-69bf-4e01-b89c-087101b0006d","html_url":"https://github.com/N4S4/synology-api","commit_stats":{"total_commits":325,"total_committers":45,"mean_commits":7.222222222222222,"dds":0.6492307692307693,"last_synced_commit":"a7bb0ff7ccee55d605c2ea385f86b31735bf26d2"},"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/N4S4%2Fsynology-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/N4S4%2Fsynology-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/N4S4%2Fsynology-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/N4S4%2Fsynology-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/N4S4","download_url":"https://codeload.github.com/N4S4/synology-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248505871,"owners_count":21115354,"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":["python","python-3","synology","synology-api","synology-nas"],"created_at":"2024-09-24T19:21:31.509Z","updated_at":"2025-04-12T01:51:21.765Z","avatar_url":"https://github.com/N4S4.png","language":"Python","funding_links":["https://github.com/sponsors/N4S4","https://paypal.me/ren4s4"],"categories":[],"sub_categories":[],"readme":"\n![synology-api](https://user-images.githubusercontent.com/33936751/100731387-99fffc00-33cb-11eb-833c-b6ab87177651.jpg)\n\u003ca href=\"https://pepy.tech/projects/synology-api\" rel=\"noreferrer\" target=\"_blank\"\u003e\u003cimg alt=\"Pepy Total Downloads\" src=\"https://img.shields.io/pepy/dt/synology-api?color=blue\"\u003e\u003c/a\u003e\n\u003ca href=\"https://n4s4.github.io/synology-api\" rel=\"noreferrer\" target=\"_blank\"\u003e\u003cimg alt=\"Website\" src=\"https://img.shields.io/website?url=https%3A%2F%2Fn4s4.github.io%2Fsynology-api\u0026label=docs\u0026color=green\"\u003e\u003c/a\u003e\n\n\u003ca href=\"https://github.com/N4S4/synology-api/commits/master/\" rel=\"noreferrer\" target=\"_blank\"\u003e\u003cimg alt=\"GitHub last commit\" src=\"https://img.shields.io/github/last-commit/n4s4/synology-api\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/N4S4/synology-api/blob/master/LICENSE.txt\" rel=\"noreferrer\" target=\"_blank\"\u003e\u003cimg alt=\"GitHub License\" src=\"https://img.shields.io/github/license/n4s4/synology-api\"\u003e\u003c/a\u003e\n\n\n# Synology Wrapper\n\nIf you find yourself here, most probably you are trying to develop something for your NAS, this wrapper might come to your help to build your script.\n\nI would like to specify that I do this for hobby as is my passion and in my little free time.\n\nSaid this, there is no warranties chained and this library is provided \"As Is\", you will find many things can be simplified, and I slowly will but feel free to [Contribute](https://n4s4.github.io/synology-api/docs/contribute).\n \n## Premise\n\nI've tried this wrapper only with `python3`.  \nI do not know if it actually runs with previous versions \n\nBefore opening an issue make sure you do your own research, if you are not sure, write me.\n\n## Installation\n\nThe package is distributed via pip3, but it can also be installed from source.\n\n```bash\npip3 install synology-api\n```\n\nor\n\n```bash\npip3 install git+https://github.com/N4S4/synology-api\n```\n\n\n## Basic Usage\nHere is a basic example on how to use the package, check [Getting Started - Basic Usage](https://n4s4.github.io/synology-api/docs/getting-started/usage) for more details.\n\n```python\nfrom synology_api.filestation import FileStation\nfrom synology_api.downloadstation import DownloadStation\n\nfs = FileStation(\n    'Synology Ip',\n    'Synology Port',\n    'Username',\n    'Password',\n    secure=False,\n    cert_verify=False,\n    dsm_version=7,\n    debug=True,\n    otp_code=None\n)\n\nds = DownloadStation(\n    'Synology Ip',\n    'Synology Port',\n    'Username',\n    'Password',\n    secure=False,\n    cert_verify=False,\n    dsm_version=7,\n    debug=True,\n    otp_code=None\n)\n\nfs_info = fs.get_info()\nds_info = ds.get_info()\n\n```\n\n## Available Functions\n\nAt the moment there are around +300 APIs implemented with countless methods for each, the majority is not documented, but some are.  \n\nYou can find a exhaustive list here:  \n[APIs - Supported APIs](https://n4s4.github.io/synology-api/docs/apis) \n\n## Feeling kind?\nIf this code helps and you wish to support me:\n- [Paypal](https://paypal.me/ren4s4)\n- [GitHub Sponsor](https://github.com/sponsors/N4S4)\n\n## Community\n- [Telegram Group](https://t.me/SynologyApi)\n- [Github Discussions](https://github.com/N4S4/synology-api/discussions)\n\n## See Related projects\n\n- [Synology API Telegram Bot](https://github.com/N4S4/synology-api-telegram-bot)\n\nIf you want to show your project in this section, write me.\n\n## Bugs\n\nMaybe? \n\nI hate bugs..\n\nWell report them please (if you'll ever use this code)\n\n## Conclusions\n\nThere is still a lot to implement.\n\nThe code is probably in some parts twisted, I will try to optimize it at best.\n\n## Contributing\n\nJust Don't Be Scared.  \nCheck [Contribute - Contribution 101](https://n4s4.github.io/synology-api/docs/contribute) for useful information.\n\n## Author\n\n- Renato Visaggio - _Initial_ _Work_ - [N4S4](https://github.com/N4S4)\n\n## Contributors\n\n- List of contributors here: [Contributors](https://github.com/N4S4/synology-api/graphs/contributors)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fn4s4%2Fsynology-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fn4s4%2Fsynology-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fn4s4%2Fsynology-api/lists"}