/qqmusic/playlists

POST /api/qqmusic/playlists

Price: 20 credits

Get a QQ Music playlist with its tracks, tags, creator and play and favourite counts

How to use it

Playlist ids are numeric and are the long digit run in a playlist page URL, which this endpoint will pull out for you. `track_count` is the playlist's real length, so compare it against how many tracks came back before concluding the playlist is short.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• playlist string required — Numeric QQ Music playlist id, or a playlist page URL (examples: "7222868712", "https://y.qq.com/n/ryqq/playlist/7222868712"; minLength: 1)
• song_count integer — Max number of tracks to return (default: 100; min: 1)

Response

• @type string (default: "QqmusicPlaylist")
• id string required
• name string required
• description string nullable
• url string nullable
• image string nullable
• creator object nullable
  • @type string (default: "QqmusicPlaylistCreator")
  • uin string required
  • name string nullable
  • image string nullable
  • is_vip boolean nullable
• tags array (default: [])
  • @type string (default: "QqmusicPlaylistTag")
  • id string required
  • name string nullable
• listen_count integer nullable
• favorite_count integer nullable
• track_count integer nullable
• tracks array (default: [])
  • @type string (default: "QqmusicTrack")
  • mid string required
  • id string nullable
  • name string nullable
  • subtitle string nullable
  • url string nullable
  • image string nullable
  • singers array (default: [])
    • @type string (default: "QqmusicSongSinger")
    • mid string required
    • id string nullable
    • name string nullable
    • url string nullable
    • image string nullable
  • album object nullable
    • @type string (default: "QqmusicSongAlbum")
    • mid string required
    • id string nullable
    • name string nullable
    • published_date string nullable
    • url string nullable
    • image string nullable
  • duration_seconds integer nullable
  • published_date string nullable
  • disc_number integer nullable
  • track_number integer nullable
  • bpm integer nullable
  • is_exclusive boolean nullable
  • is_paid_play boolean nullable
  • is_paid_download boolean nullable
  • is_vip_only boolean nullable
• created_at integer nullable
• updated_at 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 catalogue does not serve a playlist for the given id. 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.