/netease/albums/search

POST /api/netease/albums/search

Price: 5 credits

Search NetEase Cloud Music albums by title or artist

How to use it

Results carry the album's metadata but not its tracks — take the id to the album endpoint for the track list. How deep a query goes is set by the query itself and NetEase does not report it honestly, so ask for the count you want and read what actually comes back rather than assuming the walk reached the end.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Words to search for — an album title, an artist name, or both (examples: "周杰伦 叶惠美", "keyshia cole"; minLength: 1)
• count integer required — Max number of albums to return (min: 1)

Response

• @type string (default: "NeteaseAlbum")
• id string required
• name string nullable
• aliases array (default: [])
• translated_names array (default: [])
• url string nullable
• image string nullable
• artists array (default: [])
  • @type string (default: "NeteaseArtist")
  • id string required
  • name string nullable
  • aliases array (default: [])
  • translated_names array (default: [])
  • url string nullable
  • image string nullable
  • square_image string nullable
  • description string nullable
  • album_count integer nullable
  • track_count integer nullable
  • mv_count integer nullable
  • user_id string nullable
• description string nullable
• company string nullable
• album_type string nullable
• album_subtype string nullable
• tags array (default: [])
• track_count integer nullable
• published_at integer nullable
• copyright_id string nullable
• comment_thread_id string nullable
• status_code string nullable
• is_paid boolean nullable
• is_on_sale boolean 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.