レストラン検索API

URL：https://api.gnavi.co.jp/RestSearchAPI/v3/

リクエストパラメータ

※リクエストパラメータがkeyidのみの場合は、パラメータ不足のため、エラーとして値が返ります。

パラメータ名 必須 型 説明 備考
keyid ○ string アクセスキー ぐるなびより提供されたアクセスキー
id   string 店舗ID 「,」区切りで店舗IDを複数検索可能（１０個まで）
name   string 店舗名 UTF-8でURLエンコードすること
name_kana   string 店舗名読み カタカナで指定
UTF-8でURLエンコードすること
tel   string 電話番号 ハイフン必須
address   string 住所 （都道府県＋市町村＋番地）の文字列をUTF-8でURLエンコードすること
area   string 地方コード コードはエリアマスタ取得APIより取得
pref   string 都道府県コード コードは都道府県マスタ取得APIより取得
areacode_l   string エリアLコード コードはエリアLマスタ取得APIより取得
areacode_m   string エリアMコード コードはエリアMマスタ取得APIより取得
areacode_s   string エリアSコード コードはエリアSマスタ取得APIより取得
category_l   string 大業態コード コードは大業態マスタ取得APIより取得
「,」区切りで複数ワードが検索可能 (10個まで)
category_s   string 小業態コード コードは小業態マスタ取得APIより取得
「,」区切りで複数ワードが検索可能 (10個まで)
input_coordinates_mode   integer 入力測地系タイプ 入力する緯度/経度の測地系のタイプを指定
1:日本測地系
2:世界測地系（デフォルト:世界測地系）
coordinates_mode   integer 測地系タイプ レスポンスに含まれる緯度/経度の測地系を指定
1:日本測地系
2:世界測地系（デフォルト:世界測地系）
latitude   number 緯度 分秒十進式
input_coordinates_mode(入力測地系タイプ）の選択したタイプの値で指定
longitude   number 経度 分秒十進式
input_coordinates_mode(入力測地系タイプ）の選択したタイプの値で指定
range   integer 範囲 緯度/経度からの検索範囲(半径)
1:300m、2:500m、3:1000m、4:2000m、5:3000m
（デフォルト:500m）
sort   integer ソート順 レスポンスデータのソート順
指定なし：ぐるなびソート順
1:店舗名、2:業態
offset   integer 検索開始位置 検索開始レコードの位置（デフォルト:1）
hit_per_page   integer ヒット件数 一度リクエストで得るレスポンスデータの最大件数（デフォルト:10、上限:100）
offset_page   integer 検索開始ページ 検索開始ページ位置（デフォルト:1）
freeword   string フリーワード検索 検索ワードをUTF-8でURLエンコードすること「,」区切りで複数ワードが検索可能（１０個まで）
freeword_condition   integer フリーワード検索条件タイプ フリーワード検索の条件を指定
1:AND検索、2:OR検索（デフォルト:AND検索）
lunch   integer ランチ営業あり 0:絞込みなし(デフォルト)、1：絞込みあり
no_smoking   integer 禁煙席あり 0:絞込みなし(デフォルト)、1：絞込みあり
card   integer カード利用可 0:絞込みなし(デフォルト)、1：絞込みあり
mobilephone   integer 携帯の電波が入る 0:絞込みなし(デフォルト)、1：絞込みあり
bottomless_cup   integer 飲み放題あり 0:絞込みなし(デフォルト)、1：絞込みあり
sunday_open   integer 日曜営業あり 0:絞込みなし(デフォルト)、1：絞込みあり
takeout   integer テイクアウトあり 0:絞込みなし(デフォルト)、1：絞込みあり
private_room   integer 個室あり 0:絞込みなし(デフォルト)、1：絞込みあり
midnight   integer 深夜営業あり 0:絞込みなし(デフォルト)、1：絞込みあり
parking   integer 駐車場あり 0:絞込みなし(デフォルト)、1：絞込みあり
memorial_service   integer 法事利用可 0:絞込みなし(デフォルト)、1：絞込みあり
birthday_privilege   integer 誕生日特典あり 0:絞込みなし(デフォルト)、1：絞込みあり
betrothal_present   integer 結納利用可 0:絞込みなし(デフォルト)、1：絞込みあり
kids_menu   integer キッズメニューあり 0:絞込みなし(デフォルト)、1：絞込みあり
outret   integer 電源あり 0:絞込みなし(デフォルト)、1：絞込みあり
wifi   integer wifiあり 0:絞込みなし(デフォルト)、1：絞込みあり
microphone   integer マイクあり 0:絞込みなし(デフォルト)、1：絞込みあり
buffet   integer 食べ放題あり 0:絞込みなし(デフォルト)、1：絞込みあり
late_lunch   integer 14時以降のランチあり 0:絞込みなし(デフォルト)、1：絞込みあり
sports   integer スポーツ観戦可 0:絞込みなし(デフォルト)、1：絞込みあり
until_morning   integer 朝まで営業あり 0:絞込みなし(デフォルト)、1：絞込みあり
lunch_desert   integer ランチデザートあり 0:絞込みなし(デフォルト)、1：絞込みあり
projecter_screen   integer プロジェクター・スクリーンあり 0:絞込みなし(デフォルト)、1：絞込みあり
with_pet   integer ペット同伴可 0:絞込みなし(デフォルト)、1：絞込みあり
deliverly   integer デリバリーあり 0:絞込みなし(デフォルト)、1：絞込みあり
special_holiday_lunch   integer 土日特別ランチあり 0:絞込みなし(デフォルト)、1：絞込みあり
e_money   integer 電子マネー利用可 0:絞込みなし(デフォルト)、1：絞込みあり
caterling   integer ケータリングあり 0:絞込みなし(デフォルト)、1：絞込みあり
breakfast   integer モーニング・朝ごはんあり 0:絞込みなし(デフォルト)、1：絞込みあり
desert_buffet   integer デザートビュッフェあり 0:絞込みなし(デフォルト)、1：絞込みあり
lunch_buffet   integer ランチビュッフェあり 0:絞込みなし(デフォルト)、1：絞込みあり
bento   integer お弁当あり 0:絞込みなし(デフォルト)、1：絞込みあり
lunch_salad_buffet   integer ランチサラダバーあり 0:絞込みなし(デフォルト)、1：絞込みあり
darts   integer ダーツあり 0:絞込みなし(デフォルト)、1：絞込みあり
web_reserve   integer Web予約可 0:絞込みなし(デフォルト)、1：絞込みあり

レスポンス

パラメータ名
(タグ名、@付きは属性名)		 出現回数 型 説明 備考
Response 1 complexType レスポンスルートノード  
@api_version - string APIのバージョン  
total_hit_count 1 integer 該当件数 1000件を超えている場合、上位1000件までのデータが返却される
hit_per_page 1 integer 表示件数  
page_offset 1 integer 表示ページ  
rest 複数回 complexType レストラン情報  
id 1 string 店舗ID  
update_date 1 timestamp 情報更新日時  
name 1 string 店舗名称  
name_kana 1 string 店舗名称（カタカナ）  
latitude 1 number 緯度 度分秒十進数
longitude 1 number 経度 度分秒十進数
category 1 string フリーワードカテゴリー  
url 1 string PCサイトURL  
url_mobile 1 string 携帯サイトURL  
coupon_url 1 complexType クーポンURL  
pc 1 string PC用URL  
mobile 1 string 携帯用URL  
image_url 1 complexType 店舗画像  
shop_image1 1 string 店舗画像1のURL  
shop_image2 1 string 店舗画像2のURL  
qrcode 1 string QRコード画像のURL  
address 1 string 住所  
tel 1 string 電話番号  
tel_sub 1 string 電話番号(サブ)  
fax 1 string FAX番号  
opentime 1 string 営業時間  
holiday 1 string 休業日  
access 1 complexType アクセス  
  line 1 string 路線名  
station 1 string 駅名  
station_exit 1 string 駅出口  
walk 1 integer 徒歩（分） 通常は、徒歩何分です。（例外：車10)
note 1 string 備考  
parking_lots 1 integer 駐車場台数  
pr 1 complexType PR文  
  pr_short 1 string PR文（短）  
pr_long 1 string PR文（長）  
code 1 complexType コード類  
  areacode 1 string 地方コード  
areaname 1 string 地方名称  
prefcode 1 string 都道府県コード  
prefname 1 string 都道府県名称  
areacode_s 1 string エリアSコード  
areaname_s 1 string エリアS名  
category_code_l 複数回 string 大業態コード  
  @order - number オーダー レコード番号
category_name_l 複数回 string 大業態名称  
  @order - number オーダー レコード番号
category_code_s 複数回 string 小業態コード  
  @order - number オーダー レコード番号
category_name_s 複数回 string 小業態名称  
  @order - number オーダー レコード番号
budget 1 integer 平均予算  
party 1 integer 宴会・パーティ平均予算  
lunch 1 integer ランチタイム平均予算  
credit_card 1 string クレジットカード名称  
e_money 1 string 電子マネー名称  
flags 1 complexType フラグ類  
  mobile_site 1 integer モバイルサイトありフラグ  
mobile_coupon 1 integer モバイルクーポンありフラグ  
pc_coupon 1 integer PCクーポンありフラグ  

エラー仕様

パラメータ名
（タグ名）		 出現回数 型 説明
gnavi 1 complexType ルートノード
@api_version - string APIのバージョン
  error 1 complexType エラー
  code 1 integer エラーコード（詳細は「エラーコード一覧」をご覧ください）
message 1 string エラーメッセージ

エラーコード一覧

エラーコード エラー内容
400 不正なパラメータが指定された
401 不正なアクセス（認証エラー）
404 指定された店舗の情報が存在しない
405 不正なアクセス
429 リクエスト回数上限超過
500 処理中にエラーが発生した

サンプルエラーレスポンス

{
    "@attributes": {
        "api_version": "v3"
    },
    "error": [
        {
            "code": 400,
            "message": "指定されたパラメーターは存在しません"
        }
    ]
}

データを正しく返却できない際は、上記のようなエラーデータを返却します。

さっそく「ぐるなび API」を使ってみる