/musicbrainz/releases/search

POST /api/musicbrainz/releases/search

Price: 1 credit

Search MusicBrainz releases (editions)

How to use it

Search MusicBrainz for releases (specific editions). Provide a free-text 'query' and/or named filters (release title, artist, artist MBID, label, catalog number, barcode, country, date, format, status, packaging, track count, primary/secondary type, tag, ASIN, disambiguation comment). Returns scored matches with title, status, packaging, date, country, barcode, artist credits, parent release group, label info, formats and track count.

Parameters

access-token string required

Request body

timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
query string nullable — Free-text Lucene query (examples: "nevermind")
release string nullable — Filter by release title (examples: "Nevermind")
artist string nullable — Filter by artist name (examples: "Nirvana")
arid string nullable — Filter by artist MBID
label string nullable — Filter by label name (examples: "DGC")
catno string nullable — Filter by label catalog number
barcode string nullable — Filter by barcode
country string nullable — Filter by release country (ISO code) (examples: "US")
date string nullable — Filter by release date (YYYY or YYYY-MM-DD)
format string nullable — Filter by medium format (examples: "Vinyl")
status string nullable — Filter by release status (one of: "official", "promotion", "bootleg", "pseudo-release", "withdrawn", "cancelled")
packaging string nullable — Filter by packaging (examples: "Jewel Case")
tracks string nullable — Filter by total track count
primary_type string nullable — Filter by release-group primary type (one of: "album", "single", "ep", "broadcast", "other")
secondary_type string nullable — Filter by release-group secondary type (one of: "compilation", "soundtrack", "spokenword", "interview", "audiobook", "audio drama", "live", "remix", "dj-mix", "mixtape/street", "demo", "field recording")
tag string nullable — Filter by folksonomy tag
asin string nullable — Filter by Amazon ASIN
comment string nullable — Filter by disambiguation comment
count integer required — Max number of results to return (min: 1)

Response

@type string (default: "MusicBrainzReleaseSearchResult")
id string required
url string required
score integer nullable
disambiguation string nullable
status string nullable
packaging string nullable
date string nullable
country string nullable
barcode string nullable
text_representation object nullable
- @type string (default: "MusicBrainzTextRepresentation")
- language string nullable
- script string nullable
artist_credit array (default: [])
- @type string (default: "MusicBrainzArtistCredit")
- name string nullable
- join_phrase string nullable
- artist object nullable
  - @type string (default: "MusicBrainzArtistRef")
  - id string nullable
  - name string nullable
  - sort_name string nullable
  - disambiguation string nullable
  - type string nullable
release_group object nullable
- @type string (default: "MusicBrainzReleaseGroupStub")
- id string nullable
- url string nullable
- primary_type string nullable
- secondary_types array (default: [])
- first_release_date string nullable
- disambiguation string nullable
release_events array (default: [])
- @type string (default: "MusicBrainzReleaseEvent")
- date string nullable
- area object nullable
  - @type string (default: "MusicBrainzAreaRef")
  - id string nullable
  - name string nullable
  - sort_name string nullable
  - type string nullable
  - disambiguation string nullable
  - iso_3166_1_codes array (default: [])
  - iso_3166_2_codes array (default: [])
label_info array (default: [])
- @type string (default: "MusicBrainzLabelInfo")
- catalog_number string nullable
- label object nullable
  - @type string (default: "MusicBrainzLabelRef")
  - id string nullable
  - name string nullable
  - sort_name string nullable
  - type string nullable
  - label_code integer nullable
  - disambiguation string nullable
formats array (default: [])
track_count integer nullable

Errors

422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

X-Error — Error message text (present only on error)
X-Request-ID — Unique request identifier
X-Execution-Time — Execution time in seconds
X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
X-Retry-After — Seconds to wait before retrying. Present only on 429.