/iqiyi/albums/ranking

POST /api/iqiyi/albums/ranking

Price: 10 credits

Get the current iQIYI charts for a storefront. Each title carries every chart it appears in with its position there, plus its viewer score, age rating, release year, genre tags, VIP and exclusivity flags, update status, synopsis and artwork.

How to use it

Every chart of the storefront arrives in one call and a title appears once, with `chart_ranks` naming each chart it made and its position there. The order is chart by chart, so a small `count` returns the first chart only rather than a slice of each. Chart names come back in `lang`. Entries carry a viewer `score`, which /iqiyi/albums/search does not; for cast and episode counts fetch /iqiyi/albums by `id`. Charts are published for every market except `kr`, which returns 412.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• lang string — Language of the titles, synopses and tag names in the response (default: "en_us"; one of: "en_us", "zh_cn", "zh_tw", "ar_ae", "vi_vn", "th_th", "pt_br", "ms_my", "id_id", "es_mx")
• market string — Storefront whose catalogue and licensing the request is answered for (default: "us"; one of: "ae", "ar", "au", "bh", "bn", "br", "ca", "cl", "co", "de", "eg", "es", "fr", "gb", "hk", "id", "in", "jp", "kh", "kr", "kw", "kz", "la", "mm", "mo", "mx", "my", "nz", "om", "pe", "ph", "pt", "qa", "sa", "sg", "th", "ua", "us", "vn")
• count integer required — Max number of ranked titles to return (examples: 50; min: 1)

Response

• @type string (default: "IqiyiRankedAlbum")
• id string required
• chart_ranks array (default: [])
  • @type string (default: "IqiyiChartRank")
  • chart string required
  • rank integer nullable
• alias string nullable
• name string nullable
• description string nullable
• url string nullable
• play_url string nullable
• default_video_id string nullable
• channel string nullable
• channel_id string nullable
• score number nullable
• content_rating string nullable
• year integer nullable
• duration integer nullable
• update_status string nullable
• is_vip boolean (default: false)
• is_tvod boolean (default: false)
• is_exclusive boolean (default: false)
• is_iqiyi_produced boolean (default: false)
• is_live boolean (default: false)
• tags array (default: [])
• 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 — This storefront publishes no charts 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.