logo
JP

ホットペッパーグルメ APIは今も使える?取得項目と店舗データの一括取得方法

ホットペッパーグルメ APIは現在も利用できる?旧APIの終了範囲、APIキーの申請、店名や営業時間など取得できる項目、1回100件までの取得とページ送りをPythonの例で解説します。口コミや空席の扱い、保存・商用利用の条件、Octoparseで店舗データを扱う方法も紹介します。

約9分で読めます

「ホットペッパーグルメの店舗情報をまとめて取得したい」「飲食店の住所や営業時間、予算をExcelに整理したい」「APIを使って定期的にデータを取得できないだろうか」。こうした目的で、ホットペッパーグルメのAPIを探している方も多いのではないでしょうか。

結論からいうと、ホットペッパーグルメの公式APIは現在も利用できます。 店舗名や住所、営業時間、予算などを取得でき、複数店舗の情報をまとめて取得することも可能です。ただし、利用にはAPIキーの取得やリクエストの設定が必要で、取得できるデータにも制限があります。

本記事では、ホットペッパーグルメAPIの最新の提供状況から、取得できる情報、APIキーの申請方法、具体的な使い方まで解説します。さらに、プログラミングをせずにホットペッパー店舗データを一括収集する方法や、APIを活用してデータ収集を自動化する方法も紹介します。

欲しい情報最初に確認する項目
店名、住所、掲載ページグルメサーチの name、address、urls.pc
営業時間、席数、ディナー予算open、capacity、budget
料理ごとの価格、口コミ本文、日時別の空席グルメサーチの公開レスポンス項目には掲載なし

ホットペッパーグルメ APIは現在も利用できる?

リクルートWEBサービスで、グルメサーチ APIや店名サーチ APIの仕様が公開されています。2023年10月31日に提供を終えたのは、旧ホスト api.hotpepper.jp のAPIです。同日、JSONP、Flashからの利用、QRコード画像の提供も終了しました。古いサンプルを引き継いだ場合は、まず接続先とレスポンス形式を確認してください。

店舗の詳細まで欲しいならグルメサーチ、店名を手がかりに掲載ページを探すなら店名サーチが候補です。エリアやジャンルを画面の選択肢にする場合は、大・中・小エリアマスタやジャンルマスタからコードと表示名を取得できます。予算で絞り込む場合は、検索用ディナー予算マスタを参照します。

店名サーチで検索結果が30件を超えると、条件を絞るよう求められます。同じチェーンの店舗を地域ごとに探すなら、店名サーチを繰り返す前に、グルメサーチで店名とエリアを併用できるか確認すると手戻りを減らせます。

グルメサーチで取得できる店舗情報と制限

グルメサーチの標準レスポンスには、店舗の基本情報に加え、営業時間や総席数、写真のURLが含まれます。アプリの一覧画面と詳細画面で必要な列を分けて書き出すと、使う項目が決まります。

項目取得可否・フィールド活用例
店舗ID・店名・住所取得可。 id、name、address店舗の識別、検索結果の表示
エリア・座標・ジャンル取得可。 middle_area、lat、lng、genre などエリア別の絞り込み、地図表示
営業時間・定休日・席数取得可。 open、close、capacity来店前に見る店舗詳細欄
ディナー予算・コースの有無取得可。 budget、course予算帯の表示、コースがある店舗の確認
写真・店舗ページURLを取得可。 photo.pc.l、urls.pc など写真表示、掲載ページへの案内
個別メニューと価格・口コミ本文・日時別の空席公開レスポンス項目に掲載なし必要に応じて別のデータ提供元に確認

予算の budget.average は「フリー2500円 宴会3500円」のような文字列を取り得ます。金額を一つ抜き出して平均すると、用途の異なる数字が混ざります。予算帯別に表示・集計したい場合は、利用が認められる範囲で budget.code を使うほうが扱いやすいでしょう。 type=lite を指定すると営業時間や席数などが省かれるため、必要な列がそろうまでは標準レスポンスで確認します。

保存・商用利用・再配布はどこまでできますか?

