くりにっき

フルスタックキュアエンジニアです

AZusaar! 検索API仕様

API AZusaar

はてな記法の練習のためにAZusaar!のAPIの仕様をまとめてみます

概要

Zusaar, こくちーず, PARTAKE, doorkeeper の検索に対応しています
レスポンスはJSONとJSONPだけに対応しています
基本的にはATND API（以降ATND仕様）に準拠していますが、AZusaar!で必要のない項目は削っています
同じ名前のパラメータでも意味が違うものがあるのでご注意を

API詳細

リクエストURL

Zusaar: http://azusaar.appspot.com/api/zusaar
こくちーず: http://azusaar.appspot.com/api/kokucheese
PARTAKE: http://azusaar.appspot.com/api/partake
Doorkeeper: http://azusaar.appspot.com/api/doorkeeper

検索クエリ

パラメータ	項目名	説明
keyword	検索キーワード（AND）	文字コードはUTF-8。複数指定した場合はAND検索
ym	検索対象年月	YYYYMMで指定(例:201206)
ymd	検索対象年月日	YYYYMMDDで指定(例:20120601)
start	取得開始位置(1～)	初期値:1
count	取得件数(1〜100)	初期値:100
allReturn	全件取得フラグ	検索結果を全件取得する。allReturnが指定されていた場合startとcountは無視される
dayUnique	日付重複無視フラグ	同じ日付のイベントは最初の1件だけしか返さない
callback	JSONPのコールバック関数名	callbackがある場合はJSONP, ない場合はJSONで返却

ATND仕様と違い複数指定できるのはkeywordだけ
- 複数指定する場合はkeyword=aaa&keyword=bbbのようにしてください (カンマ区切りはダメです)
ymとymdのどちらか片方だけ指定可能
- 両方ある場合はymdが優先
- 両方ない場合は今月分を検索
フラグは1もしくはtrueを指定すれば有効になります
Zusaarは本来形態素検索*1しかできませんが、AZusaar!では全文検索を行います

サンプルクエリ

Zusaar: http://azusaar.appspot.com/api/zusaar?keyword=google
こくちーず: http://azusaar.appspot.com/api/kokucheese?keyword=google
PARTAKE: http://azusaar.appspot.com/api/partake?keyword=google
doorkeeper: http://azusaar.appspot.com/api/doorkeeper?keyword=google

レスポンスフィールド

フィールド	説明	備考
results_returned	含まれる検索結果の件数
results_start	検索の開始位置
event	[複数要素]
└ title	タイトル
└ event_url	Zusaar,こくちーず,PARTAKEのイベントページのURL
└ started_at	イベント開催日時	「2012-06-20T19:30:00+09:00」のようなフォーマット。こくちーずのイベントの時刻は常に「00:00:00」です
└ address	開催場所
└ place	開催会場
└ lat	開催会場の緯度
└ lon	開催会場の経度

results_returnedには実際の件数ではなくkeywordで絞り込む前の値が返ってきます
- keywordを指定した場合、results_returnedよりも実際の件数は少ないことがあります
- ページングしたい場合は results_returned == count かどうかで判断してください

APIの利用について

節度を守ってご利用ください
事前、事後ともに報告は不要です

他のAPI仕様

http://sue445.hatenablog.com/category/API

2013/2/9更新

doorkeeperについて追記

*1:キーワードにマッチしたものだけを検索