Hatena::Grouphatenadeveloper

はてなブックマーク件数取得API

ja/bookmark/apis/getcount

はてなブックマーク件数取得API

本ドキュメントに関する注意事項

本ドキュメントははてなブックマークにおける件数取得のAPI実装を解説するものです。

GET リクエストでのシンプルなAPI

GET リクエストでのシンプルな件数取得 API です。

http://api.b.st-hatena.com/entry.count?url=http%3A%2F%2Fwww.hatena.ne.jp%2F

のように http://api.b.st-hatena.com/entry.count の API エンドポイントにクエリパラメータ url を付与し GET リクエストを送ることで、簡単にカウント数を取得することができます。

また、callback クエリパラメータを付与することで、JSONP でカウント件数を取得することも可能です。

http://api.b.st-hatena.com/entry.count?url=http%3A%2F%2Fwww.hatena.ne.jp%2F&callback=MyCallbackFunction

なお、API のエンドポイントのドメインは api.b.st-hatena.com となっていますが、現時点(2009年08月11日)では b.hatena.ne.jp ドメインでもアクセス可能ですが、将来的にはこの GET リクエストのAPIではb.hatena.ne.jp ドメインでは使えなくなる可能性がありますので、api.b.st-hatena.com をご利用ください。

GET リクエストでのシンプルな API(被ブックマーク合計数取得API)

※ 本APIは実験的に公開している API です

「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 版)

GET リクエストでのシンプルな件数取得 API の、複数 URL 対応版です。

http://api.b.st-hatena.com/entry.counts?url=http%3A%2F%2Fwww.hatena.ne.jp%2F&url=http%3A%2F%2Fb.hatena.ne.jp%2F

のように http://api.b.st-hatena.com/entry.counts の 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 も利用できます。

http://api.b.st-hatena.com/entry.counts?url=http%3A%2F%2Fwww.hatena.ne.jp%2F&url=http%3A%2F%2Fb.hatena.ne.jp%2F&callback=MyCallbackFunction

ご利用にあたっての注意事項

  • 実験的に公開されている API は、仕様の変更ならびに API の公開停止を予告なしに行う場合があります。
  • API へのリクエストに際して、1クライアントあたりの上限回数はいまのところありません。ただし、過度なリクエストはサーバーの過負荷ならびにサービスのレスポンス低下に繋がりますので、繰り返しリクエストされる場合は、リクエスト毎に数秒の間隔をあけていただくなど、サーバーリソースの節約にご協力ください。

変更履歴

  • 2018年06月27日 XML-RPC API を廃止
  • 2018年06月05日 GETリクエストでのシンプルなAPI(被ブックマーク合計数取得API)を追加
  • 2013年09月10日 GETリクエストでのシンプルなAPI(複数URL版)を追加
  • 2009年08月11日 GETリクエストのシンプルなAPIを追加
  • 2006年10月4日 被ブックマーク合計数取得APIを追加
  • 2005年12月20日 被コレクション件数取得APIを追加
  • 2005年12月12日 リリース