{ "openapi": "3.0.1", "info": { "title": "OpenRice Scraper — Hong Kong Restaurant Data", "description": "Scrape OpenRice Hong Kong: ~28,800 open restaurants with review scores, HKD price bands, opening hours, cuisines, bilingual addresses, phones and GPS. Business listings only.", "version": "0.1", "x-build-id": "aidZprFHtaRsVlWvQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hkdatafeeds~hong-kong-restaurants-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hkdatafeeds-hong-kong-restaurants-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/hkdatafeeds~hong-kong-restaurants-scraper/runs": { "post": { "operationId": "runs-sync-hkdatafeeds-hong-kong-restaurants-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/hkdatafeeds~hong-kong-restaurants-scraper/run-sync": { "post": { "operationId": "run-sync-hkdatafeeds-hong-kong-restaurants-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": { "keywords": { "title": "Search keywords", "type": "string", "description": "Free-text search, e.g. 'dim sum', 'ramen', a restaurant name or a street. Leave empty to scrape everything." }, "districtId": { "title": "District ID", "type": "string", "description": "Optional district filter (open venues in brackets). Regions: 1999 = Hong Kong Island (7,633), 2999 = Kowloon (10,857), 3999 = New Territories (9,397), 4999 = Outlying Islands (917). Districts: 2008 = Tsim Sha Tsui (1,791), 1003 = Central (1,343), 3003 = Yuen Long (1,292), 3018 = Tsuen Wan (1,272), 3005 = Tuen Mun (1,254), 2026 = Kwun Tong (1,138), 2010 = Mong Kok (1,135), 1022 = Wan Chai (1,071), 1019 = Causeway Bay (1,056), 3007 = Sha Tin (821), 3020 = Tseung Kwan O (770), 2019 = Sham Shui Po (761). Neighbourhoods (overlap the districts): -9006 = Soho, -9007 = Lan Kwai Fong, -35242 = Kennedy Town, -35244 = Sai Ying Pun. The README lists all 85 districts." }, "cuisineId": { "title": "Cuisine ID", "type": "string", "description": "Optional cuisine filter (open venues in brackets). 1004 = Hong Kong Style (10,671), 4000 = Western (4,445), 1002 = Guangdong (3,438), 2009 = Japanese (3,252), 6000 = International (1,780), 1009 = Taiwan (1,216), 2004 = Thai (802), 1008 = Sichuan (738), 3006 = Italian (688), 4001 = American (657), 2001 = Korean (503), 1001 = Chiu Chow (481), 2002 = Vietnamese (328)." }, "maxItems": { "title": "Maximum restaurants", "minimum": 1, "maximum": 40000, "type": "integer", "description": "Hard cap on how many restaurants to return. The whole city is about 28,900 open venues and takes about 40 minutes; above 10,000 the Actor splits the search by district to get past the source's paging limit. The run also stops at the number of restaurants your Maximum cost per run pays for.", "default": 200 }, "includeInactive": { "title": "Include moved and renovating venues", "type": "boolean", "description": "Off by default: only currently open venues are returned. Turn on to also get venues marked moved (listed again at their new address, see moved_to_poi_id) or under renovation, e.g. to study churn.", "default": false }, "requestDelaySeconds": { "title": "Delay between requests (seconds)", "minimum": 1, "maximum": 10, "type": "integer", "description": "Politeness delay. Keep at 1 or higher to stay well-behaved.", "default": 1 } } }, "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 } } } } } } } } } }