ぐるなびWebサービス

2-1.基本仕様

各APIは指定されたURLに対して、リクエストパラメータを指定しGETにてHTTPクエリを発行することで利用することができ、各APIの呼び出し結果（レスポンス）はXMLの形で取得できます。
各APIのリクエスト、レスポンス仕様の詳細は「2-3.各API仕様詳細」をご覧ください。

2-2.エラー仕様

各APIの処理にてエラーが発生した場合には、以下の形式のXMLをレスポンスとして返します。

パラメータ名(タグ名）			出現回数	型	説明
gnavi			1	complexType	ルートノード
	error		1	complexType	エラー
		code	1	integer	エラーコード（詳細は「エラーコード一覧」をご覧ください）

エラーコード一覧

エラーコード	エラーメッセージ	エラー内容
600	NoShop	指定された店舗の情報が存在しない。
601	Invalid Access	不正なアクセス（認証エラー）。
602	Invalid Shop Number	不正なぐるなび店舗IDパラメータが指定された。
603	InvalidType	不正な取得種別が指定された。
604	Internal Server Error	処理中にエラーが発生した。

サンプル

<?xml
version="1.0" encoding="UTF-8"?>

<gnavi>
<error>
<code>602</code>
</error>
</gnavi>

不正アクセスの場合には上記のようなXMLデータが返ります。

↑このページの先頭へ

2-3.各API仕様詳細

2-3-1.レストラン検索API

URL http://api.gnavi.co.jp/ver1/RestSearchAPI/?

リクエストパラメータ
※リクエストパラメータが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より取得
category_l		string	大業態コード	コードは大業態マスタ取得APIより取得
category_s		string	小業態コード	コードは小業態マスタ取得APIより取得
input_coordinates_mode		integer	入力測地系タイプ	入力する緯度/経度の測地系のタイプを指定 1:日本測地系、 2:世界測地系（デフォルト:日本測地系）
equipment		string	設備・サービス	設備・サービスの文字列をUTF-8で URLエンコードすること
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
sort		integer	ソート順	レスポンスデータのソート順 1:店舗名、2:業態（デフォルト:店舗名）
offset		integer	検索開始位置	検索開始レコードの位置（デフォルト:1）
hit_per_page		integer	ヒット件数	一度リクエストで得るレスポンスデータの最大件数（デフォルト:10）
offset_page		integer	検索開始ページ	検索開始ページ位置（デフォルト:1）
freeword		string	フリーワード検索	検索ワードをUTF-8でURLエンコードすること「,」区切りで複数ワードが検索可能（１０個まで）
freeword_condition		string	フリーワード検索条件タイプ	フリーワード検索の条件を指定 1:AND検索、２：ＯＲ検索（デフォルト:AND検索）

レスポンス

パラメータ名 (タグ名、@付きは属性名)					出現回数	型	説明	備考
Response					1	complexType	レスポンスルートノード
	total_hit_count				1	integer	該当件数
	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
		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	電話番号
		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	string	徒歩（分）	通常は、徒歩何分です。（例外：車10)
			note		1	string	備考
		pr			1	complexType
			pr_short		1	string	PR文（短:最大50文字）
			pr_long		1	string	PR文（長:最大200文字）
		code			1	complexType	コード類
			areacode		1	string	エリアコード
			areaname		1	string	エリア名
			prefcode		1	string	都道府県コード
			prefname		1	string	都道府県名
			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	string	平均予算
		equipment			1	string	設備
		flags			1	complexType	フラグ類
			mobile_site		1	number	モバイルサイトありフラグ
			mobile_coupon		1	number	モバイルクーポンありフラグ
			pc_coupon		1	number	PCクーポンありフラグ

サンプルクエリ
http://api.gnavi.co.jp/ver1/RestSearchAPI/?keyid=(発行されたアクセスキー）&area=AREA110 &pref=PREF13&id=g144600&sort=1

上記のクエリを送信することにより以下のようなXMLデータを取得できます。

<?xml
version="1.0" encoding="UTF-8"?>

