/pixiv/artworks/ranking

POST /api/pixiv/artworks/ranking

Price: 5 credits

Get a pixiv artwork ranking by period and content type, optionally for a past day: rank, previous rank, artwork id, title, type, thumbnail, tags, author, ratings, views, content flags and series

How to use it

Not every mode has every content type; an unpublished combination answers 412.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• mode string — Ranking period or audience (default: "daily"; one of: "daily", "weekly", "monthly", "rookie", "original", "daily_ai", "male", "female")
• content string — Kind of artwork ranked (default: "all"; one of: "all", "illust", "manga", "ugoira")
• date integer nullable — Ranking day, unix seconds (day-granular, UTC); the latest ranking when omitted (examples: 1790726400)
• count integer required — Max number of results (min: 1; max: 500)

Response

• @type string (default: "PixivRankingItem")
• id string required
• url string required
• rank integer required
• previous_rank integer nullable
• artwork_type string nullable
• thumbnail string nullable
• tags array (default: [])
• author object nullable
  • @type string (default: "PixivUserRef")
  • id string required
  • name string nullable
  • alias string nullable
  • image string nullable
  • url string required
• page_count integer nullable
• width integer nullable
• height integer nullable
• rating_count integer nullable
• view_count integer nullable
• sexual_level integer nullable
• content_flags array (default: [])
• is_original boolean nullable
• is_masked boolean nullable
• mask_reason string nullable
• series object nullable
  • @type string (default: "PixivSeriesRef")
  • id string required
  • order integer nullable
  • url string 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 ranking for that mode, content and date 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.