退会申請
ホットペッパー リファレンス (アライアンス用)


ref

refグルメサーチAPI - 拡張版

一般公開している通常のグルメサーチAPIに、アライアンス専用の検索クエリおよびレスポンスフィールドを追加した拡張版のAPIです。

リクエストURL

ページトップへ

検索クエリ

下記の項目の拡張パラメータが利用できます。

パラメータ 項目名 説明 必須 値
keyword_menu キーワード（料理メニュー） 料理メニュー（ランチ、ドリンク含）のフリーワード検索(部分一致)が可能です。文字コードはUTF8。半角スペース区切りの文字列を渡すことでAND検索になる。複数指定可能*2 *1  
special 特集 特集コードをANDで絞り込みができます。複数指定可能
特集コードは特集マスタAPI参照
*このパラメータは一般公開版でも、利用可能です。 		*1 LT0086
special_or 特集 特集コードをORで絞り込みができます。
特集コードは特集マスタAPI参照。
複数指定可能*2
*このパラメータは一般公開版でも、利用可能です。 		*1 LT0086,LT0045
special_category 特集カテゴリ 特集カテゴリコードをANDで絞り込みができます。複数指定可能
特集カテゴリコードは特集カテゴリマスタAPI参照
*このパラメータは一般公開版でも、利用可能です。 		  SPD1
special_category_or 特集カテゴリ 特集カテゴリコードをORで絞り込みができます。
特集カテゴリコードは特集カテゴリマスタAPI参照。
複数指定可能*2
*このパラメータは一般公開版でも、利用可能です。 		  SPD1,SPD3
updated 最終更新日時 指定された日時以降に更新された情報を取得できます。
指定フォーマット：YYYY/MM/DD HH:MI:SS
例："2010/01/01 19:23:01" (URLエンコードしてください) 		*1 2010/01/01 19:23:01
hcd お店ID(2) Hから始まるお店IDです。複数指定可能 *1 H000000000
brand_store チェーン店コード チェーン店コードで絞り込みます   gstr00909
type 出力タイプ レスポンス項目の項目数を指定できます。
指定なし:基本全項目＋アライアンス基本拡張＋クーポン
lite:基本主要項目+アライアンス基本拡張＋クーポン
credit_card,special,hp_course,caption:それぞれ、基本全項目＋アライアンス基本拡張に加えて、 クレジットカード、特集、コース内容、キャプション、お店付加情報をレスポンスします。 「+」で接続して複数指定も可能です。ただし、クーポンがレスポンスされなくなるので、ク ーポンが必要なときはcouponをパラメターとして加えてください。
例：全項目をレスポンスしたい -- type=coupon+credit_card+special+hp_course+caption+shop_add_info 		  lite:基本主要項目のみ
coupon:クーポン追加
credit_card:クレジットカード追加
special:特集追加
menu:メニュー追加
hp_course:コース追加
caption:キャプション追加
shop_add_info:お店付加情報追加
vos pc用vosコード PC用のvosコードを指定します。レスポンスのurls/pcに付与されます。指定しない場合はデフォルトのvosコードとなります  
vosm モバイル用vosコード モバイル用のvosコードを指定します。レスポンスのurls/mobileに付与されます。指定しない場合はデフォルトのvosコードとなります  
*1 通常のグルメサーチAPIにて*1が指定されている項目とあわせて、最低一つが必要となっています。
ページトップへ

サンプルクエリ

大エリアコード=Z011(東京)のお店を検索

http://webservice.recruit.co.jp/hotpepper/gourmet/v1/alliance?key=[APIキー]&large_area=Z011

■地点を指定して、その範囲にあるお店をオススメ順に取得

http://webservice.recruit.co.jp/hotpepper/gourmet/v1/alliance?key=[APIキー]&lat=34.67&lng=135.52&range=5&order=4

※実際にご利用いただくにはAPIキーをご連絡いただき、アライアンス版の利用登録していただく必要があります。アライアンス版として登録されていないAPIキーで呼び出した場合は、エラーになります

ページトップへ

レスポンスフィールド - 基本(一般公開対象)

