{ "openapi": "3.0.1", "info": { "title": "Japan Restaurants Scraper (HotPepper Gourmet)", "description": "Restaurants from hotpepper.jp by prefecture and genre — budgets, address, business phone, hours, seats, private rooms and other facility facts in a clean English schema. Unofficial; not affiliated with Recruit Co., Ltd. No review text, reviewer data or coupon copy.", "version": "0.1", "x-build-id": "2MB4i0TqwMXPI2bXx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jpopendata~japan-restaurants-hotpepper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jpopendata-japan-restaurants-hotpepper", "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/jpopendata~japan-restaurants-hotpepper/runs": { "post": { "operationId": "runs-sync-jpopendata-japan-restaurants-hotpepper", "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/jpopendata~japan-restaurants-hotpepper/run-sync": { "post": { "operationId": "run-sync-jpopendata-japan-restaurants-hotpepper", "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", "type": "string", "description": "REQUIRED. Japanese prefecture: English name (\"Tokyo\"), Japanese (\"東京都\") or JIS code (\"13\").", "default": "Tokyo" }, "genre": { "title": "Genre", "type": "string", "description": "Optional. A HotPepper genre code from the site URL (`G001` from https://www.hotpepper.jp/SA11/G001/), a Japanese label (居酒屋, 和食, ラーメン, ...) or an English alias: izakaya, japanese, western, italian, french, chinese, yakiniku, asian, karaoke, bar, ramen, cafe, okonomiyaki, korean... Unknown values are refused with guidance — never silent wrong data. Leave empty to walk ALL 17 genres in site order." }, "area": { "title": "Area filter", "type": "string", "description": "Optional. A place-name substring (e.g. \"新宿\", \"Shibuya\" in Japanese: \"渋谷\") matched CLIENT-SIDE against each restaurant's sub-area name, access line, station and address. Records that do not match are skipped before any detail request is spent on them. Leave empty for the whole prefecture." }, "detailFetch": { "title": "Fetch detail pages", "type": "boolean", "description": "When true, each record costs one extra request and adds the published business info: street address, business phone (from the page's structured data — the phone-reveal endpoint is never called), opening hours, closed days, nearest station, seat count, banquet capacity and facility facts (private rooms, tatami, counter, charter, Wi-Fi, parking, smoking policy, all-you-can-drink/eat, credit cards). When false (default), the actor emits listing data only — 20 records per request with name, genre, sub-area, budgets, access line, phone (when listed) and coordinates.", "default": false }, "maxItems": { "title": "Max records", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Stop after this many dataset records.", "default": 40 }, "maxApiRequests": { "title": "Max upstream requests", "minimum": 1, "maximum": 60, "type": "integer", "description": "Hard budget of HTTP requests to hotpepper.jp for this run (1 per listing page of 20 restaurants + 1 per detail page). Requests are strictly serial with >= 1.2 s spacing. When the budget runs out the run completes with complete=false in RUN_SUMMARY.", "default": 15 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy settings. Default: no proxy. Never used for rotation/evasion — a single serial session is kept per run." } } }, "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 } } } } } } } } } }