Hatena::Grouphatenadeveloper

はてなハイクタイムライン API

ja/haiku/apis/rest/timelines

はてなハイクタイムライン API

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

本ドキュメントははてなハイク REST API の解説の一部です。

タイムライン API の概要

零個以上の投稿 (エントリー) のリストをタイムラインと呼びます。はてなハイクタイムライン API を使うと次の各種のタイムラインを取得することができます。

名前対応するページ
statuses/public_timelineはてなハイクのトップページ
statuses/keyword_timelineキーワードのエントリーページ
statuses/user_timelineユーザーのエントリーページ
statuses/friends_timelineユーザーのアンテナページ
statuses/albumはてなハイクのアルバムページ、キーワードのアルバムページ

共通の引数

このページで説明する API では、次の引数を URL の query 部分に指定することができます。

引数名説明値の種類個数
count取得する投稿の個数です。最大値は 200 です。省略すると 20 とみなします。数値高々1個
page取得するページの番号です。最初のページは 1 です。省略すると 1 とみなします。最大値は 100 です。数値高々1個
since取得を中断する投稿日時です。この時刻よりも古い投稿は結果に含まれません。省略すると他の条件を満たすすべての投稿を含めます。HTTP の日時高々1個
sort投稿の整列順です。 new で新着順、 hot で人気順となります。はてなハイクの Web サイトで人気順が存在するタイムラインでのみ指定できます。省略すると new とみなします。 高々1個

statuses/public_timeline

http://h.hatena.ne.jp/http://h.hatena.com/ に対応する、はてなハイク全体の最新の投稿を返します。 Web サイトと同様に、ユーザーのキーワードへの投稿は含まれず、単語や商品などのキーワードへの投稿のみが含まれます。

URL

http://{domain}/api/statuses/public_timeline.{format}?{parameters}
{domain}はてなハイクのドメイン名です。 h.hatena.ne.jp で日本版、 h.hatena.com で全世界版のタイムラインを取得できます。
{format}結果の書式です。 json または xml を指定できます。
{parameters}name1=value1&name2=value2&... の形式で引数を指定できます。

認証

認証は必要ありません。

メソッド

HTTP GET メソッドでアクセスしてください。

引数

次の引数を指定できます: callback, はてなハイク1.1の新機能 body_formats, count, page, since

結果

取得に成功した場合、投稿配列を返します。

statuses/friends_timeline

http://h.hatena.ne.jp/followinghttp://h.hatena.com/following に対応する、認証したユーザー、または指定したユーザーがお気に入りに追加しているユーザーやキーワードの投稿を返します。

URL

http://{domain}/api/statuses/friends_timeline.{format}?{parameters}
http://{domain}/api/statuses/friends_timeline/{url_name}.{format}?{parameters}
{domain}はてなハイクのドメイン名です。 h.hatena.ne.jp で日本版、 h.hatena.com で全世界版のタイムラインを取得できます。
{format}結果の書式です。 json または xml を指定できます。
{parameters}name1=value1&name2=value2&... の形式で引数を指定できます。
{url_name}タイムラインを取得するユーザーのはてなIDです。

認証

URL に {url_name} が含まれる場合、認証は必要ありません。

URL に {url_name} が含まれない場合、 OAuth (read_public 権限) または基本認証が必要です。

メソッド

HTTP GET メソッドでアクセスしてください。

引数

次の引数を指定できます: callback, count, page, since, はてなハイク1.1の新機能 body_formats

結果

取得に成功した場合、投稿配列を返します。

statuses/user_timeline

http://h.hatena.ne.jp/{username}/ に対応する、認証したユーザー、または指定したユーザーの最新の投稿を返します。

URL

http://{domain}/api/statuses/user_timeline.{format}?{parameters}
http://{domain}/api/statuses/user_timeline/{url_name}.{format}?{parameters}
{domain}はてなハイクのドメイン名です。 h.hatena.ne.jp で日本版、 h.hatena.com で全世界版のタイムラインを取得できます。
{format}結果の書式です。 json または xml を指定できます。
{parameters}name1=value1&name2=value2&... の形式で引数を指定できます。
{url_name}タイムラインを取得するユーザーのはてなIDです。

認証

URL に {url_name} が含まれる場合、認証は必要ありません。

URL に {url_name} が含まれない場合、 OAuth (read_public 権限) または基本認証が必要です。

メソッド

HTTP GET メソッドでアクセスしてください。

引数

次の引数を指定できます: callback, count, page, since, はてなハイク1.1の新機能 body_formats, media, sort

media 引数には default または album を指定できます。 default を指定するとすべての投稿を、 album を指定すると画像が含まれる投稿のみを結果に含めます。省略すると default とみなします。

