{ "openapi": "3.0.1", "info": { "title": "Hot Pepper Gourmet Japan Restaurant Scraper", "description": "Public Hot Pepper Gourmet (ホットペッパーグルメ) restaurants: shop id, name, genre, budget, station, phone, coupons. Optional detail page. No start fee. Draft PPE only.", "version": "0.1", "x-build-id": "tAm3ueP98nYDfvzhZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/stone_jadex~hotpepper-gourmet-japan-restaurant-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-stone_jadex-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/stone_jadex~hotpepper-gourmet-japan-restaurant-scraper/runs": { "post": { "operationId": "runs-sync-stone_jadex-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/stone_jadex~hotpepper-gourmet-japan-restaurant-scraper/run-sync": { "post": { "operationId": "run-sync-stone_jadex-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", "properties": { "prefecture": { "title": "Prefecture", "enum": [ "SA41", "SA51", "SA52", "SA53", "SA54", "SA55", "SA56", "SA11", "SA12", "SA13", "SA14", "SA15", "SA16", "SA17", "SA61", "SA62", "SA63", "SA64", "SA65", "SA66", "SA31", "SA32", "SA33", "SA34", "SA21", "SA22", "SA23", "SA24", "SA25", "SA26", "SA71", "SA72", "SA73", "SA74", "SA75", "SA81", "SA82", "SA83", "SA84", "SA91", "SA92", "SA93", "SA94", "SA95", "SA96", "SA97", "SA98" ], "type": "string", "description": "Hot Pepper service-area code (SA##) or Japanese name. Default SA11 (東京).", "default": "SA11" }, "genre": { "title": "Genre", "enum": [ "G001", "G002", "G003", "G004", "G005", "G006", "G007", "G008", "G009", "G010", "G011", "G012", "G013", "G014", "G015", "G016", "G017" ], "type": "string", "description": "Optional Hot Pepper genre code (G001–G017)." }, "subArea": { "title": "Sub-area code", "type": "string", "description": "Optional Hot Pepper area code such as Y005 (銀座・新橋) or X020. Combined with prefecture/genre in the list URL." }, "startUrls": { "title": "List or shop URLs", "type": "array", "description": "Optional. A list URL such as https://www.hotpepper.jp/SA11/bgn1/ or a shop URL such as https://www.hotpepper.jp/strJ003763598/. Empty input uses prefecture/genre/subArea (default 東京).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max shops", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many charged shop rows. Alias: maxResults.", "default": 50 }, "maxResults": { "title": "Max shops (alias)", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Alias for maxItems." }, "maxPages": { "title": "Max list pages", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Optional. Each list page has about 22 shops." }, "includeDetails": { "title": "Open each shop page", "type": "boolean", "description": "Adds address, hours, seats, parking, rating, and other detail-table fields. Charged as shop-detail instead of shop.", "default": false }, "requestDelayMs": { "title": "Minimum gap between request starts (ms)", "minimum": 1000, "type": "integer", "description": "At least one second between request starts. A Crawl-delay in robots.txt can only raise this.", "default": 1000 }, "maxConcurrency": { "title": "Requests in flight", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many list or shop pages may be requested at once. Default 1 (serial). Starts are still spaced by requestDelayMs.", "default": 1 }, "maxRunSeconds": { "title": "Max run time (seconds)", "minimum": 30, "type": "integer", "description": "Stops cleanly and writes the OUTPUT record before this limit.", "default": 3600 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Direct connection by default (opt-in). Residential is a fallback only.", "default": { "useApifyProxy": false } }, "useProxyFallback": { "title": "Use proxy only after repeated blocks", "type": "boolean", "description": "Stay on a direct connection until repeated HTTP 403 or 429, then switch to the configured proxy.", "default": false }, "allowDetailOnResidential": { "title": "Allow shop pages on residential proxy", "type": "boolean", "description": "Shop detail pages stay on a direct connection when the proxy group is residential, unless this is on. Residential download budget is a fixed developer cap (5 MB), not user-tunable.", "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }