/zenn/scraps/search

POST /api/zenn/scraps/search

Price: 5 credits

Search Zenn Scraps

How to use it

Search or browse Zenn scraps - running notebook threads. Either pass keyword for full text search, or narrow the feed by author and topic; the two modes cannot be combined. Returns each thread's title, topics, open/closed state, comment and like counts and its author; use zenn/scraps for the discussion.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string nullable — Full text matched against the scrap title and comments (examples: "Rust")
• user string nullable — Author username or profile URL (examples: "kun432")
• topic string nullable — Topic name or its URL (examples: "rust")
• order string — Result ordering (default: "trending"; one of: "trending", "alltime", "latest")
• count integer required — Max result count (examples: 20; min: 1)

Response

• @type string (default: "ZennScrapRef")
• id integer required
• alias string required
• scrap_title string nullable
• url string nullable
• created_at integer nullable
• last_comment_created_at integer nullable
• closed_at integer nullable
• is_closed boolean (default: false)
• is_noindex boolean (default: false)
• can_others_post boolean (default: false)
• comment_count integer nullable
• like_count integer nullable
• 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
• user object nullable
  • @type string (default: "ZennUserRef")
  • id integer required
  • alias string required
  • name string nullable
  • image string nullable
  • url string nullable

Errors

• 422 — keyword cannot be combined with the author/topic filters. 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 — Author 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.