/pixiv/artworks/comments

POST /api/pixiv/artworks/comments

Price: 5 credits

List the comments on a pixiv artwork, newest first, with their replies: comment id, text or stamp id, author and posting time

How to use it

count limits top-level comments; replies come nested under each one. An artwork with comments turned off returns an empty list.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• artwork string required — pixiv artwork id or artwork URL (examples: "150271313", "https://www.pixiv.net/artworks/150271313"; minLength: 1)
• include_replies boolean — Attach the replies of every comment (default: true)
• count integer required — Max number of top-level comments (min: 1)

Response

• @type string (default: "PixivComment")
• id string required
• artwork_id string required
• text string nullable
• stamp_id string nullable
• author object nullable
  • @type string (default: "PixivUserRef")
  • id string required
  • name string nullable
  • alias string nullable
  • image string nullable
  • url string required
• is_deleted_user boolean nullable
• has_replies boolean nullable
• replies array (default: [])
  • @type string (default: "PixivCommentReply")
  • id string required
  • text string nullable
  • stamp_id string nullable
  • author object nullable
    • @type string (default: "PixivUserRef")
    • id string required
    • name string nullable
    • alias string nullable
    • image string nullable
    • url string required
  • root_id string nullable
  • parent_id string nullable
  • reply_to_user_id string nullable
  • reply_to_user_name string nullable
  • created_at 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 public pixiv artwork under that 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.