Documentation

WebSocket API - Search Results

The users most recent search results

Data recieved in the search-results channel will have a payload in the format
Channel Payload

"payload": {
  "searchText": String, // The text the user searched for to get these results
  "albums": [
    {
      "id": String, // Unique ID for this album
      "name": String, // The name of the album
      "artist": String, // The name of the artist for the album
      "albumArt": String // URL to the albumArt for this album
    }
  ],  
  "artists": [
    {
      "id": String, // Unique ID for this artist
      "name": String, // The name of the artist
      "image": String // URL to an image of this artist
    }
  ],  
  "tracks": [
    {
      "id": String, // Unique ID for this song
      "index": Number, // The index position (starting at 1) of the track in the playlist
      "title": String, 
      "artist": String, 
      "album": String, 
      "albumArt": String, // URL to the albumArt for this song
      "duration": Number, // Duration of song in milliseconds
      "playCount": Number // Number of times the user has played this song
    }
  ]  
}

This data is sent every time the user performs a new search.

The payload will contain 0 to many songs, 0 to many albums and 0 to many artists.