Rockbot API Reference

Devices

devices/reboot

Reboot device at the specified zone_id

Parameters

Name	Type	Description
zone_id	integer	Numeric ID of zone to access

POST Request

curl -X POST "https://api.rockbot.com/v5/ext/devices/reboot" \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "zone_id": 7 }'

200 Response

{
  "true"
}

Music

music/now_playing

Return metadata of the currently playing track, upcoming tracks, and recently played tracks at the specified zone_id

Parameters

Name	Type	Description
zone_id	integer	Numeric ID of zone to access

GET Request

curl "https://api.rockbot.com/v5/ext/music/now_playing?zone_id=7" \
-H  "Authorization: Bearer ACCESS_TOKEN"

200 Response

{
  "venue": "Porterville Lanes",
  "street": "1625 Clay St",
  "city": "Oakland",
  "state": "CA",
  "zip": "94612",
  "current_users": 0,
  "status": "active",
  "volume": 50,
  "now_playing": {
    "pick_id": "22130649142",
    "artist_id": 40877,
    "artist": "DIIV",
    "song_id": 204131,
    "song": "Under The Sun",
    "artwork_small": "https://s.rockbot.com/upload/live/albums/150/4/804374.jpg",
    "artwork_large": "https://s.rockbot.com/upload/live/albums/500/4/804374.jpg",
    "user": "Rockbot",
    "user_image_small": "https://s.rockbot.com/upload/live/users/150/5/2621225.jpg",
    "user_image_large": "https://s.rockbot.com/upload/live/users/300/5/2621225.jpg",
    "likes": 0,
    "dislikes": 0,
    "duration": 138,
    "remaining": 89
  },
  "queue": [
    {
      "pick_id": "22130719395",
      "artist_id": 5894,
      "artist": "Jessie Ware",
      "song_id": 32378,
      "song": "Wildest Moments",
      "artwork_small": "https://s.rockbot.com/upload/live/albums/150/0/26460.jpg",
      "artwork_large": "https://s.rockbot.com/upload/live/albums/500/0/26460.jpg",
      "user": "Rockbot",
      "user_image_small": "https://s.rockbot.com/upload/live/users/150/5/2621225.jpg",
      "user_image_large": "https://s.rockbot.com/upload/live/users/300/5/2621225.jpg",
      "likes": 0,
      "dislikes": 0
    },
    {
      "pick_id": "22130753246",
      "artist_id": 602,
      "artist": "Pinback",
      "song_id": 3833,
      "song": "Penelope",
      "artwork_small": "https://s.rockbot.com/upload/live/albums/150/2/2232.jpg",
      "artwork_large": "https://s.rockbot.com/upload/live/albums/500/2/2232.jpg",
      "user": "Rockbot",
      "user_image_small": "https://s.rockbot.com/upload/live/users/150/5/2621225.jpg",
      "user_image_large": "https://s.rockbot.com/upload/live/users/300/5/2621225.jpg",
      "likes": 0,
      "dislikes": 0
    },
    {
      "pick_id": "22130849713",
      "artist_id": 5,
      "artist": "Pixies",
      "song_id": 5,
      "song": "Monkey Gone to Heaven",
      "artwork_small": "https://s.rockbot.com/upload/live/albums/150/9/18769.jpg",
      "artwork_large": "https://s.rockbot.com/upload/live/albums/500/9/18769.jpg",
      "user": "Rockbot",
      "user_image_small": "https://s.rockbot.com/upload/live/users/150/5/2621225.jpg",
      "user_image_large": "https://s.rockbot.com/upload/live/users/300/5/2621225.jpg",
      "likes": 0,
      "dislikes": 0
    }
  ],
  "recent": [
    {
      "pick_id": "22130649142",
      "artist_id": 40877,
      "artist": "DIIV",
      "song_id": 204131,
      "song": "Under The Sun",
      "artwork_small": "https://s.rockbot.com/upload/live/albums/150/4/804374.jpg",
      "artwork_large": "https://s.rockbot.com/upload/live/albums/500/4/804374.jpg",
      "user": "Rockbot",
      "user_image_small": "https://s.rockbot.com/upload/live/users/150/5/2621225.jpg",
      "user_image_large": "https://s.rockbot.com/upload/live/users/300/5/2621225.jpg",
      "likes": 0,
      "dislikes": 0
    }
  ]
}

music/skip

Skip currently playing track for the specified zone_id

Parameters

Name	Type	Description
zone_id	integer	Numeric ID of zone to access

POST Request

curl -X POST "https://api.rockbot.com/v5/ext/music/skip" \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "zone_id": 7 }'

200 Response

{
  "true"
}

music/start

Start music player for the specified zone_id

Parameters

Name	Type	Description
zone_id	integer	Numeric ID of zone to access

POST Request

curl -X POST "https://api.rockbot.com/v5/ext/music/start" \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "zone_id": 7 }'

200 Response

{
  "true"
}

music/stop

Stop music player for the specified zone_id

Parameters

Name	Type	Description
zone_id	integer	Numeric ID of zone to access

POST Request

curl -X POST "https://api.rockbot.com/v5/ext/music/stop" \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "zone_id": 7 }'

200 Response

{
  "true"
}

music/volume

Set volume music player for the specified zone_id

Parameters

Name	Type	Description
zone_id	integer	Numeric ID of zone to access
volume	integer	0-100 volume value

POST Request

curl -X POST "https://api.rockbot.com/v5/ext/music/volume" \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "zone_id": 7, "volume": 50 }'

200 Response

{
  "true"
}