/qqmusic/mvs/search

POST /api/qqmusic/mvs/search

Price: 20 credits

Browse the QQ Music music-video directory by region and kind, ordered by release date or popularity

How to use it

This browses a directory by attribute; it takes no keyword, so it will not find a named video or artist. The directory itself stops at a fixed depth, so a broad filter set reaches that depth rather than the whole catalogue, while a narrow one can be exhausted completely. `play_count` is zero on a large share of the newest listing because those videos have only just been published, so read a zero as new rather than as unpopular; `sort=hot` is where the videos that have accumulated plays are.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of music videos to return (min: 1; max: 1000)
• area string nullable — Keep only videos the catalogue files under this region (one of: "mainland_china", "hong_kong_taiwan", "western", "korea", "japan")
• kind string nullable — Keep only one kind of video, such as a studio music video, a live take or a cover (one of: "music_video", "live", "cover", "dance", "film_and_tv", "variety_show", "childrens")
• sort string — `newest` orders by release date, `hot` by the catalogue's popularity (default: "newest"; one of: "hot", "newest")

Response

• @type string (default: "QqmusicSearchMv")
• vid string required
• id string nullable
• name string nullable
• url string nullable
• image string nullable
• duration_seconds integer nullable
• play_count integer nullable
• comment_count integer nullable
• favorite_count integer nullable
• published_at integer nullable
• singers array (default: [])
  • @type string (default: "QqmusicSongSinger")
  • mid string required
  • id string nullable
  • name string nullable
  • url string nullable
  • image 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.