Difference between revisions of "MusicBrainz API/FAQ"

From MusicBrainz Wiki
m (Reosarevok moved page Development/WS FAQ to MusicBrainz API/FAQ)
m
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
;What can I do with the MusicBrainz API?
 
;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.
+
:You can look up information about a particular [[MusicBrainz Entity|MusicBrainz entity]] ("give me info about The Beatles"), browse the data to find entities connected to a particular entity ("show me all releases by The Beatles"), or search for entities matching a specific query ("show me all artists matching the query 'Beatles' so I can find the one I want and ask for more data").
 
;Who can use the MusicBrainz API? Is it free?
 
;Who can use the MusicBrainz API? 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.
Line 7: Line 7:
 
;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.
 +
;Which formats can I get the data in?
 +
:The API was originally written to return XML, but nowadays it can also return JSON.
 +
;Is there any significant difference between the XML and JSON APIs?
 +
:For requesting data, the XML and JSON API are effectively equivalent. The XML API is the only one that allows [[MusicBrainz_API#Submitting_data|submitting data]] to MusicBrainz (but keep in mind only ratings, tags, barcodes and ISRCs can be submitted via the API at all; for most data additions you should use the website instead).
 
;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 [[MusicBrainz API/Rate_Limiting|our rate limiting rules]].
 
:'''Yes'''. See [[MusicBrainz API/Rate_Limiting|our rate limiting rules]].
 +
;This seems very complicated, can I see some examples?
 +
:Yes, we have [[MusicBrainz API/Examples|an example page]] showcasing some queries and showing the returned format you can expect for each.
 
;Are there language bindings for the API?
 
;Are there language bindings for the API?
 
:Yes, in many different languages. See [[MusicBrainz API#Libraries|our list of external libraries]].
 
:Yes, in many different languages. See [[MusicBrainz API#Libraries|our list of external libraries]].

Latest revision as of 16:04, 11 July 2020

What can I do with the MusicBrainz API?
You can look up information about a particular MusicBrainz entity ("give me info about The Beatles"), browse the data to find entities connected to a particular entity ("show me all releases by The Beatles"), or search for entities matching a specific query ("show me all artists matching the query 'Beatles' so I can find the one I want and ask for more data").
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.
Which formats can I get the data in?
The API was originally written to return XML, but nowadays it can also return JSON.
Is there any significant difference between the XML and JSON APIs?
For requesting data, the XML and JSON API are effectively equivalent. The XML API is the only one that allows submitting data to MusicBrainz (but keep in mind only ratings, tags, barcodes and ISRCs can be submitted via the API at all; for most data additions you should use the website instead).
Is there a limit to the number of requests I can make per second?
Yes. See our rate limiting rules.
This seems very complicated, can I see some examples?
Yes, we have an example page showcasing some queries and showing the returned format you can expect for each.
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.