/iqiyi/albums/search

POST /api/iqiyi/albums/search

Price: 20 credits

Search the iQIYI catalogue by keyword. Each result is a title with its synopsis, channel, cast, genre and region tags, VIP and exclusivity flags, publication dates and artwork.

How to use it

The keyword matches the title in the requested `lang` and the cast, so both a title and an actor's name work, and a title in one language finds the versions dubbed into others. It takes no genre, region or year filter — to narrow by those use /iqiyi/albums/browse, which is a separate catalogue surface and takes no keyword. A keyword it matches badly usually comes back with loosely related titles rather than an empty list, so check the names you get back before treating them as hits, but a keyword with no textual match at all, such as one made only of emoji, does return zero rows. It also runs out of matches well before a large `count` is filled, and deep pages repeat titles seen earlier. Results carry `cast` but never `vote_count`, and only a handful carry `score`; fetch /iqiyi/albums by `id` for the rating.

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")
• keyword string required — Words to search the catalogue for (examples: "KNOT", "love", "Boat Yongyut Termtuo"; minLength: 1)
• count integer required — Max number of results to return (examples: 20; min: 1)

Response

• @type string (default: "IqiyiAlbum")
• id string required
• alias string nullable
• name string nullable
• short_name string nullable
• alternative_titles array (default: [])
• description string nullable
• tagline string nullable
• url string nullable
• play_url string nullable
• channel string nullable
• channel_id string nullable
• is_series boolean (default: false)
• is_short boolean (default: false)
• is_exclusive boolean (default: false)
• is_iqiyi_produced boolean (default: false)
• is_dolby boolean (default: false)
• is_1080p boolean (default: false)
• is_3d boolean (default: false)
• is_vip boolean (default: false)
• is_tvod boolean (default: false)
• is_coupon boolean (default: false)
• is_package boolean (default: false)
• pay_mark string nullable
• season integer nullable
• episode_count integer nullable
• available_episode_count integer nullable
• latest_episode_order integer nullable
• first_episode_order integer nullable
• trailer_count integer nullable
• content_rating string nullable
• content_warning string nullable
• score number nullable
• vote_count integer nullable
• score_distribution array (default: [])
• publish_date string nullable
• last_publish_date string nullable
• published_at integer nullable
• issued_at integer nullable
• default_video_id string nullable
• image string nullable
• cover string nullable
• cast array (default: [])
  • @type string (default: "IqiyiCastMember")
  • id string required
  • name string nullable
  • credit string nullable
  • role string nullable
  • character string nullable
  • image string nullable
  • profile_url string nullable
• tags array (default: [])
  • @type string (default: "IqiyiTag")
  • id string required
  • name string nullable
  • group string nullable
• chart_ranks array (default: [])
  • @type string (default: "IqiyiChartRank")
  • chart string required
  • rank integer nullable
• audio_languages array (default: [])
• hdr_formats array (default: [])
• collection_ids array (default: [])
• allowed_regions array (default: [])

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.