MusicBee API for developers

MusicBee API

MusicBee API enables plugin developers to access information held in MusicBee and to control MusicBee.
Initially the API is focussed on enabling your plugin to be notified of player events, retrieve tag data, and to control the player. Over time APIs will expand to stream music data, control GUI aspects so you can create new views or possibly entirely skin MusicBee.


For MusicBee v3.0

All dlls need to be named MB_*.dll and placed in the Plugins folder where MB is installed. If using C# or VB.NET, you need to target .NET 4.0 client profile and for all interfaces note that MusicBee runs in 32-bit mode on 64-bit machines

C# SourceVB.NET Source


The API interface is backwards compatible, so you are not required to update your plugin every time the API is updated

Website API

Website API provide a great way to get MusicBee release, download, addons detail and updates as well as addons search. The API is experimental and might contain unknown response/data.

API Version: 1.0
Request Type: GET
Return Type: JSON
API Key: Currently no API key or registration is required. The API is fully open but it might change in future if too many request is slowing down the server.

MusicBee beta, stable and patch release info

The following URL will return MusicBee stable, beta, and patch release info with version, download links and others.


http://getmusicbee.com/api/1.0/?type=json&action=release-info

The URL will return json structured data

{
  "stable":{
    "appname":"MusicBee 3",
    "version":"3.0.5805",
    "release_date":"May 30, 2016",
    "supported_os":"Windows 7\/8.1\/10",
    "download":{
      "available":"1",
      "installer":{
        "link1":"http:\/\/getmusicbee.com\/installer.exe",
        ...
      "portable":{
        "link1":"http:\/\/portable.getmusicbee.com\/installer.exe"}
    }
  },
  "beta":{
    ...
  },
  "patch":{
    ...
  }
}

ADD-ON Data

Get add-on data such as description, download link, like & download count and others.

http://getmusicbee.com/api/1.0/?type=json&action=addon-info&id=1

Parameter id is the id of the add-on.


ADD-ON list by User ID

List add-ons submitted by a user

http://getmusicbee.com/api/1.0/?type=json&action=addon-list&authorid=1&limit=10

Parameter authorid is the id of the user/author.
You need to define the limit of the result, if not defined the default will be 5, maximum limit is 20


ADD-ON Search by Term

You can also search add-ons by providing a search query, category (optional), limit (optional), page (optional)

http://getmusicbee.com/api/1.0/?type=json&action=addon-search&search=windows&page=1&limit=10

Parameter search is the search query
page is the current page no
limit is the result limit

If you wan't full info about pagination like current page no, total page no etc, it is possible. The JSON response will contain the following:

{
  "current_page":"1",
  "addon_data":{
    "result":[
      ....
    ]
  },
  "total_page":1,
  "page_url":"http:\/\/getmusicbee.com\/addons\/s\/?q=windows&type=",
  "prev_page_url":null,
  "next_page_url":null
}

You will get current page no, total page no, and the original URL of the page with only the search term as well as the link for the next and previous page.