<response>
<total_hit_count>1</total_hit_count>
<hit_per_page>1</hit_per_page>
<page_offset>1</page_offset>
<rest order="0">
   <id>g144600</id>
   <update_date>2007-04-11 21:03:36</update_date>
   <name>うなぎ・割烹大江戸</name>
   <name_kana>ウナギカッポウオオエド</name_kana>
   <latitude>35.686814</latitude>
   <longitude>139.778389</longitude>
   <category>うなぎ・会席料理</category>
   <url>http://r.gnavi.co.jp/g144600/</url>
   <url_mobile>http://mobile.gnavi.co.jp/g144600</url_mobile>
   <image_url>
    <shop_image1>
    http://apicache.gnavi.co.jp/image/rest/index.php?img=g144600v.jpg&sid=g144600
    </shop_image1>
    <shop_image2>
    http://apicache.gnavi.co.jp/image/rest/index.php?img=g144600l.jpg&sid=g144600
    </shop_image2>
    <qrcode>
    http://apicache.gnavi.co.jp/image/rest/index.php?img=g144600qr.png&sid=g144600
    </qrcode>
   </image_url>
   <address>〒103-0023 東京都中央区日本橋本町4-7-10</address>
   <tel>03-3241-3838</tel>
   <fax>03-3241-3437</fax>
   <opentime>11:00～22:00</opentime>
   <holiday>日・祝</holiday>
   <access>
    <line>ＪＲ</line>
    <station>神田駅</station>
    <station_exit></station_exit>
    <walk>5</walk>
    <note></note>
   </access>
   <pr>
    <pr_short>
    岸朝子氏お気に入りの日本橋のうなぎ屋。馥郁とした香りの中に奥深い味わいをつつみこむ伝統の味覚。
    </pr_short>
    <pr_long>
    江戸の昔より多くの人々に親しまれてきた蒲焼。「蒲焼」の歴史と共に歩みを重ねてきたここ「大江戸」は、知る人ぞ知る「うなぎ割烹」の老舗。創業江戸寛政年間（１８００年）初代草加屋吉兵衛が江戸の地に店を構え、以来営々と代々受け継がれている。商談や宴会など幅広くご利用いただけるお座敷、個室から、気軽に立ち寄れる個室風の食堂もあり。 ■土曜日は「いかだ」が登場するのも人気の秘密。「いかだ」とは開いたうなぎを半分に切らずにそのまま焼き上げ、いかだのように並べた贅沢なメニュー。
    </pr_long>
   </pr>
   <code>
    <areacode>AREA110</areacode>
    <areaname>関東</areaname>
    <prefcode>PREF13</prefcode>
    <prefname>東京都</prefname>
    <category_code_l order="0">CTG100</category_code_l>
    <category_name_l order="0">和食</category_name_l>
    <category_code_s order="0">CTG117</category_code_s>
    <category_name_s order="0">うなぎ</category_name_s>
   </code>
   <budget>6000</budget>
   <equipment>
   カラオケあり,テイクアウト可,ツーカー,au,ボーダフォン,NTT ドコモ,座椅子あり,50人以上OK(着席時),個室あり,芸妓手配可,コンパニオン手配可,昼間の宴会・パーティ対応可,3時間以上の宴会・パーティ可,座敷席あり,法事で利用可,結納で利用可
   </equipment>
   <flags>
    <mobile_site>1</mobile_site>
    <mobile_coupon></mobile_coupon>
    <pc_coupon></pc_coupon>
   </flags>
</rest>
</response>

↑このページの先頭へ

2-3-2.エリアマスタ取得API

URL http://api.gnavi.co.jp/ver1/AreaSearchAPI/?

リクエストパラメータ

パラメータ名	必須	型	説明	備考
keyid	○	string	アクセスキー	ぐるなびより提供されたアクセスキー

レスポンス

パラメータ名 (タグ名、@付きは属性名)			出現回数	型	説明	備考
response			1	complexType	レスポンスルートノード
	area		複数回	complexType	エリア情報
		area_code	1	string	エリアコード
		area_name	1	string	エリア名称	関東、関西などのエリア名称

サンプルクエリ
http://api.gnavi.co.jp/ver1/AreaSearchAPI/?keyid=test-api

上記のクエリを送信することにより以下のようなXMLデータを取得できます。

<?xml
version="1.0" encoding="UTF-8"?>

↑このページの先頭へ

2-3-3.都道府県マスタAPI

URL http://api.gnavi.co.jp/ver1/PrefSearchAPI/?

リクエストパラメータ

パラメータ名	必須	型	説明	備考
keyid	○	string	アクセスキー	ぐるなびより提供されたアクセスキー

レスポンス

パラメータ名 (タグ名、@付きは属性名)			出現回数	型	説明	備考
response			1	complexType	レスポンスルートノード
	pref		複数回	complexType	都道府県情報
		pref_code	1	string	都道府県コード
		pref_name	1	string	都道府県名称	都道府県の名称
		area_code	1	string	所属エリアコード	外部参照キー

