/zenn/books

POST /api/zenn/books

Price: 1 credit

Get Zenn Book

How to use it

Get a Zenn technical book by slug or URL. Returns the cover, price in JPY, summary, topics, like count, the badges readers awarded it, the scrap threads linked to it as reader forums, the GitHub repository it is synced from, the author profile, and the full chapter list with each chapter's title, position, length and whether it is free to read. Use zenn/books/chapters to read a chapter body.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• book string required — Book slug or book URL (examples: "nextjs-basic-principle", "https://zenn.dev/akfm/books/nextjs-basic-principle")

Response

• @type string (default: "ZennBook")
• id integer required
• alias string required
• book_title string nullable
• url string nullable
• image string nullable
• og_image string nullable
• summary string nullable
• summary_html string nullable
• price integer nullable
• is_bestseller boolean (default: false)
• is_toc_enabled boolean (default: false)
• can_read_all_chapters boolean (default: false)
• requires_additional_settings boolean (default: false)
• toc_depth integer nullable
• letter_count integer nullable
• like_count integer nullable
• published_at integer nullable
• body_updated_at integer nullable
• source_repo_updated_at integer nullable
• draft_reveal_scope string nullable
• github_url string nullable
• github_commits_url string nullable
• github_dev_url string nullable
• github_repository object nullable
  • @type string (default: "ZennGithubRepository")
  • id integer required
  • name string nullable
  • full_name string nullable
  • branch_name string nullable
  • url string nullable
  • is_public boolean (default: false)
  • is_link_shown boolean (default: false)
• topics array (default: [])
  • @type string (default: "ZennTopic")
  • id integer required
  • alias string required
  • name string nullable
  • image string nullable
  • url string nullable
  • tagging_count integer nullable
• chapters array (default: [])
  • @type string (default: "ZennChapterRef")
  • id integer required
  • alias string required
  • chapter_title string nullable
  • url string nullable
  • position integer nullable
  • is_free boolean (default: false)
  • letter_count integer nullable
  • filename string nullable
  • body_updated_at integer nullable
  • source_repo_updated_at integer nullable
• badges array (default: [])
  • @type string (default: "ZennBadge")
  • badge_type string required
  • rank string nullable
  • created_at integer nullable
• cross_references array (default: [])
  • @type string (default: "ZennCrossReference")
  • id integer required
  • reference_type string nullable
  • reference_type_name string nullable
  • source_id integer nullable
  • source_type string nullable
  • source_user_id integer nullable
  • target_id integer nullable
  • target_type string nullable
  • target_user_id integer nullable
  • created_at integer nullable
  • target object nullable
    • @type string (default: "ZennCrossReferenceTarget")
    • id integer required
    • alias string nullable
    • post_type string nullable
    • target_title string nullable
    • url string nullable
    • emoji string nullable
    • image string nullable
    • like_count integer nullable
    • published_at integer nullable
• user object nullable
  • @type string (default: "ZennUserSummary")
  • 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
  • total_liked_count integer nullable
  • is_support_open boolean (default: false)
  • analytics_id string nullable
  • seller_name string nullable
  • seller_contact string 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 object nullable (see schema ZennArticleType)
      • 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 object nullable (see schema ZennPrincipalType)
      • user object nullable (see schema ZennUserRef)
      • publication object nullable (see schema ZennPublicationRef)

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 — Book not found. Verify the book slug or URL. 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.