/discogs/search

POST /api/discogs/search

Price: 5 credits

Search the Discogs music database

How to use it

Search the Discogs music database for releases, masters, artists, and labels. Provide a keyword via 'q' and/or structured filters (artist, label, genre, style, country, year, format, catno, barcode, track, ...). Set 'type' to restrict results to one entity type. Returns matching entries with id, type, title, year, country, formats, labels, genres, styles, barcodes, catalog number, master id, and community want/have counts.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• q string nullable — Search keyword (examples: "nirvana")
• type string nullable — Restrict the search to a single entity type (one of: "release", "master", "artist", "label"; examples: "release")
• artist_title string nullable — Search by combined 'Artist - Title' title field
• release_title string nullable — Search by release title
• credit string nullable — Search by release credit
• artist string nullable — Search by artist name (examples: "Nirvana")
• anv string nullable — Search by artist name variation
• label string nullable — Search by label name (examples: "DGC")
• genre string nullable — Search by genre (examples: "Rock")
• style string nullable — Search by style (examples: "Grunge")
• country string nullable — Search by country (examples: "US")
• year string nullable — Search by year (examples: "1991")
• format string nullable — Search by format (examples: "Vinyl")
• catno string nullable — Search by catalog number
• barcode string nullable — Search by barcode
• track string nullable — Search by track title
• submitter string nullable — Search by submitter username
• contributor string nullable — Search by contributor username
• count integer required — Max result count (min: 1)

Response

• @type string (default: "DiscogsSearchResult")
• id integer required
• type string nullable
• year string nullable
• country string nullable
• format array (default: [])
• label array (default: [])
• genre array (default: [])
• style array (default: [])
• barcode array (default: [])
• catno string nullable
• master_id integer nullable
• community object nullable
  • @type string (default: "DiscogsSearchResultCommunity")
  • want_count integer (default: 0)
  • have_count integer (default: 0)
• image string nullable
• url string 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.