A simple HTTP API for Sonos to simplify automation. Hostable on any node.js capable device, like a raspberry pi or similar.

Download as .zip Download as .tar.gz Download an image for raspberry pi View on GitHub

PayPal donate button

This application requires node 4.0.0 or higher!

This should now work with node 6, let me know if that is not the case.

A simple http based API for controlling your Sonos system.

There is a simple sandbox at /docs (incomplete atm)


Start by fixing your dependencies. Invoke the following command:

npm install --production

This will download the necessary dependencies if possible.

start the server by running

npm start

Now you can control your system by invoking the following commands:

http://localhost:5005/pauseall[/{timeout in minutes}]
http://localhost:5005/resumeall[/{timeout in minutes}]
http://localhost:5005/preset/{JSON preset}
http://localhost:5005/preset/{predefined preset name}
http://localhost:5005/{room name}/sleep/{timeout in seconds or timestamp HH:MM:SS or off}
http://localhost:5005/{room name}/sleep/{timeout in seconds or timestamp HH:MM:SS or off}
http://localhost:5005/{room name}/{action}[/{parameter}]


http://localhost:5005/living room/volume/15 (will set volume for room Living Room to 15%)

http://localhost:5005/living room/volume/+1 (will increase volume by 1%)

http://localhost:5005/living room/next (will skip to the next track on living room, unless it’s not a coordinator)

http://localhost:5005/living room/pause (will pause the living room)

http://localhost:5005/living room/favorite/mysuperplaylist (will replace queue with the favorite called “mysuperplaylist”)

http://localhost:5005/living room/repeat/on (will turn on repeat mode for group)

The actions supported as of today:


Example of a state json:

    "title":"Teenage Color - Anoraak Remix",
    "album":"Nightdrive With You",
    "title":"Thinking of You",


Obtain the current queue list from a specified player. The request will accept:

Example queue response:

  "startIndex": "0",
  "numberReturned": 2,
  "totalMatches": 33,
  "items": [
      "uri": "x-sonos-spotify:spotify%3atrack%3a0AvV49z4EPz5ocYN7eKGAK?sid=9&flags=8224&sn=3",
      "albumArtURI": "/getaa?s=1&u=x-sonos-spotify%3aspotify%253atrack%253a0AvV49z4EPz5ocYN7eKGAK%3fsid%3d9%26flags%3d8224%26sn%3d3",
      "title": "No Diggity",
      "artist": "Blackstreet",
      "album": "Another Level"
      "uri": "x-sonos-spotify:spotify%3atrack%3a5OQGeJ1ceykovrykZsGhqL?sid=9&flags=8224&sn=3",
      "albumArtURI": "/getaa?s=1&u=x-sonos-spotify%3aspotify%253atrack%253a5OQGeJ1ceykovrykZsGhqL%3fsid%3d9%26flags%3d8224%26sn%3d3",
      "title": "Breathless",
      "artist": "The Corrs",
      "album": "In Blue"


A preset is a predefined grouping of players with predefined volumes, that will start playing whatever is in the coordinators queue.

Example preset (state and uri are optional):

  "players": [
    { "roomName": "room1", "volume": 15},
    {"roomName": "room2", "volume": 25}
  "state": "stopped",
  "favorite": "my favorite name",
  "uri": "x-rincon-stream:RINCON_0000000000001400",
  "playMode": {
    "shuffle": true
  "pauseOthers": true

The first player listed in the example, “room1”, will become the coordinator. Playmode defines the three options “shuffle”, “repeat”, “crossfade” similar to the state. Favorite will have precedence over a uri. pauseOthers will pause all zones before applying the preset, effectively muting your system.


You can create a file with pre made presets, called presets.json. It will be loaded upon start, any changes requires a restart of the server.

Example content:

  "all": {
    "playMode": {
      "shuffle": true
    "players": [
        "roomName": "Bathroom",
        "volume": 10
        "roomName": "Kitchen",
        "volume": 10
        "roomName": "Office",
        "volume": 10
        "roomName": "Bedroom",
        "volume": 10
        "roomName": "TV Room",
        "volume": 15
    "pauseOthers": true
  "tv": {
    "players": [
        "roomName": "TV Room",
        "volume": 20
    "pauseOthers": true,
    "uri": "x-rincon-stream:RINCON_000XXXXXXXXXX01400"

In the example, there is one preset called all, which you can apply by invoking:



If you want to change default settings, you can create a settings.json file and put in the root folder.

Available options are:


      "voicerss": "Your api key for TTS with voicerss",
      "port": 5005,
      "securePort": 5006,
      "cacheDir": "./cache",
      "https": {
        "key": "/path/to/key.pem",
        "cert" : "/path/to/cert.pem"

        //... for pfx (alternative configuration)
        "pfx": "/path/to/pfx.pfx",
        "passphrase": "your-passphrase-if-applicable"
      "auth": {
        "username": "admin",
        "password": "password"
      "announceVolume": 40

Override as it suits you.


It has support for starting favorites. Simply invoke:

http://localhost:5005/living room/favorite/[favorite name]

and it will replace the queue with that favorite. Bear in mind that favorites may share name, which might give unpredictable behavior at the moment.


Playing a Sonos playlist is supported. Invoke the following:

http://localhost:5005/living room/playlist/[playlist name]

and it will replace the queue with the playlist and starts playing.

Say (TTS support)

Experimental support for TTS. This REQUIRES a registered API key from voiceRSS! See for info.

You need to add this to a file called settings.json (create if it doesn’t exist), like this:

  "voicerss": "f5e77e1d42063175b9219866129189a3"

Replace the code above (it is just made up) with the api-key you’ve got after registering.

Action is:

/[Room name]/say/[phrase][/[language_code]][/[announce volume]]
/sayall/[phrase][/[language_code]][/[announce volume]]


/Office/say/Hello, dinner is ready
/Office/say/Hej, maten är klar/sv-se
/sayall/Hello, dinner is ready
/Office/say/Hello, dinner is ready/90
/Office/say/Hej, maten är klar/sv-se/90

language code needs to be before volume if specified.

Sayall will group all players, set 40% volume (by default) and then try and restore everything as the way it where. Please try it out, it will probably contain glitches but please report detailed descriptions on what the problem is (starting state, error that occurs, and the final state of your system).

The supported language codes are:

ca-es Catalan
zh-cn Chinese (China)
zh-hk Chinese (Hong Kong)
zh-tw Chinese (Taiwan)
da-dk Danish
nl-nl Dutch
en-au English (Australia)
en-ca English (Canada)
en-gb English (Great Britain)
en-in English (India)
en-us English (United States)
fi-fi Finnish
fr-ca French (Canada)
fr-fr French (France)
de-de German
it-it Italian
ja-jp Japanese
ko-kr Korean
nb-no Norwegian
pl-pl Polish
pt-br Portuguese (Brazil)
pt-pt Portuguese (Portugal)
ru-ru Russian
es-mx Spanish (Mexico)
es-es Spanish (Spain)
sv-se Swedish (Sweden)

Spotify, Apple Music, and SiriusXM (Experimental)

The following endpoints are available:

# Spotify

# Apple Music
/RoomName/applemusic/queue/name:{artist name, song title, artist name & song title}
/RoomName/applemusic/radio/radio:{artist name, song title, artist name & song title}

# SiriusXM
/RoomName/siriusXM/{channel number,station name}

You can find Apple Music song and album IDs via the iTunes Search API.

You can specify an artist name, song title, or combination of the two, iTunes search will be searched automatically, and the results will be played. With the radio action you can specify the same and an Apple Music Radio station for the artist or track will be played.

It only handles a single spotify account currently. It will probably use the first account added on your system.

You can specify a SiriusXM channel number or station name and the station will be played.

Experiment with these and leave feedback!


NOTE! This is experimental and might change in the future! Please leave your feedback as github issues if you feel like it doesn’t suit your need, since I don’t know what kind of restrictions you will be facing.

If you add a setting in settings.json like this:

  "webhook": "http://localhost:5007/"

Every state change, topology change and volume change will be posted (method POST) to that URL, as JSON. The following data structure will be sent:

  "type": "transport-state",
  "data": { (snapshot of player) }


  "type": "topology-change",
  "data": { (snapshot of zones) }


  "type": "volume-change",
  "data": { (snapshot of volume) }

“data” property will be equal to the same data as you would get from /RoomName/state or /zones. There is an example endpoint in the root if this project called test_endpoint.js which you may fire up to get an understanding of what is posted, just invoke it with “node test_endpoint.js” in a terminal, and then start the http-api in another terminal.

Pre-composed raspberry pi image

There is a pre-composed image based on AlpineLinux available for simplicitly. This is a cross-version build that runs on raspberry pi B/B+, 2 and version 3. For more information on AlpineLinux, visit their homepage and read the wiki.

The system will run from a RAM-drive, except for the files related to Sonos HTTP API. Because of this, it should be fairly resistent against powercuts or sudden resets. The tear on the SD-card should only be minimal

The sshd daemon will generate new host keys upon first boot, and persist these for future boots. By default the root user has no password, if you want to set a password, just SSH to that machine and set a new root password.

It also has samba installed by default, and sharing the /flash folder with read/write permissions for easier access. Just visit \\sonos from a windows machine or smb://sonos from macOS (replace sonos with the IP if it doesn't work)

To write the image to an SD-card, use the

command on Linux and OS X, or Win32DiskWriter for Windows.