サンプルクエリ
http://api.gnavi.co.jp/ver1/PrefSearchAPI/?keyid=test-api

上記のクエリを送信することにより以下のようなXMLデータを取得できます。

<?xml
version="1.0" encoding="UTF-8"?>

↑このページの先頭へ

2-3-4.大業態マスタ取得API

URL http://api.gnavi.co.jp/ver1/CategoryLargeSearchAPI/?

リクエストパラメータ

パラメータ名	必須	型	説明	備考
keyid	○	string	アクセスキー	ぐるなびより提供されたアクセスキー

レスポンス

パラメータ名 (タグ名、@付きは属性名)			出現回数	型	説明	備考
response			1	complexType	レスポンスルートノード
	category_l		複数回	complexType	大業態情報
		category_l_code	1	string	大業態コード
		category_l_name	1	string	大業態名称

サンプルクエリ
http://api.gnavi.co.jp/ver1/CategoryLargeSearchAPI/?keyid=test-api

上記のクエリを送信することにより以下のようなXMLデータを取得できます。

<?xml
version="1.0" encoding="UTF-8"?>

<response>
<category_l>
   <category_l_code>CTG100</category_l_code>
   <category_l_name>和食</category_l_name>
</category_l>
<category_l>
   <category_l_code>CTG200</category_l_code>
   <category_l_name>洋食</category_l_name>
</category_l>
<category_l>
   <category_l_code>CTG300</category_l_code>
   <category_l_name>中華</category_l_name>
</category_l>
<category_l>
   <category_l_code>CTG400</category_l_code>
   <category_l_name>アジア・エスニック・無国籍</category_l_name>
</category_l>
    ・
    ・
    ・
<category_l>
   <category_l_code>CTG800</category_l_code>
   <category_l_name>ファミレス・ファーストフード</category_l_name>
</category_l>
</response>

↑このページの先頭へ

2-3-5.小業態マスタ取得API

URL http://api.gnavi.co.jp/ver1/CategorySmallSearchAPI/?

リクエストパラメータ

パラメータ名	必須	型	説明	備考
keyid	○	string	アクセスキー	ぐるなびより提供されたアクセスキー

レスポンス

パラメータ名 (タグ名、@付きは属性名)			出現回数	型	説明	備考
response			1	complexType	レスポンスルートノード
	category_s		複数回	complexType	小l業態情報
		category_s_code	1	string	小業態コード
		category_s_name	1	string	小業態名称
		category_l_code	1	string	所属する大業態コード	外部参照キー

サンプルクエリ
http://api.gnavi.co.jp/ver1/CategorySmallSearchAPI/?keyid=test-api

上記のクエリを送信することにより以下のようなXMLデータを取得できます。

<?xml
version="1.0" encoding="UTF-8"?>

<response>
<category_s>
   <category_s_code>CTG101</category_s_code>
   <category_s_name>懐石</category_s_name>
   <category_l_code>CTG100</category_l_code>
</category_s>
<category_s>
   <category_s_code>CTG102</category_s_code>
   <category_s_name>会席</category_s_name>
   <category_l_code>CTG100</category_l_code>
<category_s>
<category_s>
   <category_s_code>CTG103</category_s_code>
   <category_s_name>割烹</category_s_name>
   <category_l_code>CTG100</category_l_code>
<category_s>
<category_s>
   <category_s_code>CTG104</category_s_code>
   <category_s_name>小料理</category_s_name>
   <category_l_code>CTG100</category_l_code>
<category_s>
<category_s>
   <category_s_code>CTG105</category_s_code>
   <category_s_name>定食</category_s_name>
   <category_l_code>CTG100</category_l_code>
<category_s>
    ・
    ・
    ・
<category_s>
   <category_s_code>CTG803</category_s_code>
   <category_s_name>ファーストフード</category_s_name>
   <category_l_code>CTG800</category_l_code>
<category_s>
</response>

↑このページの先頭へ

ぐるなびWebサービス

更新情報

1.ぐるなびAPI一覧

2.API利用方法

2-1.基本仕様

2-2.エラー仕様

2-3.各API仕様詳細

2-3-1.レストラン検索API

2-3-2.エリアマスタ取得API

2-3-3.都道府県マスタAPI

2-3-4.大業態マスタ取得API

2-3-5.小業態マスタ取得API