/pixiv/users

POST /api/pixiv/users

Price: 5 credits

Get one pixiv creator profile: name, avatar, banner, bio, links, public profile details, workspace, premium and official flags, following count, work counts per type and manga and novel series

How to use it

Pass the id to pixiv/users/artworks for the creator's works.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• user string required — pixiv user id or profile URL (examples: "14601125", "https://www.pixiv.net/users/14601125"; minLength: 1)

Response

• @type string (default: "PixivUser")
• id string required
• url string required
• name string nullable
• image string nullable
• thumbnail string nullable
• banner string nullable
• bio string nullable
• bio_html string nullable
• website_url string nullable
• social_links array (default: [])
  • @type string (default: "PixivSocialLink")
  • network string required
  • url string required
• region string nullable
• age string nullable
• birthday string nullable
• gender string nullable
• job string nullable
• workspace array (default: [])
  • @type string (default: "PixivWorkspaceItem")
  • item string required
  • value string required
• is_premium boolean nullable
• is_official boolean nullable
• is_accepting_requests boolean nullable
• following_count integer nullable
• mypixiv_count integer nullable
• illust_count integer nullable
• manga_count integer nullable
• novel_count integer nullable
• public_bookmark_count integer nullable
• manga_series array (default: [])
  • @type string (default: "PixivWorkSeries")
  • id string required
  • description string nullable
  • cover string nullable
  • work_count integer nullable
  • first_work_id string nullable
  • latest_work_id string nullable
  • created_at integer nullable
  • updated_at integer nullable
• novel_series array (default: [])
  • @type string (default: "PixivWorkSeries")
  • id string required
  • description string nullable
  • cover string nullable
  • work_count integer nullable
  • first_work_id string nullable
  • latest_work_id string nullable
  • created_at integer nullable
  • updated_at integer nullable

Errors

• 422 — user is not a pixiv user id or URL 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 active pixiv user 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.