{ "openapi": "3.0.1", "info": { "title": "Tabelog Japan Restaurant Scraper", "description": "Scrape Tabelog (食べログ) restaurant data across Japan's 47 prefectures: ratings, review counts, cuisine, budgets, nearest station, award badges and photos. Turn on details for address, phone, opening hours and payment methods, or reviews for reviewer, score, visit month and a short review preview.", "version": "1.0", "x-build-id": "UCtTbvubaziIcPpFn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/piquno~tabelog-japan-restaurant-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-piquno-tabelog-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~tabelog-japan-restaurant-scraper/runs": { "post": { "operationId": "runs-sync-piquno-tabelog-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~tabelog-japan-restaurant-scraper/run-sync": { "post": { "operationId": "run-sync-piquno-tabelog-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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Optional. Paste Tabelog search result (listing) pages, for example https://tabelog.com/en/tokyo/rstLst/?SrtT=rt, including ones with filters already applied on the site. Single restaurant pages do not work here. Overrides Area, Keyword and Sort.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "area": { "title": "Area (Prefecture)", "enum": [ "tokyo", "osaka", "kyoto", "hokkaido", "fukuoka", "aichi", "kanagawa", "chiba", "saitama", "hyogo", "hiroshima", "miyagi", "niigata", "nagano", "shizuoka", "okinawa", "nara", "ishikawa", "kumamoto", "kagoshima", "nagasaki", "oita", "ehime", "okayama", "fukui", "tottori", "shimane", "saga", "kochi", "tokushima", "kagawa", "wakayama", "mie", "gifu", "toyama", "fukushima", "yamagata", "akita", "iwate", "aomori", "tochigi", "gunma", "ibaraki", "yamanashi", "shiga", "yamaguchi", "miyazaki" ], "type": "string", "description": "Japanese prefecture to search. Ignored when Start URLs are given.", "default": "tokyo" }, "keyword": { "title": "Keyword", "type": "string", "description": "Search keyword (cuisine type, restaurant name, etc.). Supports Japanese: e.g. ラーメン, 寿司, yakitori", "default": "" }, "sort": { "title": "Sort By", "enum": [ "highest_rated", "most_reviews", "most_reserved_travelers", "most_reserved_locals", "most_viewed" ], "type": "string", "description": "Which restaurants come first. One search returns at most 500 restaurants, so this also decides which 500 you get.", "default": "highest_rated" }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of restaurants, in total across all Start URLs. Review rows are not counted here: they come on top and are billed as rows too. Tabelog shows at most 500 restaurants per search; use a narrower area or keyword to reach past that.", "default": 100 }, "includeDetails": { "title": "Include Detail Pages", "type": "boolean", "description": "Open each restaurant's own page for address, phone, opening hours, number of seats (when the restaurant lists it) and payment methods. Slower: about 3.9 s per restaurant instead of under half a second, so 100 restaurants take about 6.5 minutes instead of about 40 seconds.", "default": false }, "includeReviews": { "title": "Include individual reviews", "type": "boolean", "description": "Also return individual reviews for each restaurant: reviewer, star rating, meal time, visit month and a preview of the review text (about the first 100 characters). Each review is a separate row tagged recordType \"review\". Adds about 3.5 s per restaurant for every 20 reviews.", "default": false }, "maxReviewsPerRestaurant": { "title": "Max reviews per restaurant", "minimum": 1, "maximum": 500, "type": "integer", "description": "Most reviews returned per restaurant. Popular restaurants have hundreds; for example, a top Tokyo restaurant had 942. Each 20 reviews adds one page (about 3.5 s) per restaurant.", "default": 20 }, "includeFullReviewText": { "title": "Include full review text", "type": "boolean", "description": "Only with individual reviews on. Opens each review's own page and adds the complete text in a new field, reviewTextFull (line breaks kept). reviewText stays the short preview. Much slower: about 4-5 s more per review, so 100 restaurants x 20 reviews take over 2 hours longer (raise the run timeout for runs like that). Does not add rows.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave off. Turn on Apify Proxy only if the log or the run's status message shows blocked or empty pages.", "default": { "useApifyProxy": 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 } } } } } } } } } }