取得した情報の用途は、API利用規約とホットペッパーグルメの利用案内の両方で確認します。API利用規約では、第三者のデータベースへの複製保存や、ダイレクトマーケティングなど規約で許諾されていない用途への利用が制限されています。利用案内では店舗情報そのものの有償再販や、飲食店から対価を得る事業に関わるサイトでの利用を禁止する一方、アフィリエイト収入やAPI利用ソフトウェアの再販を認めています。

自社用の履歴データベースや取引先へのCSV提供を予定している場合も、保存先、保存期間、提供相手、用途を整理し、許諾範囲が不明なら実装前に問い合わせてください。APIを利用するサイトやアプリでは指定のクレジットを表示し、店舗画像を使う場合は画像提供元も明記します。

APIキーの申請から店舗データの一括取得まで

最初は、エリアとキーワードを一つずつ指定し、少数の店舗だけ取得します。最初の応答で項目と検索範囲を確認してからページを進めると、条件を取り違えたままリクエストを繰り返さずに済みます。

  1. APIキー発行フォームで利用規約などを確認し、メールアドレスを登録します。認証メールに従って登録を完了し、発行されたキーを受け取ります。
  2. グルメサーチで店舗を検索します。たとえば新宿周辺でカフェを探すなら、中エリア Y055 とキーワード「カフェ」を指定します。ジャンル分類で絞りたい場合は、ジャンルマスタで調べたコードを genre に指定します。
  3. format=json を付けて、 results.shop の先頭数件を確認します。既定はXMLです。店名、住所、営業時間が目的の列として使えるかを見ます。
  4. results_available に検索条件に合う総件数、 results_returned に今回の件数、 results_start に今回の開始位置が入ります。次の開始位置に「今回の開始位置+今回の件数」を指定します。

Pythonで新宿周辺の店舗を検索する

以下は公式仕様をもとにした確認用コードです。APIキーを環境変数 HOTPEPPER_API_KEY に設定し、 requests をインストールして実行します。最初のページの店名と住所だけを表示します。

import os
import requests

url = "https://webservice.recruit.co.jp/hotpepper/gourmet/v1/"
params = {
    "key": os.environ["HOTPEPPER_API_KEY"],
    "middle_area": "Y055",
    "keyword": "カフェ",
    "format": "json",
    "start": 1,
    "count": 5,
}

response = requests.get(url, params=params, timeout=15)
if not response.ok:
    raise RuntimeError(f"HTTP error: {response.status_code}")

results = response.json()["results"]
if "error" in results:
    raise RuntimeError("APIエラー。キーと検索条件を確認してください。")

for shop in results.get("shop", []):
    print(shop["name"], shop["address"])

count の最大値は100です。毎回100件返ると仮定して start に100を足す代わりに、実際の応答件数を使います。応答が0件なら終了し、次の開始位置が総件数を超えた場合も終了します。検索中に掲載情報が変わることもあるため、一連の結果の重複は店舗IDで確認します。

APIキーを共有用のコードやブラウザ側のJavaScriptに書くと、第三者に見える状態になります。リクエストURLにもキーが入るため、アプリのログにはクエリ全体を残さないようにします。定期実行を組む場合は、リクルートがアクセス回数や時間を制限できることも考慮し、エラー時の連続再試行を避けます。

APIを呼ぶだけでは足りないのはどんなとき?

店舗検索画面に標準項目を表示する用途なら、公式APIで必要な情報がそろうことがあります。担当者が表から確認したい場合は、取得処理に加えて、必要な列の抽出、欠損値の扱い、ファイル出力の手順が要ります。毎月更新するなら、誰が失敗を確認し、どの条件でやり直すかも決めておくと運用しやすくなります。

たとえばエリアごとの価格帯を見たいときは、先に「ディナー予算帯が分かれば足りるか」「コースごとの掲載価格まで必要か」を決めます。後者なら、グルメサーチの項目だけでは要件を満たせません。ウェブページに表示されていても収集や保存が許可されているとは限らないため、ホットペッパーグルメのサイト利用規約第8条・第10条では、無断での複製・蓄積や商業目的での利用などを制限しています。サイト上の情報を業務でまとめて扱う場合は、用途に必要な許諾を先に確認してください。

