{"id":16243324,"url":"https://github.com/svrooij/sonos-api-docs","last_synced_at":"2025-03-19T17:32:15.728Z","repository":{"id":45195073,"uuid":"308629657","full_name":"svrooij/sonos-api-docs","owner":"svrooij","description":"🔊 📖 Sonos api documentation for the local UPNP api and a generator to generate clients based on service discovery","archived":false,"fork":false,"pushed_at":"2024-02-14T09:18:46.000Z","size":652,"stargazers_count":30,"open_issues_count":2,"forks_count":7,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-05-13T16:25:22.715Z","etag":null,"topics":["hacktoberfest","sonos","sonos-api","upnp"],"latest_commit_sha":null,"homepage":"https://sonos.svrooij.io","language":"TypeScript","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/svrooij.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/Funding.yml","license":"LICENSE","code_of_conduct":".github/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":"svrooij"}},"created_at":"2020-10-30T12:51:48.000Z","updated_at":"2024-05-04T23:30:49.000Z","dependencies_parsed_at":"2024-10-10T14:14:33.275Z","dependency_job_id":"3b651a1f-b461-4ce4-98ba-9f219afe7f21","html_url":"https://github.com/svrooij/sonos-api-docs","commit_stats":{"total_commits":101,"total_committers":10,"mean_commits":10.1,"dds":0.1188118811881188,"last_synced_commit":"2b1b4eff90eb788961fdd92e5870e17d8188e7bf"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/svrooij%2Fsonos-api-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/svrooij%2Fsonos-api-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/svrooij%2Fsonos-api-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/svrooij%2Fsonos-api-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/svrooij","download_url":"https://codeload.github.com/svrooij/sonos-api-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221729522,"owners_count":16871034,"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":["hacktoberfest","sonos","sonos-api","upnp"],"created_at":"2024-10-10T14:14:31.197Z","updated_at":"2024-10-27T20:27:54.215Z","avatar_url":"https://github.com/svrooij.png","language":"TypeScript","funding_links":["https://github.com/sponsors/svrooij"],"categories":[],"sub_categories":[],"readme":"# Unofficial Sonos docs\n\n[![Sonos API documentation][badge_sonos-docs]][link_sonos-docs]\n[![Github Issues][badge_issues]][link_issues]\n[![Sonos2mqtt][badge_sonos-mqtt]][link_sonos-mqtt]\n[![Sonos cli][badge_sonos-cli]][link_sonos-cli]\n[![Sonos typescript this library][badge_sonos-typescript]][link_sonos-typescript]\n\n[![Support me on Github][badge_sponsor]][link_sponsor]\n[![Follow on Twitter][badge_twitter]][link_twitter]\n\nSonos API documentation for the local UPNP API and a [generator](https://github.com/svrooij/sonos-api-docs/tree/main/generator/sonos-docs) to generate clients and documentation based on service discovery\n\nThis library is in no way connected to [Sonos](//en.wikipedia.org/wiki/Sonos). It's just a set of text files to document a hidden and **unsupported** API.\n\n## Documentation\n\nCheck-out the (generated) documentation about all the SONOS UPNP services [svrooij.io/sonos-api-docs/services/](https://sonos.svrooij.io/services/)\n\n[![Sonos API documentation][badge_sonos-docs]][link_sonos-docs]\n\n[Read documentation](https://sonos.svrooij.io/)\n\n### Manually documented\n\nThe [sonos services](https://sonos.svrooij.io/services/) have no documentation, that is why we manually created a [documentation.json](https://github.com/svrooij/sonos-api-docs/blob/main/docs/documentation.json) file. To easily add documentation to all services (that are generated with the generator). And it's json so you can easily use it yourself.\n\n### Device discovery files\n\nYou can use the generator to generate your own discovery files, but we also have the files available for download.\n\n| Player | Discovery file(s) |\n| ------ | ----------------- |\n| Sonos Play:1 | [S2](https://github.com/svrooij/sonos-api-docs/raw/main/generator/sonos-docs/data/sonos-S1-2.json) |\n| Sonos Play:3 | [S2](https://github.com/svrooij/sonos-api-docs/raw/main/generator/sonos-docs/data/sonos-S3-2.json) |\n| Sonos Play:5 (new) | [S2](https://github.com/svrooij/sonos-api-docs/raw/main/generator/sonos-docs/data/sonos-S6-2.json) |\n| Sonos Playbar | [S2](https://github.com/svrooij/sonos-api-docs/raw/main/generator/sonos-docs/data/sonos-S9-2.json) |\n| Sonos One | [S2](https://github.com/svrooij/sonos-api-docs/raw/main/generator/sonos-docs/data/sonos-S13-2.json) |\n| Sonos One (mic) | [S2](https://github.com/svrooij/sonos-api-docs/raw/main/generator/sonos-docs/data/sonos-S18-2.json) |\n| Sonos Beam | [S2](https://github.com/svrooij/sonos-api-docs/raw/main/generator/sonos-docs/data/sonos-S14-2.json) |\n| Sonos Roam | [S2](https://github.com/svrooij/sonos-api-docs/raw/main/generator/sonos-docs/data/sonos-S27-2.json) |\n| Sonos Sub | [S2](https://github.com/svrooij/sonos-api-docs/raw/main/generator/sonos-docs/data/sonos-Sub-2.json) |\n| SYMFONISK Bookshelf| [S2](https://github.com/svrooij/sonos-api-docs/raw/main/generator/sonos-docs/data/sonos-S21-2.json) |\n| Sonos Play:5 (old) | [S1](https://github.com/svrooij/sonos-api-docs/raw/main/generator/sonos-docs/data/sonos-S5-1.json) |\n\nThese files together with the documentation file, are combined to a extensive JSON file, that is used as an input for the generator.\n\n## Community\n\nIf you have any [questions](https://github.com/svrooij/sonos-api-docs/discussions/categories/q-a) or you want to [show](https://github.com/svrooij/sonos-api-docs/discussions/categories/show-and-tell) your Sonos integration. Please join us in the [discussions](https://github.com/svrooij/sonos-api-docs/discussions) tab on this repository.\n\n## Contributors ✨\n\n\u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors-)\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://svrooij.nl\"\u003e\u003cimg src=\"https://avatars2.githubusercontent.com/u/1292510?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eStephan van Rooij\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/svrooij/sonos-api-docs/commits?author=svrooij\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/svrooij/sonos-api-docs/commits?author=svrooij\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"#ideas-svrooij\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e \u003ca href=\"#maintenance-svrooij\" title=\"Maintenance\"\u003e🚧\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/hklages\"\u003e\u003cimg src=\"https://avatars3.githubusercontent.com/u/17273119?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eH. Klages\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/svrooij/sonos-api-docs/commits?author=hklages\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/sschuberth\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/349154?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eSebastian Schuberth\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/svrooij/sonos-api-docs/commits?author=sschuberth\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/jkossis\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/1247832?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eJason Kossis\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/svrooij/sonos-api-docs/commits?author=jkossis\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors)\nspecification. Contributions of any kind welcome!\n\n[badge_issues]: https://img.shields.io/github/issues/svrooij/sonos-api-docs?style=for-the-badge\n[badge_sonos-cli]: https://img.shields.io/badge/sonos-cli-blue?style=for-the-badge\n[badge_sonos-docs]: https://img.shields.io/badge/sonos-api-blue?style=for-the-badge\n[badge_sonos-mqtt]: https://img.shields.io/badge/sonos-mqtt-blue?style=for-the-badge\n[badge_sonos-typescript]: https://img.shields.io/badge/sonos-typescript-blue?style=for-the-badge\n[badge_sponsor]: https://img.shields.io/github/sponsors/svrooij?logo=github\u0026style=for-the-badge\n[badge_twitter]: https://img.shields.io/twitter/follow/svrooij?logo=twitter\u0026style=for-the-badge\n\n[link_sponsor]: https://github.com/sponsors/svrooij\n[link_issues]: https://github.com/svrooij/sonos-api-docs/issues\n[link_sonos-cli]: https://github.com/svrooij/sonos-cli\n[link_sonos-docs]: https://sonos.svrooij.io/\n[link_sonos-mqtt]: https://sonos2mqtt.svrooij.io/\n[link_sonos-typescript]: https://sonos-ts.svrooij.io/\n[link_twitter]: https://twitter.com/svrooij\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsvrooij%2Fsonos-api-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsvrooij%2Fsonos-api-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsvrooij%2Fsonos-api-docs/lists"}