本ドキュメントははてなブックマークにおける件数取得のAPI実装を解説するものです。
GET リクエストでのシンプルな件数取得 API です。
https://bookmark.hatenaapis.com/count/entry?url=http%3A%2F%2Fwww.hatena.ne.jp%2F
のように https://bookmark.hatenaapis.com/count/entry の API エンドポイントにクエリパラメータ url を付与し GET リクエストを送ることで、簡単にカウント数を取得することができます。
また、callback クエリパラメータを付与することで、JSONP でカウント件数を取得することも可能です。
https://bookmark.hatenaapis.com/count/entry?url=http%3A%2F%2Fwww.hatena.ne.jp%2F&callback=MyCallbackFunction
※ 本APIは実験的に公開している API です
※ 非推奨 本APIは 2020年3月4日以降は利用できなくなります。
「GET リクエストでのシンプルな件数取得 API」 が特定のページのブックマーク数を取得するためのAPIであるのに対し、本 API は「特定のページ」ではなく「指定した url とそれ以下のパスの url」に対するブックマークの合計数を取得します。
例えば特定のブログで、そのブログが全体で何件ブックマークされているかを取得することができます。(本API は 2018年06月05日に追加されました。)
http://api.b.st-hatena.com/entry.total_count?url=http%3A%2F%2Fwww.hatena.ne.jp%2F
のように http://api.b.st-hatena.com/entry.count の API エンドポイントにクエリパラメータ url を付与し GET リクエストを送ることで、指定した url とそれ以下のパスに対するブックマークの合計数を取得できます。応答は以下フォーマットの JSON 形式となります。
{ "url": "http://www.hatena.ne.jp/", "total_bookmarks": 65913 }
GET リクエストでのシンプルな件数取得 API の、複数 URL 対応版です。
https://bookmark.hatenaapis.com/count/entries?url=http%3A%2F%2Fwww.hatena.ne.jp%2F&url=http%3A%2F%2Fb.hatena.ne.jp%2F
のように https://bookmark.hatenaapis.com/count/entries の API エンドポイントにクエリパラメータ url を複数付与し GET リクエストを送ることで、複数の URL に対するブックマーク数を一度に取得できます。応答は URL をキー、ブックマーク数を値とした JSON 形式となります。
{"http://www.hatena.ne.jp/":5790,"http://b.hatena.ne.jp/":6793}
一度に指定できる url の数は 50 までです。これを越えると 414 Request-URI Too Large が返却されます。
1 URL に対する API の場合と同様に、callback パラメータを指定することで、JSONP も利用できます。
https://bookmark.hatenaapis.com/count/entries?url=http%3A%2F%2Fwww.hatena.ne.jp%2F&url=http%3A%2F%2Fb.hatena.ne.jp%2F&callback=MyCallbackFunction