/hatena_bookmark/entries/search

POST /api/hatena_bookmark/entries/search

Price: 20 credits

Search Hatena Bookmark Entries

How to use it

Search two decades of Japanese web pages that Hatena Bookmark users saved, by keyword. Match on reader tags, page titles, page text or everything at once; order by popularity or recency; keep only pages above a bookmark threshold; and restrict to a relative window or an explicit date range. Each hit returns the source URL, title, bookmark count, category, reader tags, thumbnail and excerpt.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Search keyword (examples: "AI"; minLength: 1)
• target string — Which part of the entry to match (default: "all"; one of: "all", "tag", "title", "text")
• sort string — Result ordering (default: "popular"; one of: "popular", "recent")
• min_bookmarks integer — Keep only entries with at least this many bookmarks (default: 1; examples: 50; min: 1)
• period string — How far back to look (default: "all"; one of: "all", "week", "month", "year")
• date_begin string nullable — Earliest entry date, YYYY-MM-DD (examples: "2020-01-01")
• date_end string nullable — Latest entry date, YYYY-MM-DD (examples: "2021-01-01")
• count integer required — Max result count (examples: 40; min: 1)

Response

• @type string (default: "HatenaBookmarkEntry")
• entry_title string nullable
• url string nullable
• entry_url string nullable
• image string nullable
• description string nullable
• category string nullable (one of: "all", "general", "social", "economics", "life", "knowledge", "it", "fun", "entertainment", "game")
• category_name string nullable
• domain string nullable
• site_url string nullable
• root_url string nullable
• bookmark_count integer nullable
• comment_count integer nullable
• tags array (default: [])
• attributes array (default: [])
• 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 — The entity was not found, or a precondition failed 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.