/iqiyi/videos/comments

POST /api/iqiyi/videos/comments

Price: 10 credits

Get the viewer comments on an iQIYI video, newest first, with each comment's replies following it. Every comment carries its text, the language it was written in, the author with their avatar, the user it replies to, the reply count and the time it was posted.

How to use it

Comments belong to an individual video, not to the series — pass an episode id, and use /iqiyi/albums/videos to turn an album into episode ids. `lang` picks which language's comment board you read: en_us, zh_cn and th_th return three disjoint sets on the same video, so one call never gives you every comment on a video and seeing them all means calling once per language. Threads are flattened: a reply follows the comment it answers and carries `reply_to_user`, while `reply_count` on that comment says how many replies exist — the first ten of them are returned. `like_count` is filled for only a few comments and its absence does not mean zero.

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")
• video string required — Video numeric id, short id or iq.com play URL (examples: "1170059162663100", "c3hbjhxtcg", "https://www.iq.com/play/knot-episode-1-c3hbjhxtcg"; minLength: 1)
• count integer required — Max number of comments to return (examples: 30; min: 1)

Response

• @type string (default: "IqiyiComment")
• id string required
• text string nullable
• language string nullable
• user object nullable
  • @type string (default: "IqiyiCommentUser")
  • id string required
  • name string nullable
  • image string nullable
• reply_to_user object nullable
  • @type string (default: "IqiyiCommentUser")
  • id string required
  • name string nullable
  • image string nullable
• reply_count integer nullable
• like_count integer nullable
• created_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 — No video with this 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.