グルメサーチAPI ベータ版（旧ver1.0）
- *1 APIキーとして、リクルートWebサービスのAPIキー[新規登録]を使用してください。従来のguestも当面の間ご使用になれます。
■リクエストURL
http://api.hotpepper.jp/GourmetSearch/V1/
■リクエストパラメータ
| パラメーター |
項目名 |
必須 |
説明 |
値 |
| key |
APIキー |
○ |
APIを利用するために割り当てられたキーを設定します。 |
リクルートWebサービスのAPIキー。*1 |
| ShopIdFront |
お店ID |
店舗指定検索を行う場合、いずれか必須 |
お店に割り当てられた番号で検索します。 |
「J」+半角数字 |
| ShopNameKana |
掲載店名かな |
お店の読みかなで検索(部分一致)します。 |
UTF8ひらがな |
| ShopName |
掲載店名 |
お店の名前で検索(部分一致)します。 |
UTF8 |
| ShopTel |
電話番号 |
お店の電話番号で検索(完全一致)します。 |
半角数字(ハイフンなし) |
| ShopAddress |
住所 |
お店の住所で検索(部分一致)します。 |
UTF8 |
| KtaiCoupon |
携帯クーポン拒否 |
|
携帯クーポンの有無で絞り込み条件を指定します。 |
1：携帯クーポンなし、０：携帯クーポンがある、指定なし：絞り込みなし |
| LargeServiceAreaCD |
大サービスエリアCD |
エリア検索を行う場合いずれか必須 |
エリアに割り当てられた番号で検索します。 |
エリアコード対応表参照 |
| ServiceAreaCD |
サービスエリアCD |
エリアコード対応表参照 |
| LargeAreaCD |
大エリアCD |
エリアコード対応表参照 |
| MiddleAreaCD |
中エリアCD |
エリアコード対応表参照 |
| SmallAreaCD |
小エリアCD |
エリアコード対応表参照 |
| Keyword |
フリーワード |
フリーワード検索 |
店名かな、店名、住所、お店ジャンルキャッチ、キャッチに対してフリーワード検索(部分一致)します。 |
UTF8 |
| GenreCD |
お店ジャンルCD |
|
お店のジャンルで絞込み条件を指定します。 |
ジャンルコード対応表参照 |
| Order |
ソート順（名前(かな順）、ジャンルコード順、小エリアコード順 |
|
検索結果の並び順を指定します。おススメ順は定期的に更新されます。 |
1:店名かな順、2:ジャンルコード順、3:小エリアコード順、4:おススメ順。初期値はおススメ順。 |
| Start |
検索の開始位置（何件目か？） |
|
検索結果の何件目から出力するかを指定します。 |
半角数字。初期値1 |
| Count |
1ページあたりの取得数 |
|
検索結果の最大出力データ数を指定します。 |
1～100までの半角数字。初期値10 |
■サンプルクエリ
店名:居酒屋ホットペッパーで検索(結果は小エリアコード順)
http://api.hotpepper.jp/GourmetSearch/V1/?key=[APIキー*1]&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
■レスポンスフィールド
| フィールド |
説明 |
型 |
出現回数 |
例 |
| Results |
|
|
1 |
|
| NumberOfResults |
該当件数 |
半角数字 |
1 |
100 |
| DisplayPerPage |
表示件数 |
半角数字 |
1 |
10 |
| DisplayFrom |
表示From |
半角数字 |
1 |
1 |
| APIVersion |
APIバージョン |
半角数字・記号 |
1 |
1.0 |
| Shop |
|
|
表示件数分 |
|
| ShopIdFront |
お店ID |
半角英数 |
1 |
J000000001 |
| ShopNameKana |
掲載店名かな |
全角･半角 |
1 |
いざかや ほっとぺっぱー |
| ShopName |
掲載店名 |
全角･半角 |
1 |
居酒屋 ホットペッパー |
| ShopAddress |
住所 |
全角･半角 |
1 |
東京都中央区銀座1-15-7 マック銀座ビル1F |
| StationName |
最寄駅名 |
全角･半角 |
1 |
銀座 |
| KtaiCoupon |
ケータイ用クーポン掲載拒否 |
0:掲載OK、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 |
X005 |
| SmallAreaName |
小エリア名 |
全角･半角 |
1 |
銀座1?4丁目 |
| GenreCD |
お店ジャンルCD |
半角英数 |
1 |
G001 |
| GenreName |
お店ジャンル |
全角･半角 |
1 |
居酒屋 |
| GenreCatch |
お店ジャンルキャッチ |
全角･半角 |
1 |
一口餃子専門店 |
| ShopCatch |
お店キャッチ |
全角･半角 |
1 |
TVの口コミランキングで堂々1位に輝いた一口餃子専門店！！ |
| BudgetDesc |
検索用予算 |
全角･半角 |
1 |
～1000 |
| 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/qr/... |
| 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/... |
■サンプルレスポンス
<?xml version="1.0" encoding="utf-8"?>
<Results xmlns="hapi">
<NumberOfResults>100</NumberOfResults>
<DisplayPerPage>10</DisplayPerPage>
<DisplayFrom>1</DisplayFrom>
<APIVersion>1.0</APIVersion>
<Shop>
<ShopIdFront>J000000001</ShopIdFront>
<ShopNameKana>いざかや ほっとぺっぱー</ShopNameKana>
<ShopName>居酒屋 ホットペッパー</ShopName>
<ShopAddress>東京都中央区銀座1-15-7 マック銀座ビル1F</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>X005</SmallAreaCD>
<SmallAreaName>銀座1 04丁目</SmallAreaName>
<GenreCD>G001</GenreCD>
<GenreName>居酒屋</GenreName>
<GenreCatch>一口餃子専門店</GenreCatch>
<ShopCatch>TVの口コミランキングで堂々1位に輝いた一口餃子専門店！！</ShopCatch>
<BudgetDesc>2000-3000</BudgetDesc>
<Capacity>185席(100人以上OKです)</Capacity>
<Access>銀座駅A2出口でて､みゆき通り右折､徒歩1分</Access>
<KtaiAccess>銀座一丁目駅10番出口徒歩3分</KtaiAccess>
<ShopUrl>http://www.hotpepper.jp/strJ000000001/?vos=nhppalsa000016</ShopUrl>
<KtaiShopUrl>http://hpr.jp/s/J000000001?vos=</KtaiShopUrl>
<KtaiQRUrl>http://api.hotpepper.jp/qr/?q=http%3A%2F%2Fhpr.jp%2Fs%2FJ000635962%3FUID%3DNULLGWDOCOMO%26vos%3Dhpp337</KtaiQRUrl>
<PictureUrl>
<PcLargeImg>http://www.hotpepper.jp/IMG/100.jpg</PcLargeImg>
<PcMiddleImg>http://www.hotpepper.jp/IMG/200.jpg</PcMiddleImg>
<PcSmallImg>http://www.hotpepper.jp/IMG/300.jpg</PcSmallImg>
<MbLargeImg>http://www.hotpepper.jp/IMG/400.jpg</MbLargeImg>
<MbSmallImg>http://www.hotpepper.jp/IMG/500.jpg</MbSmallImg>
</PictureUrl>
</Shop>
</Results>
■エラーコード
返される可能性のあるHTTPエラーコードは以下のとおりです。
| コード |
説明 |
|---|
| 400 |
Bad request. 渡されたパラメータがWebサービスで期待されたものと一致しない場合に返されます。このメッセージは何が間違っているか、何が正しくないかを伝えます。
|
| 403 |
Forbidden. リソースへのアクセスを許されていないか、利用制限を超えている場合に適用されます。
|
| 503 |
Webサービス内で問題が発生している場合に返されます。
|
■エラー時のレスポンス
各エラーにおいて、次の形式のXMLレスポンスを受け取ります。
<?xml version="1.0" encoding="UTF-8"?>
<Error xmlns="hapi">
<Message>API キーが見つかりません</Message>
</Error>
マスタ系API（旧ver1.0）
- *1 APIキーとして、リクルートWebサービスのAPIキー[新規登録]を使用してください。従来のguestも当面の間ご使用になれます。
■大サービスエリア
リクエストURL
- http://api.hotpepper.jp/LargeServiceArea/V1/?key=[APIキー*1]
レスポンス
| フィールド |
説明 |
型 |
出現回数 |
例 |
|---|
| Results |
| | 1 | | | NumberOfResults | 該当件数 | 半角数字 | 1 | 9 | | LargeServiceArea | | | 表示件数分 | | | LargeServiceAreaCD | 大サービスエリアコード | 半角英数 | 1 | SS01 | | LargeServiceAreaName | 大サービスエリア名 | 全角･半角 | 1 | 関東 |
■サービスエリア
リクエストURL
- http://api.hotpepper.jp/ServiceArea/V1/?key=[APIキー*1]
レスポンス
| フィールド |
説明 |
型 |
出現回数 |
例 |
|---|
| Results | | | 1 | | | NumberOfResults | 該当件数 | 半角数字 | 1 | 47 | | ServiceArea | | | 表示件数分 | | | ServiceAreaCD | サービスエリアコード | 半角英数 | 1 | SA11 | | LargeServiceAreaCD | 大サービスエリアコード | 半角英数 | 1 | SS10 | | ServiceAreaName | サービスエリア名 | 全角･半角 | 1 | 東京 |
■大エリア
リクエストURL
- http://api.hotpepper.jp/LargeArea/V1/?key=[APIキー*1]
レスポンス
| フィールド |
説明 |
型 |
出現回数 |
例 |
|---|
| Results | | | 1 | | | NumberOfResults | 該当件数 | 半角数字 | 1 | 47 | | LargeArea | | | 表示件数分 | | | LargeAreaCD | 大エリアコード | 半角英数 | 1 | Z011 | | ServiceAreaCD | サービスエリアコード | 半角英数 | 1 | SA11 | | LargeAreaName | 大エリア名 | 全角･半角 | 1 | 東京 |
■中エリア
リクエストURL
- http://api.hotpepper.jp/MiddleArea/V1/?key=[APIキー*1]
レスポンス
| フィールド |
説明 |
型 |
出現回数 |
例 |
|---|
| Results | | | 1 | | | NumberOfResults | 該当件数 | 半角数字 | 1 | 227 | | MiddleArea | | | 表示件数分 | | | MiddleAreaCD | 中エリアコード | 半角英数 | 1 | Y005 | | LargeAreaCD | 大エリアコード | 半角英数 | 1 | Z011 | | MiddleAreaName | 中エリア名 | 全角･半角 | 1 | 銀座・有楽町・新橋・築地・月島 |
■小エリア
リクエストURL
- http://api.hotpepper.jp/SmallArea/V1/?key=[APIキー*1]
レスポンス
| フィールド |
説明 |
型 |
出現回数 |
例 |
|---|
| Results | | | 1 | | | NumberOfResults | 該当件数 | 半角数字 | 1 | 227 | | SmallArea | | | 表示件数分 | | | SmallAreaCD | 小エリアコード | 半角英数 | 1 | X005 | | MiddleAreaCD | 中エリアコード | 半角英数 | 1 | Y005 | | SmallAreaName | 小エリア名 | 全角･半角 | 1 | 銀座1 04丁目 |
■お店ジャンル
リクエストURL
- http://api.hotpepper.jp/Genre/V1/?key=[APIキー*1]
レスポンス
| フィールド |
説明 |
型 |
出現回数 |
例 |
|---|
| Results | | | 1 | | | NumberOfResults | 該当件数 | 半角数字 | 1 | 15 | | Genre | | | 表示件数分 | | | GenreCD | ジャンルコード | 半角英数 | 1 | G001 | | GenreName | ジャンル名 | 全角･半角 | 1 | 居酒屋 |
■予算
リクエストURL
- http://api.hotpepper.jp/Budget/V1/?key=[APIキー*1]
レスポンス
| フィールド |
説明 |
型 |
出現回数 |
例 |
| Results |
| | 1 | | | NumberOfResults |
該当件数 | 半角数字 | 1 | 6 | | Budget |
| | 表示件数分 | | | BudgetCD |
検索用予算コード | 半角英数 | 1 | B001 | | BudgetDesc |
検索用予算テキスト | 全角･半角 | 1 | ～2000 |
| 