フィールド 説明 例 lite*1
results     ○
api_version APIのバージョン 1.20 ○
results_available クエリー条件にマッチする、検索結果の全件数 47 ○
results_returned このＸＭＬに含まれる検索結果の件数 47 ○
results_start 検索結果の開始位置 1 ○
shop [複数要素]   ○
id お店ID J999999999 ○
name 掲載店名 居酒屋 ホットペッパー ○
logo_image ロゴ画像 URL -
name_kana 掲載店名かな いざかや　ほっとぺっぱー -
address 住所 東京都中央区銀座８－４－１７ ○
station_name 最寄駅名 銀座 -
ktai_coupon 携帯用クーポン掲載
0:あり、1:なし		 0 -
large_service_area 大サービスエリア   -
code 大サービスエリアコード SS10 -
name 大サービスエリア名 関東 -
service_area サービスエリア   -
code サービスエリアコード SA11 -
name サービスエリア名 東京 -
large_area 大エリア   -
code 大エリアコード Z011 -
name 大エリア名 東京 -
middle_area 中エリア   -
code 中エリアコード Y005 -
name 中エリア名 銀座・有楽町・新橋・築地・月島 -
small_area 小エリア   -
code 小エリアCD X010 -
name 小エリア名 銀座5～8丁目 -
lat 緯度（測地系は検索時に指定したもの） 35.6608183454 ○
lng 経度（測地系は検索時に指定したもの） 139.7754267645 ○
genre お店ジャンル   ○
code お店ジャンルコード G001 -
name お店ジャンル名 居酒屋 ○
catch お店ジャンルキャッチ 一口餃子専門店 ○
sub_genre お店サブジャンル マスタはジャンルと同じです。 -
code お店サブジャンルコード G001 -
name お店サブジャンル名 居酒屋 -
food 料理   ○
code 料理名コード R021 -
name 料理名 和風創作料理 ○
budget ディナー予算   -
code 検索用ディナー予算コード B001 -
name 検索用ディナー予算 ～1000 -
average 平均ディナー予算 「900円」「フリー2500円　宴会3500円」など -
catch お店キャッチ TVの口コミランキングで堂々1位に輝いた一口餃子専門店！！ ○
capacity 総席数 300 -
access 交通アクセス 銀座駅A2出口でて､みゆき通り右折､徒歩1分 ○
mobile_access 携帯用交通アクセス 銀座一丁目駅10番出口徒歩3分 -
urls 店舗URL   ○
pc PC向けURL   ○
photo 写真   ○
pc PC向け   ○
l 店舗トップ写真(大）画像URL   ○
m 店舗トップ写真(中）画像URL   ○
s 店舗トップ写真(小）画像URL   ○
mobile 携帯向け   -
l 店舗トップ写真(大）画像URL   -
s 店舗トップ写真(小）画像URL   -
open 営業時間 月～金／11：30～14：00 -
close 定休日 日 -
party_capacity 最大宴会収容人数 185 -
wifi WiFi 有無 あり、なし、未確認 のいずれか -
wifi_hikari_station 光ステーション有無 あり -
wedding ウェディング･二次会 応相談 -
course コース あり -
free_drink 飲み放題 あり -
free_food 食べ放題 あり -
private_room 個室 あり -
horigotatsu 掘りごたつ なし -
tatami 座敷 なし -
card カード可 利用可 -
non_smoking 禁煙席 一部禁煙 -
charter 貸切可 貸切不可 -
ktai 携帯電話OK つながりにくい -
parking 駐車場 なし -
barrier_free バリアフリー なし -
sommelier ソムリエ いる -
open_air オープンエア あり -
show ライブ・ショー なし -
equipment エンタメ設備 なし -
karaoke カラオケ なし -
band バンド演奏可 不可 -
tv TV・プロジェクター なし -
english 英語メニュー あり -
pet ペット可 可 -
child お子様連れ お子様連れ歓迎 -
*1 ○印がついている項目のみが、type=liteを指定したときに出力される。

レスポンスフィールド - アライアンス基本拡張(アライアンス版限定)

一般公開している基本のレスポンスにアライアンス版では以下のフィールドが追加されます。アライアンス基本拡張のフィールドはcaptionを除きtype指定に関わらず、常にレスポンスされます

フィールド 説明 例
photo 写真
caption 写真 キャプション - type=captionが含まれるときのみレスポンスされます　 料理の味には自信あります...
gallery ギャラリー写真[複数要素]
caption ギャラリー写真 キャプション - type=captionが含まれるときのみレスポンスされます　 広い店内は開放的です...
l ギャラリー写真(大）画像URL http://www.../88580_640.jpg
s ギャラリー写真(小）画像URL http://www.../88534_150.jpg
reserve_urls 店舗予約URL-お店の予約ページへのリンク。
pc PC向けURL  
tel 電話番号 123-123-1234
hcd お店ID(2) H00000000000
long_name 店名（正式名称） カフェ　MTL 銀座店
updated 最終更新日時 2010/01/13 18:23:15
plan_paid 優先プランフラグ 0:False 1:True 1


レスポンスフィールド - クーポン(アライアンス版限定)

type指定が存在しない、またはtype=full、またはtype指定にcouponが含まれるときに、レスポンスされます。
例1: type=full -- 基本主要項目＋アライアンス基本拡張＋クーポン
例2: type=coupon+credit_card -- 基本全項目＋アライアンス基本拡張＋クーポン＋クレジットカード
例3: type指定なし -- 基本全項目＋アライアンス基本拡張＋クーポン
クーポンが出力されない例: type=credit_card -- 基本全項目＋アライアンス基本拡張＋クレジットカード

フィールド 説明 例
coupon クーポン[複数要素]  
no クーポンNO h01
coupon_sbt クーポン種別  
code クーポン種別コード t08
name クーポン種別名 宴会・パーティ系
mobile_priority ケータイ優先表示 1:優先 0:非優先 1
show 提示条件 当日限定！予約電話時＆入店時持参
condition 利用条件 1組1枚／前日迄の予約不可／他券併用不可
date 有効期限  
from 有効期間開始日 2009-03-01
to 有効期限(最終日) 2009-03-31
description 概要 【毎日使える♪】 お会計より500円オフ！
coupon_urls クーポンURL  
pc PC向けURL  
sp スマートフォン向けURL  


レスポンスフィールド - クレジットカード(一般公開対象)

type指定にcredit_cardが含まれるときに、レスポンスされます。 例: type=credit_card

フィールド 説明 例
credit_card クレジットカード[複数要素]
code クレジットカードコード c99
name クレジットカード名 ○○カード


レスポンスフィールド - コース(アライアンス版限定)

type指定にhp_courseが含まれるときに、レスポンスされます。 のマークのある、クーポンが必要なコースのみレスポンスされます
例: type=credit_card+hp_course+coupon

フィールド 説明 例
hp_course コース[複数要素]
name コース名 【飲み放題付】ちゃんこ鍋コース
capacity 人数
max 最大人数 10
mix 最小人数 3
free_drink 飲み放題
catchcopy キャッチコピー 飲み放題60種
drink 飲み物[複数要素]
name 名称 ビール
detail 詳細 生ビール、瓶ビール、ローアルコールビール
catchcopy キャッチコピー 飲み放題付きでこの価格！
coupon_flag クーポンフラグ　1:要クーポン , 0:クーポン不要 1
description 概要 ■前日までに要予約
free_drink_flag 飲み放題の有無　1:あり 0:なし 1
price 価格（円） 5500
menu コースメニュー
count 品数(品) 9
description コースメニュー概要 ベーコンとホウレン草の鉄板グラタン ・胡瓜1本漬け


レスポンスフィールド - 特集(一般公開対象)

type指定にspecialが含まれるときに、レスポンスされます。 例: type=special+credit_card

フィールド 説明 例
special 特集[複数要素]
code 特集コード LV0069
name 特集名 家族でがっつり焼肉を食べよう♪
special_category 特集カテゴリ
code 特集カテゴリコード SPC0
name 特集カテゴリ名 宴会で盛り上がろう！
title タイトル 個室風テーブル席で食べ飲み放題
photo 写真
l URL(大)
m URL(中)
s URL(小)


レスポンスフィールド - メニュー(アライアンス限定)

type指定にmenuが含まれるときに、レスポンスされます。 例: type=special+credit_card+menu

フィールド 説明 例
menu_group メニューグループ[複数要素]
name メニューグループ名 とりあえずの一品
menu メニュー[複数要素]
name メニュー名 キムチ
price 価格 360円
mark メニューマーク 定番
catch_copy メニューキャッチコピー ふぐ料理の代表。自家製ポン酢でサッパリ…この旨さは季節不問。
menu_memo メニュー備考 ◆メニュー内容が変更の場合がございます◆季節メニューございます◆表記の金額は税込み価格となっております。
drink_menu_group ドリンクメニューグループ[複数要素]
name ドリンクメニューグループ名 とりあえずの一品
drink_menu ドリンクメニュー[複数要素]
name ドリンクメニュー名 日本酒
price 価格 360円
mark ドリンクマーク 定番
catch_copy ドリンクメニューキャッチコピー この旨さは季節不問。
drink_menu_memo ドリンクメニュー備考 ◆表記の金額は税込み価格となっております。
lunch_menu_group ランチメニューグループ[複数要素]
name ランチメニューグループ名 おまかせらんち
lunch_menu ランチメニュー[複数要素]
name ランチメニュー名 かもめランチ
price 価格 760円
mark ランチマーク
catch_copy ランチメニューキャッチコピー ご飯・汁物付き
lunch_menu_memo ランチメニュー備考 ◆表記の金額は税込み価格となっております。


レスポンスフィールド - お店付加情報(アライアンス限定)

type指定にshop_add_infoが含まれるときに、レスポンスされます。 例: type=shop_add_info+credit_card

フィールド 説明 例
shop_add_info お店付加情報[複数要素]
interior_choosy 店内のこだわり[複数要素]
title 店内こだわりタイトル Wedding party
caption 店内こだわり写真キャッチ パーティーの事なら何でもOK!
photo 店内こだわり写真
l URL(大)
m URL(中)
s URL(小)
atmosphere 雰囲気[複数要素]
attribute_icon 属性アイコン[複数要素] a01
catch_copy キャッチコピー 最大56名様までの個室宴会が可能。
photo 雰囲気写真
l URL(大)
s URL(小)
service_choosy サービスのこだわり[複数要素]
title サービスこだわりタイトル ＶＩＰ個室
caption サービスこだわり写真キャッチ 風情ある庭付き個室をご用意しました
photo サービスこだわり写真
l URL(大)
m URL(中)
s URL(小)
seat 席[複数要素]
type 席タイプ カウンター
caption 席写真キャプション ゆったりソファー席
capacity 席数 1
room 部屋数 6
photo 席写真
l URL(大)
m URL(中)
s URL(小)
facilities 設備[複数要素]
caption 設備キャプション 二次会にどうぞ！
photo 設備写真
l URL(大)
m URL(中)
s URL(小)
private_catchword プライベート[複数要素]
catchword プライベートキャッチワード ホールケーキ特典
caption プライベートキャッチワード写真キャッチ 記念日にぴったり！
photo プライベートキャッチワード写真
l URL(大)
m URL(中)
s URL(小)
party_catchword 宴会[複数要素]
catchword パーティー宴会キャッチワード ホールケーキ特典
caption パーティー宴会キャッチワード写真キャッチ 記念日にぴったり！
photo パーティー宴会キャッチワード写真
l URL(大)
m URL(中)
s URL(小)
food_choosy 料理こだわり[複数要素]
title 料理こだわりタイトル 本日の旬鮮魚
catch 料理こだわり写真キャッチ 毎日入荷の旬鮮魚
photo 料理こだわり写真
l URL(大)
m URL(中)
s URL(小)
first_menu おすすめメニュー[複数要素]
name おすすめメニュー名 石焼仕上げ　特選牛カルビ
price おすすめメニュー価格 893円
catch_copy おすすめメニューキャッチコピー 口の中でとろけるまぐろは一度食べたらやみつきになります
photo おすすめメニュー写真
l URL(大)
s URL(小)


ref駅マスタAPI

リクエストURL

ページトップへ

検索クエリ

パラメータ 項目名 説明 必須 値
key APIキー APIを利用するために割り当てられたキーを設定します。 ○
station 駅コード 駅コードで検索します。複数指定可能*2 3744398
along 沿線コード 沿線コードで検索します。複数指定可能*2 100200
service_area サービスエリアコード サービスエリアコードで検索します。複数指定可能*2 SA11
along_kbn 沿線区分 沿線区分で検索します。1:JR,2:地下鉄,3:私鉄 複数指定可能*2 1
keyword キーワード 駅名をフリーワードで検索。文字コードはUTF8。半角スペース区切りの文字列を渡すことでOR検索になる。複数指定可能*2  
lat 緯度 ある地点からの範囲内の駅の検索を行う場合の緯度です。 (例) 35.669220
lng 経度 ある地点からの範囲内の駅の検索を行う場合の経度です。 (例) 139.761457
range 検索範囲 ある地点からの範囲内の駅の検索を行う場合の範囲を5段階で指定できます。たとえば300m以内の検索ならrange=1を指定します 1: 300m
2: 500m
3: 1000m (初期値)
4: 2000m
5: 3000m
(例) 1
datum 測地系 緯度・経度の測地系を指定できます。world: 世界測地系、tokyo: 旧日本測地系。初期値は world。   (例) world
start 検索の開始位置 検索結果の何件目から出力するかを指定します。   初期値:1
count 1ページあたりの取得数 検索結果の最大出力データ数を指定します。   初期値：10、最小1、最大100
format レスポンス形式 レスポンスをXMLかJSONを指定します。   初期値:xml。xml または json。
*2 複数指定可能パラメータの指定方法
name=value1&name=value2&...または name=value1,value2,...

ページトップへ

サンプルクエリ

駅マスタを検索

http://webservice.recruit.co.jp/hotpepper/station/v1/alliance?key=[APIキー]
ページトップへ

レスポンスフィールド

フィールド 説明 例
results    
api_version APIのバージョン 1.20
results_available クエリー条件にマッチする、検索結果の全件数 5
results_returned このＸＭＬに含まれる検索結果の件数 5
results_start 検索結果の開始位置 1
station [複数要素]
code 駅コード 10020000
name 駅名 東京
lat 緯度（測地系は検索時に指定したもの） 35.6608183454
lng 経度（測地系は検索時に指定したもの） 139.7754267645
service_area サービスエリア情報
code サービスエリアコード SA11
name サービスエリア名 東京
middle_area 中エリア情報
code 中エリアコード Y050
name 中エリア名 池袋
along 沿線[複数要素]　
code 沿線コード 100200
name 沿線名 東海道線
along_kbn 沿線区分 1:JR,2:地下鉄,3:私鉄 1
ページトップへ