/hatena_bookmark/entries

POST /api/hatena_bookmark/entries

Price: 1 credit

Get Hatena Bookmark Entry

How to use it

Look up what Hatena Bookmark — Japan's largest social bookmarking service — knows about any web page. Pass the page URL and get its Japanese title, how many people bookmarked it, how many left a comment, the ten tags readers most often applied to it, the editorial category it was filed under, the thumbnail, a text excerpt and the moment the page was first bookmarked. Use hatena_bookmark/entries/bookmarks for the individual comments.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• url string required — Web page URL, or its Hatena Bookmark entry URL (examples: "https://ledge.ai/articles/kyoto-u-ac-python")

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 — Nobody has bookmarked this URL, so Hatena Bookmark has no entry for it. 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.