/zenn/users

POST /api/zenn/users

Price: 1 credit

Get Zenn User

How to use it

Get a Zenn user profile by username or profile URL. Returns the bio, avatar, GitHub/X/website links, how many articles, books and scraps they published, follower and following counts, the badges readers sent them, the total likes their posts earned, and the contest prizes they won with the winning article. The same URL segment can belong to a publication instead - use zenn/publications for those.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• user string required — Username or profile URL (examples: "mizchi", "https://zenn.dev/mizchi")

Response

• @type string (default: "ZennUser")
• id integer required
• alias string required
• name string nullable
• bio string nullable
• bio_html string nullable
• image string nullable
• url string nullable
• github_url string nullable
• twitter_url string nullable
• hatena_id string nullable
• website_url string nullable
• analytics_id string nullable
• seller_name string nullable
• seller_contact string nullable
• is_support_open boolean (default: false)
• total_liked_count integer nullable
• article_count integer nullable
• book_count integer nullable
• scrap_count integer nullable
• badge_count integer nullable
• follower_count integer nullable
• following_count integer nullable
• following_user_count integer nullable
• following_publication_count integer nullable
• awards array (default: [])
  • @type string (default: "ZennAward")
  • event_alias string required
  • event_title string nullable
  • event_type string nullable
  • prize_name string nullable
  • prize_rank string nullable
  • article object nullable
    • @type string (default: "ZennArticleRef")
    • id integer required
    • alias string required
    • article_title string nullable
    • article_type string nullable (one of: "tech", "idea")
    • emoji string nullable
    • url string nullable
    • published_at integer nullable
    • body_updated_at integer nullable
    • source_repo_updated_at integer nullable
    • like_count integer nullable
    • comment_count integer nullable
    • bookmark_count integer nullable
    • letter_count integer nullable
    • is_pinned boolean (default: false)
    • principal_type string nullable (one of: "User", "Publication")
    • user object nullable
      • @type string (default: "ZennUserRef")
      • id integer required
      • alias string required
      • name string nullable
      • image string nullable
      • url string nullable
    • publication object nullable
      • @type string (default: "ZennPublicationRef")
      • id integer required
      • alias string required
      • name string nullable
      • image string nullable
      • url string nullable
      • is_pro boolean (default: false)
      • has_avatar boolean (default: false)

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 — User not found. Verify the username. 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.