# HotPepper Gourmet Japan Restaurant Scraper (`piquno/hotpepper-gourmet-japan-restaurant-scraper`) Actor Scrape Japanese restaurant data from HotPepper Gourmet (ホットペッパーグルメ), Japan's leading restaurant booking platform with 100,000+ listings. Get names, addresses, budgets, phone numbers, photos, genres, coupons, and amenities across all 47 prefectures. No API key required. - **URL**: https://apify.com/piquno/hotpepper-gourmet-japan-restaurant-scraper.md - **Developed by:** [Piquno](https://apify.com/piquno) (community) - **Categories:** Travel, Lead generation, E-commerce - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 1 bookmarks - **User rating**: No ratings yet ## Pricing from $80.00 / 1,000 results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## HotPepper Gourmet Japan Restaurant Scraper Scrape Japanese restaurant data from **[HotPepper Gourmet](https://www.hotpepper.jp/)** (ホットペッパーグルメ) — Japan's leading restaurant booking platform, with **100,000+ restaurants** across all 47 prefectures. **No API key required.** Just pick a prefecture and a genre, and get clean, structured data. ### What you can search by - **Prefecture**: dropdown of all 47 Japanese prefectures - **Genre**: 17 cuisine types — Izakaya, Ramen, Sushi/Japanese, Italian/French, Yakiniku, Korean, Ramen, Cafe, and more - **Sub-area code**: narrow to neighborhoods (e.g. Y055=Shinjuku, Y005=Ginza, Y045=Roppongi) - **Custom URLs**: paste hotpepper.jp listing URLs with your own filters applied (budget, amenities, station, etc.) and the scraper handles them directly ### What data you get #### From the listing page (fast mode, default) | Field | Description | |---|---| | shopId | HotPepper internal ID (e.g. J003389501) | | name | Restaurant name | | url | HotPepper URL | | phone | Phone number (extracted directly from the listing) | | genre | Cuisine type | | nearestStation | Closest train station | | tags | Keyword tags (private room, all-you-can-drink, etc.) | | catchphrase | Short marketing description | | dinnerBudget | Per-person evening price band | | lunchBudget | Per-person lunch price band | | access | Transit directions | | photo | Header photo URL | | badges | Promo badges (point bonuses, smart pay, etc.) | | cardAccepted | Whether credit cards are accepted | | smokingPolicy | non-smoking / partial-smoking / smoking-allowed | | couponTitle, couponUrl | First available coupon | | isPromoted | Whether this is a paid PR listing | #### Add `includeDetails: true` to also get | Field | Description | |---|---| | rating | TrustYou rating (0.0-5.0) | | ratingLabel | Excellent / Very Good / Good / Fair / Poor | | reviewCount | Number of reviews | | address | Full street address | | accessFull | Detailed multi-line access directions | | hours | Full opening hours per day | | closedDays | Holidays / closed days | | totalSeats | Capacity info | | privateRoomDetail | Private room availability + capacity | | charterDetail | Charter/private hire availability | | parking | Parking availability | | smokingDetail | Detailed smoking policy | | childPolicy | Child-friendly status | | petPolicy | Pet-friendly status | | homepage | Restaurant's own website if linked | | openedOn | Date the restaurant opened | | breadcrumbs | Full area hierarchy | ### Example inputs **100 ramen shops in Tokyo:** ```json { "prefecture": "SA11", "genre": "G013", "maxResults": 100 } ```` **200 izakayas in Shinjuku with full details:** ```json { "prefecture": "SA11", "genre": "G001", "subArea": "Y055", "maxResults": 200, "includeDetails": true } ``` **Custom search via URL** (in this example, Tokyo izakaya with private rooms and all-you-can-drink — set up the filter on hotpepper.jp and paste the resulting URL): ```json { "startUrls": ["https://www.hotpepper.jp/SA11/G001/H010/"], "maxResults": 500 } ``` ### Prefecture codes (for reference) | Code | Prefecture | Code | Prefecture | |---|---|---|---| | SA11 | Tokyo | SA41 | Hokkaido | | SA12 | Kanagawa | SA51 | Aomori | | SA13 | Saitama | SA53 | Miyagi | | SA14 | Chiba | SA66 | Nagano | | SA22 | Kyoto | SA74 | Hiroshima | | SA23 | Osaka | SA91 | Fukuoka | | SA33 | Aichi | SA98 | Okinawa | (All 47 are in the dropdown.) ### Use cases - Restaurant directory and recommendation apps - Competitive analysis for restaurant chains - B2B lead generation (phone numbers included on listings) - Tourist guides and travel content - Market research on Japanese cuisine and regional trends - LLM training data for Japanese hospitality ### Why this Actor - **No API key needed** — works for anyone, anywhere, immediately - **Phone numbers right on listings** — no need to fetch detail pages for contact info - **All 47 prefectures, 17 genres** — full national coverage - **Optional detail mode** — get 13+ extra fields per restaurant when needed - **Custom URL support** — paste your own hotpepper.jp filter URL for any combination of budget, amenities, station, and so on ### Attribution Per HotPepper Gourmet's terms, any application using this data should display: > *Powered by ホットペッパーグルメ Webサービス* # Actor input Schema ## `prefecture` (type: `string`): Japanese prefecture to search. Covers all 47 prefectures. ## `genre` (type: `string`): Cuisine type. Leave 'Any' to include all genres. ## `subArea` (type: `string`): Narrower area within the prefecture. Examples: Y055=Shinjuku, Y030=Shibuya, Y050=Ikebukuro, Y005=Ginza/Yurakucho, Y045=Roppongi, Y035=Harajuku/Aoyama. Leave blank for the whole prefecture. ## `startUrls` (type: `array`): Paste one or more hotpepper.jp listing URLs to scrape directly. Useful if you've built a custom filter on the site (e.g. with budget, amenities, station). When set, this overrides the prefecture/genre/sub-area fields. ## `maxResults` (type: `integer`): Maximum number of restaurants to scrape per URL. HotPepper supports deep pagination (Tokyo izakaya alone has 23,000+ results). ## `includeDetails` (type: `boolean`): Scrape each restaurant's detail page for extra data (full address, rating, review count, hours, closed days, amenities). Slower but much richer output. ## Actor input object example ```json { "prefecture": "SA11", "genre": "", "subArea": "", "startUrls": [], "maxResults": 100, "includeDetails": false } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "startUrls": [] }; // Run the Actor and wait for it to finish const run = await client.actor("piquno/hotpepper-gourmet-japan-restaurant-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "startUrls": [] } # Run the Actor and wait for it to finish run = client.actor("piquno/hotpepper-gourmet-japan-restaurant-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "startUrls": [] }' | apify call piquno/hotpepper-gourmet-japan-restaurant-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=piquno/hotpepper-gourmet-japan-restaurant-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "HotPepper Gourmet Japan Restaurant Scraper", "description": "Scrape Japanese restaurant data from HotPepper Gourmet (ホットペッパーグルメ), Japan's leading restaurant booking platform with 100,000+ listings. Get names, addresses, budgets, phone numbers, photos, genres, coupons, and amenities across all 47 prefectures. No API key required.", "version": "1.0", "x-build-id": "V0mpmdKwgvLmU6aIk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/piquno~hotpepper-gourmet-japan-restaurant-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-piquno-hotpepper-gourmet-japan-restaurant-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/piquno~hotpepper-gourmet-japan-restaurant-scraper/runs": { "post": { "operationId": "runs-sync-piquno-hotpepper-gourmet-japan-restaurant-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/piquno~hotpepper-gourmet-japan-restaurant-scraper/run-sync": { "post": { "operationId": "run-sync-piquno-hotpepper-gourmet-japan-restaurant-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "prefecture" ], "properties": { "prefecture": { "title": "Prefecture", "enum": [ "SA11", "SA12", "SA13", "SA14", "SA15", "SA16", "SA17", "SA21", "SA22", "SA23", "SA24", "SA25", "SA26", "SA31", "SA32", "SA33", "SA34", "SA41", "SA51", "SA52", "SA53", "SA54", "SA55", "SA56", "SA61", "SA62", "SA63", "SA64", "SA65", "SA66", "SA71", "SA72", "SA73", "SA74", "SA75", "SA81", "SA82", "SA83", "SA84", "SA91", "SA92", "SA93", "SA94", "SA95", "SA96", "SA97", "SA98" ], "type": "string", "description": "Japanese prefecture to search. Covers all 47 prefectures.", "default": "SA11" }, "genre": { "title": "Genre / Cuisine", "enum": [ "", "G001", "G002", "G003", "G004", "G005", "G006", "G007", "G008", "G017", "G009", "G010", "G011", "G012", "G013", "G016", "G014", "G015" ], "type": "string", "description": "Cuisine type. Leave 'Any' to include all genres.", "default": "" }, "subArea": { "title": "Sub-Area Code (Optional)", "type": "string", "description": "Narrower area within the prefecture. Examples: Y055=Shinjuku, Y030=Shibuya, Y050=Ikebukuro, Y005=Ginza/Yurakucho, Y045=Roppongi, Y035=Harajuku/Aoyama. Leave blank for the whole prefecture.", "default": "" }, "startUrls": { "title": "Start URLs (Advanced — Optional)", "type": "array", "description": "Paste one or more hotpepper.jp listing URLs to scrape directly. Useful if you've built a custom filter on the site (e.g. with budget, amenities, station). When set, this overrides the prefecture/genre/sub-area fields.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of restaurants to scrape per URL. HotPepper supports deep pagination (Tokyo izakaya alone has 23,000+ results).", "default": 100 }, "includeDetails": { "title": "Include Detail Pages", "type": "boolean", "description": "Scrape each restaurant's detail page for extra data (full address, rating, review count, hours, closed days, amenities). Slower but much richer output.", "default": false } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```