Search Entities by Name

Get Boomplay catalog information about albums, artists, playlists, tracks that match a keyword string.

Request

GET /search/v1

Parameter

HEADER PARAMETER VALUE
Content-Type Required Set to application/json
Accept-Language Such as zh-CN,en-US... default en
app_id Required The app ID provided to you by Boomplay when you register your application.
Authorization Required Access Token
REQUEST PARAMETER VALUE
q Required string
Your search query.
Example value:"name"
type Required string
Allowed values: "album","artist","playlist","track"
Example value:"album"
market string
An ISO 3166-1 alpha-2 country code. If a country code is specified, only content that is available in that market will be returned.
Example value:"NG"

Responses Body

Search response

Body

code (integer) required
desc (string)
data (object)

tracks (array of objects)

track_id (integer) The Boomplay ID for the track.
track_title (string) The Boomplay title for the track.
track_number (integer) Ranking of track in the album.
isrc (string) isrc
duration (string) Track duration
album_id (integer) The Boomplay ID for the album.
album_title (string) The Boomplay title for the album.
genres (string) The album genres.
available_markets (string) Release country .
web_url (string) web url.
mobile_url (string) mobile url.
artwork object

width (integer) image width
height (integer) image height
url (string) cover

artists (array of objects)

artist_id (integer) The Boomplay ID for the artist.
artist_name (string) The Boomplay name for the artis

albums (array of objects)
album_id (integer) The Boomplay ID for the album.
album_title (string) The Boomplay title for the album.
album_type (string) The Boomplay type for the album.
upc (string) The Boomplay upc for the album.
release_date (string) The album Release date.
label (string) Record label.
genres (string) The album genres.
available_markets (string) Release country .
web_url (string) web url.
mobile_url (string) mobile url.
artwork object

width (integer) image width
height (integer) image height
url (string) cover

artists (array of objects)

artist_id (integer) The Boomplay ID for the artist.
artist_name (string) The Boomplay name for the artis

artists (array of objects)
artist_id (integer) The Boomplay ID for the artist.
artist_name (string) The Boomplay name for the artis.
web_url (string) web url.
artwork object

width (integer) image width
height (integer) image height
url (string) cover

playlists (array of objects)
playlist_id (integer) The Boomplay ID for the playlist.
playlist_title (string) The Boomplay title for the playlist.
web_url (string) web url.
mobile_url (string) mobile url.
artwork object

width (integer) image width
height (integer) image height
url (string) cover

artists (array of objects)

artist_id (integer) The Boomplay ID for the artist.
artist_name (string) The Boomplay name for the artis

Request Sample

GET /search/v1?type=playlist&q=a&market= HTTP/1.1 HTTP/1.1
Authorization: ${authorization}
app_id: ${app_id}
Host: openapi.boomplay.com

Response Example

{
  "errorMsg": null,
  "code": 0,
  "data": {
    "tracks": null,
    "albums": null,
    "artists": null,
    "playlists": [
      {
        "playlist_id": 48649,
        "playlist_title": "Love Like A Song",
        "web_url": "https://test.boomplay.com/playlists/48649?srModel=openapi_hb1",
        "mobile_url": "https://test.boomplay.com/share/playlist/48649?srModel=openapi_hb1"
      },
      {
        "playlist_id": 779504,
        "playlist_title": "ManCrush: Jay A",
        "web_url": "https://test.boomplay.com/playlists/779504?srModel=openapi_hb1",
        "mobile_url": "https://test.boomplay.com/share/playlist/779504?srModel=openapi_hb1"
      },
      {
        "playlist_id": 878685,
        "playlist_title": "A Very Afro-Christmas",
        "web_url": "https://test.boomplay.com/playlists/878685?srModel=openapi_hb1",
        "mobile_url": "https://test.boomplay.com/share/playlist/878685?srModel=openapi_hb1"
      },
      {
        "playlist_id": 1551382,
        "playlist_title": "A Woman's Love",
        "web_url": "https://test.boomplay.com/playlists/1551382?srModel=openapi_hb1",
        "mobile_url": "https://test.boomplay.com/share/playlist/1551382?srModel=openapi_hb1"
      },
      {
        "playlist_id": 1780129,
        "playlist_title": "Love Like A Song",
        "web_url": "https://test.boomplay.com/playlists/1780129?srModel=openapi_hb1",
        "mobile_url": "https://test.boomplay.com/share/playlist/1780129?srModel=openapi_hb1"
      },
      {
        "playlist_id": 2117048,
        "playlist_title": "a",
        "web_url": "https://test.boomplay.com/playlists/2117048?srModel=openapi_hb1",
        "mobile_url": "https://test.boomplay.com/share/playlist/2117048?srModel=openapi_hb1"
      },
      {
        "playlist_id": 15141374,
        "playlist_title": "Focus: Alex A",
        "web_url": "https://test.boomplay.com/playlists/15141374?srModel=openapi_hb1",
        "mobile_url": "https://test.boomplay.com/share/playlist/15141374?srModel=openapi_hb1"
      },
      {
        "playlist_id": 18952763,
        "playlist_title": "It's a party",
        "web_url": "https://test.boomplay.com/playlists/18952763?srModel=openapi_hb1",
        "mobile_url": "https://test.boomplay.com/share/playlist/18952763?srModel=openapi_hb1"
      },
      {
        "playlist_id": 19872900,
        "playlist_title": "It's a Wrap",
        "web_url": "https://test.boomplay.com/playlists/19872900?srModel=openapi_hb1",
        "mobile_url": "https://test.boomplay.com/share/playlist/19872900?srModel=openapi_hb1"
      },
      {
        "playlist_id": 29859007,
        "playlist_title": "I Got A Feeling",
        "web_url": "https://test.boomplay.com/playlists/29859007?srModel=openapi_hb1",
        "mobile_url": "https://test.boomplay.com/share/playlist/29859007?srModel=openapi_hb1"
      }
    ]
  }
}

results matching ""

    No results matching ""