【代替方法】Octoparseで店舗データを一括収集する方法

ホットペッパーグルメの公式APIは店舗の基本情報を取得するのに便利ですが、APIで提供されていない項目を取得したい場合や、プログラミングを使わずにデータを整理したい場合には、Octoparse(オクトパース)も選択肢になります。

Octoparseは、Webサイトから必要な情報を取得し、表形式で整理できるデータ収集自動化プラットフォームです。ホットペッパーグルメ向けの専用テンプレートが用意されており、対応する店舗情報をまとめて取得して、ExcelやCSVに出力できます。

また、AIアシスタントを使えば、対象ページのURLと取得したい項目を自然な言葉で伝えるだけで、AIが適切な収集方法を提案します。既存テンプレートで対応できない場合は、「クラウドAI収集」による収集タスクの作成も検討できます。作成したタスクは再利用でき、対応プランではクラウドでの定期実行も可能です。

例えば、次のように指示できます。

この店舗一覧ページから、店舗名、住所、ジャンル、営業時間、予算をまとめて取得し、表形式に整理したいです。

Octoparse APIでデータ収集を自動化する

取得した店舗データを自社システムやデータベースに取り込みたい場合は、OctoparseのAPIも利用できます。

Open APIでは、作成済みの収集タスクをプログラムから実行し、結果を取得できます。一方、AgentTools APIでは、対応テンプレートの検索からタスクの作成・実行までをAPI経由で行えます。

例えば、収集した飲食店データをPythonで加工し、社内データベースに取り込むといったワークフローを構築できます。Webデータの取得処理と業務システム側のデータ処理を分けられるため、収集部分を一から開発・管理する負担を抑えられます。

詳しくはOctoparse APIリファレンスをご覧ください。

それに、Octoparseには無料プランも用意されており、月間2,000行までデータ収集を試せます。有料のベーシックプランも月額19ドルから利用でき、月間10,000行まで収集可能です。まずは無料で試し、必要なデータ量に応じてプランを選べます。

以下はOctoparseのAIアシスタントを使ってホットペッパのデータを一括収集する方法について詳しく紹介します。

Step1:Octoparseのアカウントを作成

Octoparseでアカウントがない場合、まずは新規アカウントを作成し、ログインします。

Octoparseアカウント作成

Step2:AIアシスタントを開く

octoparse.jp/console/task/agenticにアクセスするか、Octoparseのホームページにあるチャット欄にリクエストを入力します。

チャット欄にリクエストを入力

Step3:取得したいデータを伝える

対象サイト、必要なフィールド、フィルターを、好きな言語で普段どおりに伝えます。URLを貼り付けても構いません。

チャット欄にリクエストを入力1

Step4:AIアシスタントが理解した内容を確認する

AIアシスタントは 「理解した要件」に、サイト、目的、制約条件としてリクエストをまとめます。内容が違う場合は、「編集」 を選択して修正し、「保存」 を選択します。

また、AIがユーザーのニーズに応じて利用できる収集方法を提案します。ここでは、テンプレート、ブラウザで収集、クラウドAI収集、自動検出などいずれも利用できるので、例として「クラウドAI収集」を選択した。

「クラウドAI収集」を選択
「クラウドAI収集」を選択1

Step5:タスクを作成・実行する

AIアシスタントは選択された方法でタスクを作成し、実行します。

タスクを実行

Step6:取得したデータの確認・エクスポート

AIがタスクの実行が完了したら、「タスクを表示」をクリックし、データの確認とエクスポートを進められます。もし今後も定期的にデータを収集した場合は、定期実行も設定できます。ただし、定期実行の設定はスタンダードプラン以上で利用できます。

「タスクを表示」をクリック
データをエクスポート

関連記事:

ホットペッパーグルメをスクレイピングして飲食店の営業リストを5分で自動作成する方法

