食べログAPI マニュアル
食べログAPIでは、現在以下のAPIを公開しています。 指定のURLにアクセスすることで、XML形式で結果を出力することができます。
- レストラン情報取得API …緯度・経度や最寄り駅などを指定することで、それに該当するレストラン情報を取得することができます。
- レストラン口コミ取得API …レストラン情報取得APIで取得したレストランに投稿された口コミ情報を取得することができます。
- レストラン画像取得API …レストラン情報取得APIで取得したレストランに投稿された画像情報を取得することができます。
レストラン情報取得API
レストラン情報取得APIでは、都道府県や最寄駅、緯度・経度を指定することで、そこに該当するエリアのレストラン情報を最大2000件まで取得することができます。
これらの検索条件は組み合わせてお使いいただけます(AND条件)ので、特定の都道府県の駅を指定することなども可能です。
※都道府県、最寄り駅、緯度・経度以外のエリア条件や、ジャンル条件などの指定はできません。
リクエストURL
http://api.tabelog.com/Ver2.1/RestaurantSearch/?パラメータ名=パラメータ値…
リクエストパラメータ
パラメータ名は大文字小文字を区別し、パラメータ値は大文字小文字の区別はありません。
結果は20件ずつ返します。
都道府県、最寄り駅、緯度・経度はそれぞれ指定した場合、AND条件として検索されます。
※パラメータの指定が無い場合は「デフォルト値」となります。
| パラメータ名 | 説明 | データ型 | 値、サンプル | デフォルト値 |
|---|---|---|---|---|
| Key | APIアクセスキー | String | 40桁の文字列 | ※必須 |
| Latitude | 緯度(日本国内のみ) | Float | (例)35.684 | null |
| Longitude | 経度(日本国内のみ) | Float | (例)139.756 | null |
| Datum | 測地系 (緯度、経度が指定されている時のみ有効) | String | tokyo world |
world |
| SearchRange | 検索範囲 (緯度、経度が指定されている時のみ有効) | String | small(約300m以内) medium(約600m以内) large(約1.5km以内) |
medium |
| Prefecture | 都道府県 | String | 別表1をご参照ください。 | japan |
| Station | 最寄り駅の駅名 | String | 駅名をURLエンコードしたもの (文字コード:UTF-8) |
null |
| ResultSet | 結果形式 | String | small large |
small |
| SortOrder | ソート順 | String | totalscore (点数(総合評価)が高い順) taste(料理・味の点数が高い順) service(サービスの点数が高い順) mood(雰囲気の点数が高い順) highprice(価格(夜)が高い順) lowprice(価格(夜)が低い順) reviewcount(口コミ数が多い順) |
totalscore |
| PageNum | ページ数 (最大100ページまで) | Integer | (例)10 | 1 |
| ResultDatum | 結果形式(緯度経度の測地系) | String | tokyo world |
world |
| パラメータ値 | 説明 | パラメータ値 | 説明 | パラメータ値 | 説明 |
|---|---|---|---|---|---|
| hokkaido | 北海道 | ishikawa | 石川 | okayama | 岡山 |
| aomori | 青森 | fukui | 福井 | hiroshima | 広島 |
| iwate | 岩手 | yamanashi | 山梨 | yamaguchi | 山口 |
| miyagi | 宮城 | nagano | 長野 | tokushima | 徳島 |
| akita | 秋田 | gifu | 岐阜 | kagawa | 香川 |
| yamagata | 山形 | shizuoka | 静岡 | ehime | 愛媛 |
| fukushima | 福島 | aichi | 愛知 | kochi | 高知 |
| ibaraki | 茨城 | mie | 三重 | fukuoka | 福岡 |
| tochigi | 栃木 | shiga | 滋賀 | saga | 佐賀 |
| gunma | 群馬 | kyoto | 京都 | nagasaki | 長崎 |
| saitama | 埼玉 | osaka | 大阪 | kumamoto | 熊本 |
| chiba | 千葉 | hyogo | 兵庫 | oita | 大分 |
| tokyo | 東京 | nara | 奈良 | miyazaki | 宮崎 |
| kanagawa | 神奈川 | wakayama | 和歌山 | kagoshima | 鹿児島 |
| niigata | 新潟 | tottori | 鳥取 | okinawa | 沖縄 |
| toyama | 富山 | shimane | 島根 | japan | 全国 |
リターンパラメータ
検索されたレストラン情報をXML形式で返します。(文字コード:UTF-8)
| パラメータ名 | 説明 | データ型 | 対応ResultSet |
|---|---|---|---|
| NumOfResult | 検索結果件数 | Integer | smallとlarge |
| Rcd | レストランID | Integer | smallとlarge |
| RestaurantName | レストラン名 | String | smallとlarge |
| TabelogUrl | レストラン詳細ページ(PC)のURL | String | smallとlarge |
| TabelogMobileUrl | レストラン詳細ページ(モバイル)のURL | String | smallとlarge |
| TotalScore | 点数(総合評価) | Float | smallとlarge |
| TasteScore | 料理・味の点数 | Float | smallとlarge |
| ServiceScore | サービスの点数 | Float | smallとlarge |
| MoodScore | 雰囲気の点数 | Float | smallとlarge |
| Situation | シチュエーション | String | smallとlarge |
| DinnerPrice | 価格(夜) | String | smallとlarge |
| LunchPrice | 価格(昼) | String | smallとlarge |
| Category | ジャンル名 | String | smallとlarge |
| Station | 最寄り駅 | String | smallとlarge |
| Address | 住所 | String | large |
| Tel | 電話番号 | String | large |
| BusinessHours | 営業時間 | String | large |
| Holiday | 休日 | String | large |
| Latitude | 緯度 (ResultDatumが「world」のとき:世界測地系 ResultDatumが「tokyo」のとき:日本測地系) |
Float | large |
| Longitude | 経度 (ResultDatumが「world」のとき:世界測地系 ResultDatumが「tokyo」のとき:日本測地系) |
Float | large |
サンプル
【リクエスト】
http://api.tabelog.com/Ver2.1/RestaurantSearch/?Latitude=35.701&Longitude=139.754&Datum=world&SearchRange=small&
Prefecture=tokyo&Station=%E6%B0%B4%E9%81%93%E6%A9%8B&ResultSet=large&SortOrder=totalscore&PageNum=1&Key=取得したAPIアクセスキー
の場合。
【結果】
エラー
各APIの処理でエラーが発生した場合には、以下のXMLをレスポンスとして返します。
| エラーコード | 内容 |
|---|---|
| ItemNotFound | 条件に該当するデータがない場合。 |
| TooManyItemsRequested | 制限値を超えたアイテム数のリクエストがあった場合。 |
| InvalidParameterValue | リクエストのパラメータが不正だった場合。 |
| InternalServerError | 内部的な問題によってデータを返すことが出来なかった場合。 |
| AccessLimitExceeded | 一日のアクセス制限数を超過した場合。 ※詳しくはアクセス制限についてをご覧ください。 |
| InvalidApiKey | APIアクセスキーが正しくない場合。 |
| AccessDenied | 何らかの理由によりアクセスが拒否されている場合。 |
| ApiVersionExpired | そのバージョンのAPIが既にサービスを停止している場合。 ※詳しくはバージョンについてをご覧ください。 |
【サンプル】
ItemNotFoundの場合<?xml version="2.1" encoding="utf-8" ?> <Error> <Message>ItemNotFound</Message> </Error>
注意点
サイト構築の際には、リターンパラメータのTabelogUrlで返されるレストランURLを使用して、必ず食べログへリンクしてください。
また、レストラン情報は必ずガイドラインに従ったかたちで表示してください。
バージョン
最新バージョンは「Ver.2.1」となります。
Ver.1.0、Ver.1.1、Ver.2.0は既にサービスを終了しておりますので、旧バージョンをご利用の方は、ご利用登録ページより新規にAPIキーを発行してください。
アクセス制限
一日あたりのアクセス回数は200回までとなっております。 制限を超えた場合、同日中はご利用いただけなくなりますので、予めご了承ください。
レストラン口コミ取得API
レストラン口コミ取得APIでは、レストラン情報取得APIで取得したレストランに投稿された口コミ情報を取得することができます。
レストランコードを指定することで、そのレストランの口コミ(文頭より99文字まで)を最大2000件取得することができます。
※ここで返される点数やシチュエーションの値などは、それぞれの口コミに付随するものです。
お店の総合的な評価ではなく、あくまでその口コミを投稿したユーザーがつけた値になりますので、ご注意ください。
リクエストURL
http://api.tabelog.com/Ver1/ReviewSearch/?パラメータ名=パラメータ値・・・・
リクエストパラメータ
パラメータ名は大文字小文字を区別し、パラメータ値は大文字小文字の区別はありません。
結果は20件ずつ返します。
※パラメータの指定が無い場合は「デフォルト値」となります。
| パラメータ名 | 説明 | データ型 | 値、サンプル | デフォルト値 |
|---|---|---|---|---|
| Key | APIアクセスキー | String | 40桁の文字列 | ※必須 |
| Rcd | レストランコード | Integer | 7~8桁の数字 | ※必須 |
| SortOrder | ソート順 | String |
update(更新日) visit(最終訪問日) vote(参考票) |
update |
| PageNum | ページ数 (最大100ページまで) | Integer | (例)10 | 1 |
リターンパラメータ
検索されたレストラン口コミ情報をXML形式で返します。(文字コード:UTF-8)
| パラメータ名 | 説明 | データ型 |
|---|---|---|
| NumOfResult | 検索結果件数 | Integer |
| NickName | 投稿したユーザーのニックネーム | String |
| VisitDate | レストラン訪問日 | Date |
| ReviewDate | 口コミ投稿日 | Date |
| UseType | 口コミ対象(夜のみ、昼のみ、夜・昼両方) | String |
| Situations | オススメシチュエーション (友人・同僚と、デート、接待、宴会、家族・子供と、一人で ) |
String |
| TotalScore | 点数(総合評価) | Decimal |
| TasteScore | 料理・味の点数 | Decimal |
| ServiceScore | サービスの点数 | Decimal |
| MoodScore | 雰囲気の点数 | Decimal |
| DinnerPrice | 使った金額/1人当り(夜) | String |
| LunchPrice | 使った金額/1人当り(昼) | String |
| Title | 口コミのタイトル | String |
| Comment | 口コミのコメント(文頭より99文字まで) | String |
| PcSiteUrl | 口コミページ(PC)のURL | String |
| MobileSiteUrl | 口コミページ(モバイル)のURL | String |
サンプル
【リクエスト】
http://api.tabelog.com/Ver1/ReviewSearch/?Rcd=13003239&Key=取得したAPIアクセスキー&SortOrder=update&PageNum=1
の場合。
【結果】
エラー
各APIの処理でエラーが発生した場合には、以下のXMLをレスポンスとして返します。
| エラーコード | 内容 |
|---|---|
| ItemNotFound | 条件に該当するデータがない場合。 |
| TooManyItemsRequested | 制限値を超えたアイテム数のリクエストがあった場合。 |
| InvalidParameterValue | リクエストのパラメータが不正だった場合。 |
| InternalServerError | 内部的な問題によってデータを返すことが出来なかった場合。 |
【サンプル】
ItemNotFoundの場合<?xml version="1" encoding="utf-8" ?> <Error> <Message>ItemNotFound</Message> </Error>
注意点
サイト構築の際には、リターンパラメータのPcSiteUrl(モバイルでのご利用の場合はMobileSiteUrl)で返されるレストランURLを使用して、必ず食べログへリンクしてください。
また、口コミ情報は必ずガイドラインに従ったかたちで表示してください。
レストラン画像取得API
レストラン画像取得APIでは、レストラン情報取得APIで取得したレストランに投稿された画像情報を取得することができます。
レストランコードを指定することで、そのレストランの画像(サムネイル)を最大5件取得することができます。
※ユーザーが投稿した画像…料理・店内・外観・その他の画像を参考票順に取得
お店が投稿した画像…料理・店内の画像を投稿日が古い順に取得
リクエストURL
http://api.tabelog.com/Ver1/ReviewImageSearch/?パラメータ名=パラメータ値・・・・
リクエストパラメータ
パラメータ名は大文字小文字を区別し、パラメータ値は大文字小文字の区別はありません。
結果は代表的な画像を5件まで返します。
※店舗画像の場合は、PC、モバイルリンクのurlはレストラントップへのリンクになります。
※パラメータの指定が無い場合は「デフォルト値」となります。
| パラメータ名 | 説明 | データ型 | 値、サンプル | デフォルト値 |
|---|---|---|---|---|
| Key | APIアクセスキー | Integer | 40桁の文字列 | ※必須 |
| Rcd | レストランコード | Integer | 7~8桁の数字 | ※必須 |
リターンパラメータ
検索されたレストラン情報をXML形式で返します。(文字コードはUTF-8)
| パラメータ名 | 説明 | データ型 |
|---|---|---|
| ImageUrlS | サムネイル(50x50)のURL | String |
| ImageUrlM | サムネイル(100x100)のURL | String |
| ImageUrlL | サムネイル(150x150)のURL | String |
| ImageComment | 画像のコメント | String |
| PcSiteUrl | 画像ページ(PC)のURL | String |
| MobileSiteUrl | 画像ページ(モバイル)のURL | String |
| ImageStatus | 写真の種類(料理、店内、外観、その他) | String |
| UserName | 投稿したユーザーのニックネーム | String |
サンプル
【リクエスト】
http://api.tabelog.com/Ver1/ReviewImageSearch/?Key=取得したAPIアクセスキー&Rcd=13000222
の場合。
【結果】
エラー
各APIの処理でエラーが発生した場合には、以下のXMLをレスポンスとして返します。
| エラーコード | 内容 |
|---|---|
| ItemNotFound | 条件に該当するデータがない場合。 |
| TooManyItemsRequested | 制限値を超えたアイテム数のリクエストがあった場合。 |
| InvalidParameterValue | リクエストのパラメータが不正だった場合。 |
| InternalServerError | 内部的な問題によってデータを返すことが出来なかった場合。 |
【サンプル】
ItemNotFoundの場合<?xml version="1" encoding="utf-8" ?> <Error> <Message>ItemNotFound</Message> </Error>
注意点
サイト構築の際には、リターンパラメータのPcSiteUrl(モバイルでのご利用の場合はMobileSiteUrl)で返されるレストランURLを使用して、必ず食べログへリンクしてください。
また、画像情報は必ずガイドラインに従ったかたちで表示してください。