Difference between revisions of "MusicBrainz API/FAQ"

From MusicBrainz Wiki
m (Reverted edits by CallerNo6 (talk) to last revision by Alastairp)
(Tag: Rollback)
(One intermediate revision by the same user not shown)
Line 1: Line 1:
;Version 2? What happened to Version 1?
+
;What can I do with the MusicBrainz API?
:Version 1 of the Webservice served the original version of the MusicBrainz website, and is no longer in service
+
:There are three types of GET requests you can use to request MusicBrainz data, as well as limited data submission.
;What can I do with WS/2?
+
;Who can use the MusicBrainz API? Is it free?
:There are three types of GET requests, as well as limited data submission, explained below.
 
;Who can use WS/2? Is it free?
 
 
:[[Live_Data_Feed|Non-commercial]] use of this web service is free; please see [https://metabrainz.org/supporters/account-type our commercial plans] or [[Contact_Us|contact us]] if you would like to use this service commercially.
 
:[[Live_Data_Feed|Non-commercial]] use of this web service is free; please see [https://metabrainz.org/supporters/account-type our commercial plans] or [[Contact_Us|contact us]] if you would like to use this service commercially.
 
;Do I need an API key?
 
;Do I need an API key?
:Currently, no. But you must have a meaningful [[XML_Web_Service/Rate_Limiting#Provide_meaningful_User-Agent_strings|user-agent string]].
+
:Currently, no. But you must have a meaningful [[MusicBrainz API/Rate_Limiting#Provide_meaningful_User-Agent_strings|user-agent string]].
 
;Do I need to provide authentication?
 
;Do I need to provide authentication?
 
:Data submission, as well as requests that involve user information, require [[wikipedia:Digest_access_authentication|digest]] authentication.
 
:Data submission, as well as requests that involve user information, require [[wikipedia:Digest_access_authentication|digest]] authentication.
 
;Is there a limit to the number of requests I can make per second?
 
;Is there a limit to the number of requests I can make per second?
:'''Yes'''. See: [[XML_Web_Service/Rate_Limiting]]
+
:'''Yes'''. See [[MusicBrainz API/Rate_Limiting|our rate limiting rules]].
;What formats are available for the responses?
+
;Are there language bindings for the API?
:[[XML Web Service/Version 2|XML]] and [[Development/JSON_Web_Service|JSON]]
+
:Yes, in many different languages. See [[MusicBrainz API#Libraries|our list of external libraries]].
;Are there language bindings for WS/2?
 
:Yes. See: [[External_Resources#Access_MusicBrainz_using_external_APIs|external libraries]]
 
 
;What should I do if I encounter unexpected behaviour not covered in these docs?
 
;What should I do if I encounter unexpected behaviour not covered in these docs?
 
:You can ask question in [[IRC]] or in the [[discourse:|forums]].
 
:You can ask question in [[IRC]] or in the [[discourse:|forums]].
:Check to see if a ticket has been filed in the [http://tickets.musicbrainz.org/browse/MBS/component/10000#selectedTab=com.atlassian.jira.plugin.system.project%3Acomponent-summary-panel bug tracker], and if not consider writing one.
+
:Check to see if a ticket has been filed in the [https://tickets.metabrainz.org/issues/?jql=project%20%3D%20MBS%20AND%20component%20%3D%20%22Web%20service%22%20AND%20resolution%20%3D%20Unresolved%20ORDER%20BY%20priority%20DESC bug tracker], and if not consider writing one.
;What else should I know before I start using WS/2?
+
;What else should I know before I start using the API?
 
:It'd probably be helpful to know:
 
:It'd probably be helpful to know:
:*[[MusicBrainz_Database/Schema|how MusicBrainz is structured]]
+
:*[[MusicBrainz_Database/Schema|How MusicBrainz is structured]]
 
:*What [[mb:relationships/|relationships]] are available
 
:*What [[mb:relationships/|relationships]] are available
 +
;So you're on version 2 of the API then? What happened to version 1?
 +
:The version 1 of the API was designed with the data structure of the original (pre-2011) version of the MusicBrainz database in mind. It was deprecated in 2011 when we changed to our current data schema, and after running (without further updates) for several years to avoid breaking any tools using it, it was finally taken down in 2019.

Revision as of 19:55, 7 July 2020

What can I do with the MusicBrainz API?
There are three types of GET requests you can use to request MusicBrainz data, as well as limited data submission.
Who can use the MusicBrainz API? Is it free?
Non-commercial use of this web service is free; please see our commercial plans or contact us if you would like to use this service commercially.
Do I need an API key?
Currently, no. But you must have a meaningful user-agent string.
Do I need to provide authentication?
Data submission, as well as requests that involve user information, require digest authentication.
Is there a limit to the number of requests I can make per second?
Yes. See our rate limiting rules.
Are there language bindings for the API?
Yes, in many different languages. See our list of external libraries.
What should I do if I encounter unexpected behaviour not covered in these docs?
You can ask question in IRC or in the forums.
Check to see if a ticket has been filed in the bug tracker, and if not consider writing one.
What else should I know before I start using the API?
It'd probably be helpful to know:
So you're on version 2 of the API then? What happened to version 1?
The version 1 of the API was designed with the data structure of the original (pre-2011) version of the MusicBrainz database in mind. It was deprecated in 2011 when we changed to our current data schema, and after running (without further updates) for several years to avoid breaking any tools using it, it was finally taken down in 2019.