NAV Navbar
Logo
cURL

Remote API Overview

Welcome to the Rockbot Remote API. This API lets you skip songs, change the playlist and more on your Rockbot Player, directly from your application. Below are the available methods you can use to control your Rockbot Player.

All methods require a private API key for your venue that can be found under the Power-Ups section of your venue dashboard. This key must be sent as an Authorization header to the HTTP endpoint specified in the docs below, along with any specified POST parameters. Do not share your private API key or host in plain text.

If you don’t already manage a Rockbot venue, you can create one at https://rockbot.com/trial. Please contact support@rockbot.com if you have any questions.

Player Methods

Now Playing

curl -H "Authorization: API_KEY"
 "https://api.rockbot.com/v3/remote/now_playing"

Successful JSON Response:

{
    "song_id": 5897,
    "song": "Island In The Sun",
    "artist_id": 6,
    "artist": "Weezer",
    "album_id": 6,
    "album": "Weezer",
    "artwork_small": "http://cdn.rockbot.com/upload/live/albums/100/4/23944.jpg",
    "artwork_large": "http://cdn.rockbot.com/upload/live/albums/500/4/23944.jpg",
    "duration": 200,
    "remaining": 179,
    "votes_up": 0,
    "votes_down": 0,
    "volume": 5,
    "platform": "web"
}

Returns the current track playing on your player along with related metadata. If the player is offline, an empty JSON object will be returned.

HTTP Endpoint

https://api.rockbot.com/v3/remote/now_playing

Skip Track

curl -H "Authorization: API_KEY"
 "https://api.rockbot.com/v3/remote/skip"

Successful JSON Response:

{
    "response": "success"
}

Sends a remote skip request to your Rockbot Player.

HTTP Endpoint

https://api.rockbot.com/v3/remote/skip

Set Volume

curl -H "Authorization: API_KEY" -d "volume=5
 "https://api.rockbot.com/v3/remote/set_volume""

Successful JSON Response:

{
    "response": "success"
}

Updates the volume on your Rockbot Player.

HTTP Endpoint

https://api.rockbot.com/v3/remote/set_volume

POST Parameters

Parameter Description
volume 1-10 desired volume

Start Player

curl -H "Authorization: API_KEY"
 "https://api.rockbot.com/v3/remote/start"

Successful JSON Response:

{
    "response": "success"
}

Sends a remote start request to your Rockbot Player.

HTTP Endpoint

https://api.rockbot.com/v3/remote/start

Stop Player

curl -H "Authorization: API_KEY"
 "https://api.rockbot.com/v3/remote/stop"

Successful JSON Response:

{
    "response": "success"
}

Sends a remote stop request to your Rockbot Player.

HTTP Endpoint

https://api.rockbot.com/v3/remote/stop

Reboot Player

curl -H "Authorization: API_KEY"
 "https://api.rockbot.com/v3/remote/reboot"

Successful JSON Response:

{
    "response": "success"
}

Sends a remote reboot request to your Rockbot Player.

HTTP Endpoint

https://api.rockbot.com/v3/remote/reboot

Music Methods

Browse Playlists

curl -H "Authorization: API_KEY"
 "https://api.rockbot.com/v3/remote/browse_playlists"

Successful JSON Response:

[
     {
        "playlist_id": 21,
        "title": "Highest Rated All Time",
        "description": "Highest all-time rated tracks on Rockbot",
        "artwork_large": "http://cdn.rockbot.com/upload/live/playlists/300/3/1236513.jpg"
    },
    {
        "playlist_id": 20,
        "title": "Highest Rated This Week",
        "description": "Highest rated tracks on Rockbot in the past week",
        "artwork_large": "http://cdn.rockbot.com/upload/live/playlists/300/6/1236516.jpg"
    },
    {
        "playlist_id": 31,
        "title": "Most Played 80s",
        "description": "A mix of popular 80s tracks picked on Rockbot",
        "artwork_large": "http://cdn.rockbot.com/upload/live/playlists/300/9/1236519.jpg"
    },
    ...
]

Returns an array of Rockbot Radio curated playlists. The playlist_id can be passed into remote/add_playlist_override for immediate playback at your venue.

HTTP Endpoint

https://api.rockbot.com/v3/remote/browse_playlists

Current Playlist Overrides

curl -H "Authorization: API_KEY"
 "https://api.rockbot.com/v3/remote/current_playlist_overrides"

Successful JSON Response:

[
    {
        "playlist_id": 32,
        "title": "Most Played Indie",
        "description": "A mix of popular indie tracks picked on Rockbot",
        "artwork_large": "http://cdn.rockbot.com/upload/live/playlists/300/4/1236534.jpg"
    }
]

Returns an array of playlists that are currently set as an active override. If no overrides are set an empty JSON object will be returned and your venue will play it’s normally scheduled station.

HTTP Endpoint

https://api.rockbot.com/v3/remote/current_playlist_overrides

Add Playlist Override

curl -H "Authorization: API_KEY" -d "playlist_id=21&duration=30"
 "https://api.rockbot.com/v3/remote/add_playlist_override"

Successful JSON Response:

{
    "response": "success"
}

Adds a new playlist to immediately play for duration minutes. Use remote/browse_playlists to find a playlist to override.

HTTP Endpoint

https://api.rockbot.com/v3/remote/add_playlist_override

POST Parameters

Parameter Description
playlist_id Playlist ID to add as override
duration Length of override in minutes

Remove Playlist Override

curl -H "Authorization: API_KEY" -d "playlist_id=21"
 "https://api.rockbot.com/v3/remote/remove_playlist_override"

Successful JSON Response:

{
    "response": "success"
}

Removes a currently scheduled playlist override.

HTTP Endpoint

https://api.rockbot.com/v3/remote/remove_playlist_override

POST Parameters

Parameter Description
playlist_id Playlist ID to remove as override

Ban Song

curl -H "Authorization: API_KEY" -d "song_id=21"
 "https://api.rockbot.com/v3/remote/ban_song"

Successful JSON Response:

{
    "response": "success"
}

Bans a song from playing at this venue.

HTTP Endpoint

https://api.rockbot.com/v3/remote/ban_song

POST Parameters

Parameter Description
song_id Song ID to ban from venue
cURL