公式APIとOctoparseはどちらを選ぶ?

店舗検索アプリに店名や住所を表示したいなら、まずリクルートの公式APIを確認します。利用許諾のあるページから表を作成し、収集処理そのものの開発や運用を減らしたい場合には、Octoparseが候補になります。

比較項目ホットペッパーグルメ公式APIOctoparse
データ範囲公式リファレンスに載る店舗情報対象ページとテンプレート・タスクが扱える表示項目。ホットペッパーグルメ向けテンプレートも公開されています。対象サイトでの業務利用には許諾を確認
一括取得と上限グルメサーチは1回100件まで。続きは開始位置を指定取得件数・実行方式はテンプレート、タスク、プランによる
開発と運用リクエスト、ページ送り、エラー処理、必要な定期実行を実装テンプレートは画面から使える。独自タスクは抽出設定と結果点検が必要
更新と取り込みXML・JSONを処理。定期取得は利用条件を確認し自社側で設計対応タスクはクラウド定期実行を検討可能。CSV等の出力やAPI連携にも対応
利用許諾RecruitのAPI規約・利用案内に従う対象サイトの条件と収集・保存・利用の許諾を確認

ホットペッパーグルメ APIに関するよくある質問

Q:ホットペッパーグルメ APIは無料で利用できますか?

公式のAPIキー申請ページには利用料金の記載がなく、メールアドレスを登録してAPIキーを申請できます。ただし、利用規約を守る必要があり、APIを利用するサイトやアプリでは指定のクレジット表記が必要です。

Q:複数店舗の情報をまとめて取得できますか?

はい。グルメサーチAPIでは、1回のリクエストで最大100件の店舗情報を取得できます。100件を超える場合も、start パラメータを使ってページを切り替えることで、複数回に分けて取得できます。

Q:口コミやメニュー情報は取得できますか?

公式APIでは、店舗名、住所、営業時間、ディナー予算、コースの有無などを取得できます。一方、口コミ本文や個別の料理名・価格、リアルタイムの空席情報は、グルメサーチAPIの公開項目に含まれていません。

Q:ホットペッパービューティーにも公開APIはありますか?

現在、リクルートWEBサービスの公開API一覧には、一般開発者向けのホットペッパービューティーAPIは掲載されていません。美容サロンの情報を取得したい場合は、対象サイトの利用条件を確認したうえで、Webデータ収集ツールなどの方法を検討する必要があります。

Q:Pythonを使わずに店舗情報を確認できますか?

はい。例えば、Octoparseにはホットペッパーグルメ向けの収集テンプレートがあり、プログラミングをせずに対応する店舗情報を取得できます。また、AIアシスタントに対象ページのURLと必要な項目を伝えて、適切な収集方法を探すこともできます。

Q:OctoparseのAPIとホットペッパーグルメ公式APIは何が違いますか?

ホットペッパーグルメ公式APIは、リクルートが提供する店舗情報を取得するためのAPIです。一方、OctoparseのOpen APIは作成済みの収集タスクの実行・結果取得に、AgentTools APIは対応テンプレートからのタスク作成・実行に利用できます。Webデータ収集を自社システムに組み込みたい場合に適しています。

まとめ

ホットペッパーグルメの公式APIは、店舗名や住所、営業時間などの基本情報を取得するのに便利です。一方、プログラミングを使わずに店舗データをまとめたい場合や、APIで取得できない情報が必要な場合は、別の収集方法も選択肢になります。

Octoparseなら、既存テンプレートやAIアシスタントを活用して、必要な店舗情報をまとめて収集できます。さらに、API連携によってデータ取得から自社システムへの取り込みまで自動化することも可能です。無料プランから始められるので、まずは目的に合った収集方法を試してみてください。

今日はどんなデータを集めたいですか?
欲しいデータを伝えるだけで、AI アシスタント がスクレイパーを自動的に作成します。
クレジットカード不要

今すぐOctoparseを始めて、業務効率化を実現しましょう。

ダウンロード

関連記事