ホットペッパー Webサービス / APIリファレンス

■2007.11.19 ホットペッパーWebサービスはリクルートWebサービスに統合されました。
ホットペッパーWebサービスはリクルートWebサービスに統合されました。そのためリクルートWebサービスの利用規約が適用されますので、こちらをご覧ください。
現在公開中の「ホットペッパーWebサービス(http://api.hotpepper.jp)」に関しましては、リクルートWebサービスへの統合後も当面の間稼動いたしますが、今後はサービスレベルの向上や機能追加等を行わない計画ですので、新しく開発をされる方は、 http://webservice.recruit.co.jp/hotpepper/で提供されるリクルートWebサービス版をお使いください。

グルメサーチAPI （ver 1.1）ベータ版
- エラー時のハンドリング
  - エラーコード
  - エラー時のレスポンス
店名サーチAPI （ver 1.1）ベータ版
マスタAPI群（ver 1.1）ベータ版　
旧バージョン
- ver1.0

グルメサーチAPI †

*1 APIキーとして、リクルートWebサービスのAPIキー[新規登録]を使用してください。従来のguestも当面の間ご使用になれます。

URL †

http://api.hotpepper.jp/GourmetSearch/V110/

検索クエリ †

パラメータ	項目名	必須	説明	値
key	APIキー	○	APIを利用するために割り当てられたキーを設定します。	リクルートWebサービスのAPIキー。*1
ShopIdFront	お店ID	店舗指定検索を行う場合、いずれか必須	お店に割り当てられた番号で検索します。（20個まで指定可）	「J」+半角数字。複数指定時はShopIdFront=J999999999&ShopIdFront=J999999998のように指定。
ShopNameKana	掲載店名かな		お店の読みかなで検索(部分一致)します。	UTF8ひらがな(URLエンコード)
ShopName	掲載店名		お店の名前で検索(部分一致)します。	UTF8(URLエンコード)
ShopTel	電話番号		お店の電話番号で検索します。	半角数字(ハイフンなし)
ShopAddress	住所		お店の住所で検索(部分一致)します。	UTF8(URLエンコード)
LargeServiceAreaCD	大サービスエリアCD	エリア検索を行う場合いずれか必須	エリアに割り当てられた番号で検索します。	エリアマスタAPI参照
ServiceAreaCD	サービスエリアCD		エリアに割り当てられた番号で検索します。（３個まで指定可）	エリアマスタAPI参照。複数指定時はServiceAreaCD=SA11&ServiceAreaCD=SA12のように指定。
LargeAreaCD	大エリアCD		エリアに割り当てられた番号で検索します。（３個まで指定可）
MiddleAreaCD	中エリアCD		エリアに割り当てられた番号で検索します。（５個まで指定可）
SmallAreaCD	小エリアCD		エリアに割り当てられた番号で検索します。（５個まで指定可）
Keyword	フリーワード	フリーワード検索を行う場合必須	店名かな、店名、住所、駅名、お店ジャンルキャッチ、キャッチのフリーワード検索(部分一致)が可能です。	UTF8(URLエンコード)。単語間をスペースで区切ることでAND検索が可能。
Latitude	緯度	位置から検索を行う場合、必須	ある地点からの範囲内のお店の検索を行う場合の緯度です。	degree(例)35.66922072646455
Longitude	経度		ある地点からの範囲内のお店の検索を行う場合の経度です。	degree(例)139.7614574432373
Range	検索範囲		ある地点からの範囲内のお店の検索を行う場合の範囲を5段階で指定できます。	1:300m,2:500m,3:1000m,4:2000m,5:3000m。デフォルト3
Datum	測地系		緯度・経度の測地系を指定できます。	"world"(世界測地系)、"tokyo"(旧日本測地系)。初期値はworld
KtaiCoupon	携帯クーポン掲載		携帯クーポンの有無で絞り込み条件を指定します。	1：携帯クーポンなし、0：携帯クーポンあり、指定なし：絞り込みなし
GenreCD	お店ジャンルCD	ジャンル･料理･予算から検索を行う場合いずれか必須	お店のジャンルで絞込みをするかを指定します。（３個まで指定可）	ジャンルマスタAPI参照。複数指定時はGenreCD=G001&GenreCD=G002のように指定。
FoodCD	料理CD		料理名で絞込みをするかを指定します。（５個まで指定可）	料理マスタAPI参照。複数指定時はFoodCD=R001&FoodCD=R002のように指定。
BudgetCD	検索用予算CD		予算で絞込みをするかを指定します。（２個まで指定可）	検索用予算マスタAPI参照。複数指定時はBudgetCD=B001&BudgetCD=B002のように指定。
PartyCapacity	宴会収容人数		宴会収容人数で絞り込むことができます。	半角数字
Wedding	ウェディング・二次会等		ウェディング・二次会等のお問い合わせが可能なお店を絞り込みます。	0:絞り込まない（初期値）、1:絞り込む
Course	コースあり		「コースあり」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
FreeDrink	飲み放題		「飲み放題」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
FreeFood	食べ放題		「食べ放題」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
PrivateRoom	個室あり		「個室あり」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
Horigotatsu	掘りごたつあり		「掘りごたつあり」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
Tatami	座敷あり		「座敷あり」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
Cocktail	カクテル充実		「カクテル充実」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
Shochu	焼酎充実		「焼酎充実」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
Sake	日本酒充実		「日本酒充実」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
Wine	ワイン充実		「ワイン充実」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
Card	カード可		「カード可」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
NonSmoking	禁煙席		「禁煙席」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
Charter	貸切可		「貸切可」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
Ktai	携帯電話OK		「携帯電話OK」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
Parking	駐車場あり		「駐車場あり」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
BarrierFree	バリアフリー		「バリアフリー」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
Sommelier	ソムリエがいる		「ソムリエがいる」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
NightView	夜景がキレイ		「夜景がキレイ」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
OpenAir	オープンエア		「オープンエア」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
Show	ライブ・ショーあり		「ライブ・ショーあり」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
Equipment	エンタメ設備		「エンタメ設備」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
Karaoke	カラオケあり		「カラオケあり」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
Band	バンド演奏可		「バンド演奏可」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
Tv	TV・プロジェクター		「TV・プロジェクター」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
Lunch	ランチあり		「ランチあり」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
Midnight	23時以降も営業		「23時以降も営業」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
MidnightMeal	23時以降食事OK		「23時以降食事OK」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
English	英語メニューあり		「英語メニューあり」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
Pet	ペット可		「ペット可」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
Child	お子様連れOK		「お子様連れOK」という条件で絞り込むかどうかを指定します。	0:絞り込まない（初期値）、1:絞り込む
Order	ソート順		検索結果の並び順を指定します。おススメ順は定期的に更新されます。	0:距離順（位置から検索を行った場合）、1:店名かな順、2:ジャンルコード順、3:小エリアコード順、4:おススメ順。初期値はおススメ順。（位置から検索を行った場合は距離順）
Start	検索の開始位置（何件目か？）		検索結果の何件目から出力するかを指定します。	半角数字。初期値は 1
Count	1ページあたりの取得数		検索結果の最大出力データ数を指定します。	1～100までの半角数字。初期値は 10

サンプルクエリ †

店名:居酒屋ホットペッパーで検索(結果は小エリアコード順)

http://api.hotpepper.jp/GourmetSearch/V110/?key=guest&ShopName=%E5%B1%85%E9%85%92%E5%B1%8B%E3%83%9B%E3%83%83%E3%83%88%E3%83%9A
%E3%83%83%E3%83%91%E3%83%BC&Order=3

注：↑実在しない店舗名のためサンプルクエリの結果は0件で返ります。

地点を指定して、その範囲にあるお店を取得

http://api.hotpepper.jp/GourmetSearch/V110/?key=guest&Latitude=35.660818&Longitude=139.775426&Range=3

レスポンスフィールド †

フィールド	説明	型	出現回数	例
Results			1
NumberOfResults	該当件数	半角数字	1	100
DisplayPerPage	検索クエリで指定された、表示件数	半角数字	1	10
DisplayFrom	検索クエリで指定された、検索の開始位置	半角数字	1	1
APIVersion	APIバージョン	半角数字・記号	1	1.11
Shop			表示件数分
ShopIdFront	お店ID	半角英数	1	J999999999
ShopNameKana	掲載店名かな	全角･半角	1	いざかや　ほっとぺっぱー
ShopName	掲載店名	全角･半角	1	居酒屋ホットペッパー
ShopAddress	住所	全角･半角	1	東京都中央区銀座８－４－１７
StationName	最寄駅名	全角･半角	1	銀座
KtaiCoupon	携帯用クーポン掲載	0:あり、1:なし	1	0
LargeServiceAreaCD	大サービスエリアCD	半角英数	1	SS10
LargeServiceAreaName	大サービスエリア名	全角･半角	1	関東
ServiceAreaCD	サービスエリアCD	半角英数	1	SA11
ServiceAreaName	サービスエリア名	全角･半角	1	東京
LargeAreaCD	大エリアCD	半角英数	1	Z011
LargeAreaName	大エリア名	全角･半角	1	東京
MiddleAreaCD	中エリアCD	半角英数	1	Y005
MiddleAreaName	中エリア名	全角･半角	1	銀座・有楽町・新橋・築地・月島
SmallAreaCD	小エリアCD	半角英数	1	X010
SmallAreaName	小エリア名	全角･半角	1	銀座5～8丁目
Latitude	緯度	degree。測地系はリクエストで指定したもの	1	35.66922072646455
Longitude	経度	degree。測地系はリクエストで指定したもの	1	139.7614574432373
GenreCD	お店ジャンルCD	半角英数	1	G001
GenreName	お店ジャンル	全角･半角	1	居酒屋
FoodCD	料理名CD	半角英数	1	R021
FoodName	料理名	全角･半角	1	和風創作料理
GenreCatch	お店ジャンルキャッチ	全角･半角	1	一口餃子専門店
ShopCatch	お店キャッチ	全角･半角	1	TVの口コミランキングで堂々1位に輝いた一口餃子専門店！！
BudgetCD	検索用予算CD	半角英数	1	B001
BudgetDesc	検索用予算	全角･半角	1	～1000
BudgetAverage	平均予算	全角･半角	1	「900円」「フリー2500円　宴会3500円」など
Capacity	総席数	全角･半角	1	185
Access	アクセス	全角･半角	1	銀座駅A2出口でて､みゆき通り右折､徒歩1分
KtaiAccess	携帯用アクセス	全角･半角	1	銀座一丁目駅10番出口徒歩3分
ShopUrl	店舗URL	半角英数記号(URL)	1	http://www.hotpepper.jp/....
KtaiShopUrl	店舗URL	半角英数記号(URL)	1	http://hpr.jp/...
KtaiQRUrl	QRコードURL	半角英数記号(URL)	1	http://api.hotpepper.jp/...
PictureUrl			1
PcLargeImg	PC用店舗トップ写真(大）	半角英数記号(URL)	1	http://www.hotpepper.jp/...
PcMiddleImg	PC用店舗トップ写真(中）	半角英数記号(URL)	1	http://www.hotpepper.jp/...
PcSmallImg	PC用店舗トップ写真(小）	半角英数記号(URL)	1	http://www.hotpepper.jp/...
MbLargeImg	モバイル用店舗トップ写真(大）	半角英数記号(URL)	1	http://www.hotpepper.jp/...
MbSmallImg	モバイル用店舗トップ写真(小）	半角英数記号(URL)	1	http://www.hotpepper.jp/...
Open	営業時間	全角･半角	1
Close	定休日	全角･半角	1
PartyCapacity	最大宴会収容人数	全角･半角	1
Wedding	ウェディング･二次会	全角･半角	1	ご相談ください。
Course	コース	全角･半角	1	あり
FreeDrink	飲み放題	全角･半角	1	あり
FreeFood	食べ放題	全角･半角	1	あり
PrivateRoom	個室	全角･半角	1	あり
Horigotatsu	掘りごたつ	全角･半角	1	なし
Tatami	座敷	全角･半角	1	なし
Card	カード可	全角･半角	1	利用可
NonSmoking	禁煙席	全角･半角	1	一部禁煙
Charter	貸切可	全角･半角	1	貸切不可
Ktai	携帯電話OK	全角･半角	1	つながりにくい
Parking	駐車場	全角･半角	1	なし
BarrierFree	バリアフリー	全角･半角	1	なし
Sommelier	ソムリエ	全角･半角	1	いる
OpenAir	オープンエア	全角･半角	1	あり
Show	ライブ・ショー	全角･半角	1	なし
Equipment	エンタメ設備	全角･半角	1	なし
Karaoke	カラオケ	全角･半角	1	なし
Band	バンド演奏可	全角･半角	1	不可
Tv	TV・プロジェクター	全角･半角	1	なし
English	英語メニュー	全角･半角	1	あり
Pet	ペット可	全角･半角	1	可
Child	お子様連れ	全角･半角	1	お子様連れ歓迎

サンプルレスポンス †

<?xml version="1.0" encoding="utf-8"?>
<Results>
 <NumberOfResults>100</NumberOfResults>
 <DisplayPerPage>10</DisplayPerPage>
 <DisplayFrom>1</DisplayFrom>
 <APIVersion>1.11</APIVersion>
 <Shop>
   <ShopIdFront>J999999999</ShopIdFront>
   <ShopName>居酒屋ホットペッパー</ShopName>
   <ShopNameKana>いざかや　ほっとぺっぱー</ShopNameKana>
   <ShopAddress>東京都中央区銀座８－４－１７</ShopAddress>
   <StationName>銀座</StationName>
   <KtaiCoupon>0</KtaiCoupon>
   <LargeServiceAreaCD>SS10</LargeServiceAreaCD>
   <LargeServiceAreaName>関東</LargeServiceAreaName>
   <ServiceAreaCD>SA11</ServiceAreaCD>
   <ServiceAreaName>東京</ServiceAreaName>
   <LargeAreaCD>Z011</LargeAreaCD>
   <LargeAreaName>東京</LargeAreaName>
   <MiddleAreaCD>Y005</MiddleAreaCD>
   <MiddleAreaName>銀座・有楽町・新橋・築地・月島</MiddleAreaName>
   <SmallAreaCD>X010</SmallAreaCD>
   <SmallAreaName>銀座5～8丁目</SmallAreaName>
   <Latitude>35.66856701831</Latitude>
   <Longitude>139.7593331336</Longitude>
   <GenreCD>G001</GenreCD>
   <GenreName>居酒屋</GenreName>
   <FoodCD>R021</FoodCD>
   <FoodName>和風創作料理</FoodName>
   <BudgetCD>B003</BudgetCD>
   <BudgetDesc>3001～5000円</BudgetDesc>
   <BudgetAverage>3300円</BudgetAverage>
   <GenreCatch>ボンヌッフの居酒屋</GenreCatch>
   <ShopCatch>当日予約ＯＫの超人気！ＨＰ限定コース￥3000～で決まり！！</ShopCatch>
   <Capacity>28</Capacity>
   <Access>地下鉄銀座線銀座駅　徒歩5分／JR新橋駅銀座口　徒歩3分</Access>
   <KtaiAccess>銀座駅徒歩5分</KtaiAccess>
   <ShopUrl>http://www.hotpepper.jp/strJ999999999/?vos=nhppalsa000016</ShopUrl>
   <KtaiShopUrl>http://hpr.jp/s/J999999999?uid=NULLGWDOCOMO&amp;vos=hpp336</KtaiShopUrl>
   <KtaiQRUrl>http://api.hotpepper.jp/qr/?q=http%3A%2F%2Fhpr.jp%2Fs%2FJ999999999%3Fuid%3DNULLGWDOCOMO%26vos%3Dhpp337</KtaiQRUrl>
   <PictureUrl>
     <PcLargeImg>http://www.hotpepper.jp/IMG/p_top_mu.jpg</PcLargeImg>
     <PcMiddleImg>http://www.hotpepper.jp/IMG/p_top_m.jpg</PcMiddleImg>
     <PcSmallImg>http://www.hotpepper.jp/IMG/p_top_sst.jpg</PcSmallImg>
     <MbLargeImg>http://www.hotpepper.jp/IMG/m_top_l.jpg</MbLargeImg>
     <MbSmallImg>http://www.hotpepper.jp/IMG/m_top_s.jpg</MbSmallImg>
   </PictureUrl>
   <Open>月～金／11：30～14：00　　　　　18:00～翌4:00（L.O.翌3:30）　土／18:00～23:30（L.O.23:00）</Open>
   <Close>日・祝</Close>
   <PartyCapacity></PartyCapacity>
   <Wedding>ご相談ください。</Wedding>
   <Course>あり</Course>
   <FreeDrink>あり</FreeDrink>
   <FreeFood>なし</FreeFood>
   <PrivateRoom>あり</PrivateRoom>
   <Horigotatsu>なし</Horigotatsu>
   <Tatami>なし</Tatami>
   <Card>利用可</Card>
   <NonSmoking>禁煙席なし</NonSmoking>
   <Charter>貸切可</Charter>
   <Ktai>つながる</Ktai>
   <Parking>なし</Parking>
   <BarrierFree>なし</BarrierFree>
   <Sommelier>いない</Sommelier>
   <OpenAir>なし</OpenAir>
   <Show>なし</Show>
   <Equipment>なし</Equipment>
   <Karaoke>なし</Karaoke>
   <Band>不可</Band>
   <Tv>あり</Tv>
   <English>あり</English>
   <Pet>不可</Pet>
   <Child>お子様連れOK</Child>
 </Shop>
 <Shop>
     (2件目の結果)
 </Shop>
   …以下件数分繰り返し

</Results>

エラー時のハンドリング †

エラーコード †

コード	説明
400	Bad request. 渡されたパラメータがWebサービスで期待されたものと一致しない場合に返されます。このメッセージは何が間違っているか、何が正しくないかを伝えます。
403	Forbidden. リソースへのアクセスを許されていないか、利用制限を超えている場合に適用されます。
503	Service unavailable. 内部的な問題によってデータを返すことができない場合に返されます。

エラー時のレスポンス †

<?xml version="1.0" encoding="UTF-8" ?>
<Error xmlns="hapi">
 <Message>エラーメッセージ</Message>
</Error>

マスタAPI †

*1 APIキーとして、リクルートWebサービスのAPIキー[新規登録]を使用してください。従来のguestも当面の間ご使用になれます。

検索用予算マスタAPI †

リクエストURL †

http://api.hotpepper.jp/Budget/V110/?key=[APIキー]

レスポンス †

フィールド	説明	型	出現回数	例
Results			1
NumberOfResults	該当件数	半角数字	1	6
APIVersion	APIバージョン	半角数字	1	1.11
Budget			表示件数分
BudgetCD	検索用予算コード	半角英数	1	B001
BudgetDesc	検索用予算テキスト	全角･半角	1	～2000

大サービスエリアマスタAPI †

リクエストURL †

http://api.hotpepper.jp/LargeServiceArea/V110/?key=[APIキー]

レスポンス †

フィールド	説明	型	出現回数	例
Results			1
NumberOfResults	該当件数	半角数字	1	9
APIVersion	APIバージョン	半角数字	1	1.11
LargeServiceArea			表示件数分
LargeServiceAreaCD	大サービスエリアコード	半角英数	1	SS01
LargeServiceAreaName	大サービスエリア名	全角･半角	1	関東

サービスエリアマスタAPI †

リクエストURL †

http://api.hotpepper.jp/ServiceArea/V110/?key=[APIキー]

レスポンス †

フィールド	説明	型	出現回数	例
Results			1
NumberOfResults	該当件数	半角数字	1	47
APIVersion	APIバージョン	半角数字	1	1.11
ServiceArea			表示件数分
ServiceAreaCD	サービスエリアコード	半角英数	1	SA11
LargeServiceAreaCD	大サービスエリアコード	半角英数	1	SS10
ServiceAreaName	サービスエリア名	全角･半角	1	東京

大エリアマスタAPI †

リクエストURL †

http://api.hotpepper.jp/LargeArea/V110/?key=[APIキー]

検索クエリ †

パラメータ	項目名	必須	説明	値
key	APIキー	○	APIを利用するために割り当てられたキーを設定します。	リクルートWebサービスのAPIキー。*1
LargeAreaName	大エリア名		大エリア名で検索(部分一致)します。	UTF8(URLエンコード)
LargeAreaCD	大エリアコード		大エリアコードで検索(完全一致)します。（3個まで指定可）	半角英数

レスポンス †

フィールド	説明	型	出現回数	例
Results			1
NumberOfResults	該当件数	半角数字	1	47
APIVersion	APIバージョン	半角数字	1	1.11
LargeArea			表示件数分
LargeAreaCD	大エリアコード	半角英数	1	Z011
ServiceAreaCD	サービスエリアコード	半角英数	1	SA11
LargeAreaName	大エリア名	全角･半角	1	東京

中エリアマスタAPI †

リクエストURL †

http://api.hotpepper.jp/MiddleArea/V110/

検索クエリ †

パラメータ	項目名	必須	説明	値
key	APIキー	○	APIを利用するために割り当てられたキーを設定します。	リクルートWebサービスのAPIキー。*1
MiddleAreaName	中エリア名		中エリア名で検索(部分一致)します。	UTF8(URLエンコード)
MiddleAreaCD	中エリアコード		中エリアコードで検索(完全一致)します。（5個まで指定可）	半角英数
LargeAreaCD	大エリアコード		大エリアコードで検索(完全一致)します。（3個まで指定可）	半角英数

レスポンス †

フィールド	説明	型	出現回数	例
Results			1
NumberOfResults	該当件数	半角数字	1	227
APIVersion	APIバージョン	半角数字	1	1.11
MiddleArea			表示件数分
MiddleAreaCD	中エリアコード	半角英数	1	Y005
LargeAreaCD	大エリアコード	半角英数	1	Z011
MiddleAreaName	中エリア名	全角･半角	1	銀座・有楽町・新橋・築地・月島

小エリアマスタAPI †

リクエストURL †

http://api.hotpepper.jp/SmallArea/V110/

検索クエリ †

パラメータ	項目名	必須	説明	値
key	APIキー	○	APIを利用するために割り当てられたキーを設定します。	リクルートWebサービスのAPIキー。*1
SmallAreaName	小エリア名		小エリア名で検索(部分一致)します。	UTF8(URLエンコード)
SmallAreaCD	小エリアコード		小エリアコードで検索(完全一致)します。（5個まで指定可）	半角英数
MiddleAreaCD	中エリアコード		中エリアコードで検索(完全一致)します。（5個まで指定可）	半角英数

レスポンス †

フィールド	説明	型	出現回数	例
Results			1
NumberOfResults	該当件数	半角数字	1	227
APIVersion	APIバージョン	半角数字	1	1.11
SmallArea			表示件数分
SmallAreaCD	小エリアコード	半角英数	1	X005
MiddleAreaCD	中エリアコード	半角英数	1	Y005
SmallAreaName	小エリア名	全角･半角	1	銀座1～4丁目

ジャンルマスタAPI †

リクエストURL †

http://api.hotpepper.jp/Genre/V110/

検索クエリ †

パラメータ	項目名	必須	説明	値
key	APIキー	○	APIを利用するために割り当てられたキーを設定します。	リクルートWebサービスのAPIキー。*1
GenreName	ジャンル名		ジャンル名で検索(部分一致)します。	UTF8(URLエンコード)
GenreCD	ジャンルコード		ジャンルコードで検索(完全一致)します。（２個まで指定可）	半角英数

レスポンス †

フィールド	説明	型	出現回数	例
Results			1
NumberOfResults	該当件数	半角数字	1	15
APIVersion	APIバージョン	半角数字	1	1.11
Genre			表示件数分
GenreCD	ジャンルコード	半角英数	1	G001
GenreName	ジャンル名	全角･半角	1	居酒屋

料理名マスタAPI †

リクエストURL †

http://api.hotpepper.jp/Food/V110/

検索クエリ †

パラメータ	項目名	必須	説明	値
key	APIキー	○	APIを利用するために割り当てられたキーを設定します。	リクルートWebサービスのAPIキー。*1
FoodName	料理名		料理名で検索(部分一致)します。	UTF8(URLエンコード)
FoodCD	料理コード		料理コードで検索(完全一致)します。（3個まで指定可）	半角英数

レスポンス †

フィールド	説明	型	出現回数	例
Results			1
NumberOfResults	該当件数	半角数字	1	15
APIVersion	APIバージョン	半角数字	1	1.11
Food			表示件数分
FoodCD	料理名コード	半角英数	1
FoodName	料理名	全角･半角	1

店名サーチAPI †

*1 APIキーとして、リクルートWebサービスのAPIキー[新規登録]を使用してください。従来のguestも当面の間ご使用になれます。

URL †

http://api.hotpepper.jp/ShopSearch/V110/

検索クエリ †

パラメータ	項目名	必須	説明	値
key	APIキー	○	APIを利用するために割り当てられたキーを設定します。	リクルートWebサービスのAPIキー。*1
Keyword	フリーワード	いずれか必須	お店の名前・読みがな・住所で検索(部分一致)します。	UTF8(URLエンコード)
ShopTel	電話番号	いずれか必須	お店の電話番号で検索(完全一致)します。	半角数字(ハイフンなし)
Start	検索の開始位置		検索結果の何件目から出力するかを指定します。	半角数字。初期値は1
Count	1ページあたりの取得数		検索結果の最大出力データ数を指定します。	1～30までの半角数字。初期値は10

注：検索結果数が31件以上の場合はエラー「条件を絞り込んでください。」となります。

サンプルクエリ †

店名:居酒屋ホットペッパーで検索

http://api.hotpepper.jp/ShopSearch/V110/?key=guest&Keyword=%E5%B1%85%E9%85%92%E5%B1%8B%E3%83%9B%E3%83%83%E3%83%88%E3%83%9A
%E3%83%83%E3%83%91%E3%83%BC

注：↑実在しない店舗名のためサンプルクエリの結果は0件で返ります。

レスポンスフィールド †

フィールド	説明	型	出現回数	例
Results			1
NumberOfResults	該当件数	半角数字	1	20
DisplayPerPage	表示件数	半角数字	1	10
DisplayFrom	表示From	半角数字	1	1
APIVersion	APIバージョン	半角数字・記号	1	1.11
Shop			表示件数分
ShopIdFront	お店ID	半角英数	1	J999999999
ShopNameKana	掲載店名かな	全角･半角	1	いざかや　ほっとぺっぱー
ShopName	掲載店名	全角･半角	1	居酒屋ホットペッパー
ShopAddress	住所	全角･半角	1	東京都中央区銀座８－４－１７
Desc	詳細フラグ。1の場合グルメサーチAPI対象店舗	0:なし、1:あり	1	1
GenreName	お店ジャンル	全角･半角	1	居酒屋
ShopUrl	店舗URL	半角英数記号(URL)	1	http://www.hotpepper.jp/.../
KtaiShopUrl	店舗URL	半角英数記号(URL)	1	http://hpr.jp/...

サンプルレスポンス †

<?xml version="1.0" encoding="utf-8"?>
<Results>
	<NumberOfResults>100</NumberOfResults>
	<DisplayPerPage>10</DisplayPerPage>
	<DisplayFrom>1</DisplayFrom>
	<APIVersion>1.11<APIVersion>
	<Shop>
		<ShopIdFront>J999999999</ShopIdFront>
		<ShopNameKana>いざかや　ほっとぺっぱー</ShopNameKana>
		<ShopName>居酒屋 ホットペッパー</ShopName>
		<ShopAddress>東京都中央区銀座８－４－１７</ShopAddress>
		<Desc>1</Desc>
		<GenreName>居酒屋</GenreName>
		<ShopUrl>http://www.hotpepper.jp/strJ999999999/</ShopUrl>
		<KtaiShopUrl>http://hpr.jp/s/J999999999?vos=</KtaiShopUrl>
	</Shop>
	<Shop>
	 	(2件目の結果)
	</Shop>
	…以下件数分繰り返し
</Results>