結果

取得に成功した場合、投稿配列を返します。

statuses/keyword_timeline

http://h.hatena.ne.jp/keyword/{keyword} や http://h.hatena.com/keyword/{keyword} などに対応する、指定したキーワードへの投稿を返します。

URL

http://{domain}/api/statuses/keyword_timeline.{format}?{parameters}
http://{domain}/api/statuses/keyword_timeline/{keyword}.{format}?{parameters}
{domain}はてなハイクのドメイン名です。 h.hatena.ne.jp で日本版、 h.hatena.com で全世界版のタイムラインを取得できます。
{format}結果の書式です。 json または xml を指定できます。
{parameters}name1=value1&name2=value2&... の形式で引数を指定できます。
{keyword}非推奨 タイムラインを取得するキーワードの word です。かわりに word 引数を使うことをおすすめします。

認証

認証は必要ありません。

メソッド

HTTP GET メソッドでアクセスしてください。

引数

次の引数を指定できます: callback, count, page, since, はてなハイク1.1の新機能 body_formats, sort, word

URL に {keyword} を含めない場合は、引数として word を指定しなければなりません。

結果

取得に成功した場合、投稿配列を返します。

statuses/album

アルバムページに対応する、画像を含む投稿のリストを返します。 {keyword} が指定されたときはキーワードのアルバムを返します。

URL

http://{domain}/api/statuses/album.{format}?{parameters}
http://{domain}/api/statuses/album/{keyword}.{format}?{parameters}
{domain}はてなハイクのドメイン名です。 h.hatena.ne.jp で日本版、 h.hatena.com で全世界版のタイムラインを取得できます。
{format}結果の書式です。 json または xml を指定できます。
{parameters}name1=value1&name2=value2&... の形式で引数を指定できます。
{keyword}非推奨 タイムラインを取得するキーワードの word です。かわりに word 引数を使うことをおすすめします。

認証

認証は必要ありません。

メソッド

HTTP GET メソッドでアクセスしてください。

引数

次の引数を指定できます: callback, はてなハイク1.1の新機能 body_formats, count, page, since, sort, word

URL に {keyword} を含めず、引数としても word を含めないと、キーワードを限定せず、はてなハイク全体から返します。

結果

取得に成功した場合、投稿配列を返します。

GET http://h.hatena.ne.jp/api/statuses/public_timeline.xml

<statuses type="array">
  <status>
    <id>12345678901234</id>
    <created_at>2008-08-19T00:00:00Z</created_at>
    <favorited>0</favorited>
    <in_reply_to_status_id>98765432109876</in_reply_to_status_id>
    <in_reply_to_user_id>jkondo</in_reply_to_user_id>

    <keyword>はてなデフォルトさん</keyword>
    <link>http://h.hatena.ne.jp/jkondo/12345678901234</link>
    <source>web</source>
    <text>はてなデフォルトさん=こんにちは、かわいいデフォルトさんですね。</text>
    <user>
      <name>jkondo</name>
      <followers_count>1</followers_count>
      <id>jkondo</id>
      <profile_image_url>http://www.hatena.ne.jp/users/jk/jkondo/profile.gif</profile_image_url>
      <screen_name>jkondo</screen_name>
      <url>http://h.hatena.ne.jp/jkondo/</url>
    </user>
  </status>
  <!-- status 要素が続きます。 -->
</statuses>

GET http://h.hatena.ne.jp/api/statuses/public_timeline.json

[
   {
      "keyword" : "はてなデフォルトさん",
      "source" : "web",
      "link" : "http://h.hatena.ne.jp/jkondo/12345678901234",
      "favorited" : 0,
      "created_at" : "2008-08-19T00:00:00Z",
      "text" : "はてなデフォルトさん=こんにちは、かわいいデフォルトさんですね。",
      "in_reply_to_user_id" : "jkondo",
      "user" : {
         "followers_count" : 1,
         "name" : "jkondo",
         "url" : "http://h.hatena.ne.jp/jkondo/",
         "profile_image_url" : "http://www.hatena.ne.jp/users/jk/jkondo/profile.gif",
         "id" : "jkondo",
         "screen_name" : "jkondo"
      },
      "id" : "12345678901234",
      "in_reply_to_status_id" : "98765432109876"
   },
   ... さらに続きます
]

関連ドキュメント

はてなハイク RSS フィード
タイムラインの情報は RSS フィードとしても取得できます。

変更履歴

  • 2010年12月13日 Hatena Developer Center で改めて公開。
  • 2010年12月24日 はてなハイク1.1ベータ版の情報を追加。
  • 2011年2月14日 はてなハイク1.1の情報を追加。