hotpepper/api/gourmet/v1

グルメサーチAPI

登録されているお店の一覧を取得します。

ホットペッパー Webサービス

api URL

api url
http://webservice.recruit.co.jp/hotpepper/gourmet/v1/
format
json / jsonp / xml
method
GET
認証
ApiKey
実行制限
なし
公式ドキュメント
http://webservice.recruit.co.jp/hotpepper/reference.html#a1to

parameter set

parameter value 省略 説明
key
MyApiKey-key をセット
必須 APIキー。アカウント登録時に取得したキー。
[MyApiKey-key]を指定すると、Apiキーを預けるで設定されたApiキーに自動変換します。
id お店ID。カンマ区切りで20個まで複数指定可能。
name 掲載店名。(部分一致)
name_kana 掲載店名かな検索。(部分一致)
name_any 掲載店名または掲載店名かな。部分一致。「掲載店名」または「掲載店名かな」を対象に部分一致検索。
tel お店の電話番号。ハイフン無し。
address お店の住所。部分一致。
special 特集コード。カンマ区切りで複数指定可能。AND検索。
special_or 特集コード。カンマ区切りで複数指定可能。OR検索。
special_category 特集カテゴリコード。カンマ区切りで複数指定可能。AND検索。
special_category_or 特集カテゴリコード。カンマ区切りで複数指定可能。OR検索。
is_open_time 営業時間。
now : 現在時刻で営業中。
hh:mm : 指定時刻で営業中。
is_open_week 営業曜日。is_open_timeと組み合わせて使う。カンマ区切りで複数指定可能。
1:月曜
2:火曜
3:水曜
4:木曜
5:金曜
6:土曜
7:日曜
8:祝前日
9:祝日
large_service_area 大サービスエリアコード。
service_area サービスエリアコード。カンマ区切りで3個まで指定可能。
large_area 大エリアコード。カンマ区切りで3個まで指定可能。
middle_area 中エリアコード。カンマ区切りで5個まで指定可能。
small_area 小エリアコード。カンマ区切りで5個まで指定可能。
keyword 店名かな、店名、住所、駅名、お店ジャンルキャッチ、キャッチのフリーワード検索。部分一致。半角スペース区切りでAND検索。
lat 緯度。
lng 経度。
range 緯度経度からの検索範囲。省略時は1000m。
datum 測地系。省略時は世界測地系。
ktai_coupon 携帯クーポンの有無。省略時は絞込みしない。
genre お店ジャンルコード。カンマ区切りで複数指定可能。
food 料理コード。カンマ区切りで5個まで指定可能。
budget 検索用予算コード。カンマ区切りで2個まで指定可能。
party_capacity 宴会収容人数。指定数より大きな収容人数のお店を検索。
wifi WiFi経由でインターネット利用が可能か絞り込む。省略時は絞り込まない。
wedding ウェディング・二次会等が可能か絞り込む。省略時は絞り込まない。
course 「コースあり」の条件で絞り込む。省略時は絞り込まない。
free_drink 「飲み放題」の条件で絞り込む。省略時は絞り込まない。
free_food 「食べ放題」の条件で絞り込む。省略時は絞り込まない。
private_room 「個室あり」の条件で絞り込む。省略時は絞り込まない。
horigotatsu 「掘りごたつあり」の条件で絞り込む。省略時は絞り込まない。
tatami 「座敷あり」の条件で絞り込む。省略時は絞り込まない。
cocktail 「カクテル充実」の条件で絞り込む。省略時は絞り込まない。
shochu 「焼酎充実」の条件で絞り込む。省略時は絞り込まない。
sake 「日本酒充実」の条件で絞り込む。省略時は絞り込まない。
wine 「ワイン充実」の条件で絞り込む。省略時は絞り込まない。
card 「カード可」の条件で絞り込む。省略時は絞り込まない。
non_smoking 「禁煙席」の条件で絞り込む。省略時は絞り込まない。
charter 「貸切可」の条件で絞り込む。省略時は絞り込まない。
ktai 「携帯電話OK」の条件で絞り込む。省略時は絞り込まない。
parking 「駐車場あり」の条件で絞り込む。省略時は絞り込まない。
barrier_free 「バリアフリー」の条件で絞り込む。省略時は絞り込まない。
sommelier 「ソムリエがいる」の条件で絞り込む。省略時は絞り込まない。
night_view 「夜景がキレイ」の条件で絞り込む。省略時は絞り込まない。
open_air 「オープンエア」の条件で絞り込む。省略時は絞り込まない。
show 「ライブ・ショーあり」の条件で絞り込む。省略時は絞り込まない。
equipment 「エンタメ設備」の条件で絞り込む。省略時は絞り込まない。
karaoke 「カラオケあり」の条件で絞り込む。省略時は絞り込まない。
band 「バンド演奏可」の条件で絞り込む。省略時は絞り込まない。
tv 「TV・プロジェクター」の条件で絞り込む。省略時は絞り込まない。
lunch 「ランチあり」の条件で絞り込む。省略時は絞り込まない。
midnight 「23時以降も営業」の条件で絞り込む。省略時は絞り込まない。
midnight_meal 「23時以降食事OK」の条件で絞り込む。省略時は絞り込まない。
english 「英語メニューあり」の条件で絞り込む。省略時は絞り込まない。
pet 「ペット可」の条件で絞り込む。省略時は絞り込まない。
child 「お子様連れOK」の条件で絞り込む。省略時は絞り込まない。
credit_card クレジットカードコード。カンマ区切りで複数指定可。
type レスポンスタイプ。
省略時は、クレジットカード・特集以外をすべて。
「lite」を指定すると主要項目のみ。
細かい指定方法はドキュメント参照。
order 並び順。省略時はオススメ順。
start レスポンスの開始位置。省略時は1。
count 1ページあたりの取得件数。1~100の範囲。省略時は10。
format 出力形式。

取得形式 :

call results

[call update]ボタンを押してください。ここに結果が表示されます。

  • このデータは、jsonpで取得しjabascriptオブジェクトに変換されたものを再度json形式に変換した結果です。
  • 受信されるデータと厳密に同じでないことをご理解ください。

発行したAPIのURLとパラメータ

下記のURLで、本ページの各パラメータに自動的にセットされます。

開発メンバー間でパラメータの指定例をメールで送信したり、ブログやホームページでApiの説明を書く際にお使いください。
※パラメータにApiキーなどが含まれる場合はご注意ください。

  • javascriptでは桁数の大きな数値で値がズレることがあります。
  • 例えば、twitterの id_str と id です。
  • id_str は文字列型ですので正しい値が表示されます。
  • id は数値型です。桁数が大きな場合、 +-1のズレが発生することがあります。
  • id_str と id が異なる場合は、id_str を信用してください。
  • 試しに下記をクリックして実行してみてください。期待する値がalertされるでしょうか?
  • javascript:eval('var a = 13782936788668417, b = \'13782936788668417\';'); alert(a+' : 数値型'+'\n\n'+b+' : 文字列型');
  • 本サイトでは、javascriptで処理をしている関係上、apiから取得してきたデータと異なることがあります。
  • あらかじめご理解・ご了承ください。