# Hong Kong Business Directory Scraper (`nickslam/yelo-hk-scraper`) Actor Scrapes business directory data from Yelo.hk (Hong Kong) including company information, reviews, products, and more - **URL**: https://apify.com/nickslam/yelo-hk-scraper.md - **Developed by:** [Nick](https://apify.com/nickslam) (community) - **Categories:** Lead generation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $0.50 / 1,000 base 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/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.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/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 ## 📁 Hong Kong Business Directory Scraper Scrapes business directory data from [Yelo.hk](https://www.yelo.hk/), the Hong Kong online business directory. Find companies by keyword search, category, or location and extract their contact details, descriptions, and more. --- ### đŸŽ¯ What It Does The Actor browses Yelo.hk and extracts company information into structured data. You can: - **Filter by category** – e.g. restaurants, consultants, estate-agents - **Search by keywords** – e.g. "Lawyers", "IT consulting", "Bakeries" - **Browse the full directory** – leave filters empty to scrape the entire directory Results are saved as a dataset you can download as JSON, CSV, or Excel. --- ### ⚙ī¸ What You Can Configure #### 🔍 Search & Filters | Option | Description | |--------|-------------| | **Categories** | Filter by business type (e.g. restaurants, consultants) | | **Search Keywords** | Search for specific companies or terms | #### 📊 Scope & Limits | Option | Description | |--------|-------------| | **Max Results** | Maximum number of companies to scrape (default: 20) | | **Max Pages** | Maximum listing pages to crawl (default: 5) | | **Start Page** | Page number to start from (useful for resuming previous searches) | #### đŸ“Ļ Data Options | Option | What It Adds | |--------|---------------| | **Include Contact & Details** | Business hours, year established, employees, contact person | | **Include Extended Company Information** | Website URL, description, Google Maps coordinates | | **Include Registration & Legal** | Registration number, GST/VAT-style numbers if shown | | **Include Metadata** | Listing type, verified status, years with platform, tags | | **Include Media & Content** | Photos, logo, products/services | | **Include Review Summary** | Average rating and review count | | **Include Individual Reviews** | Full review text, author, date (slower – requires extra pages) | #### ℹī¸ Other | Option | Description | |--------|-------------| | **Enable Rate Limiting** | Add delays between requests (recommended: On) | --- ### 📋 What Data You Get Every company record includes the **core fields** (always included): - **Company Name** - **Company URL** – link to the profile on Yelo.hk - **Phone Number** - **Address** - **Categories** – business types - **Location** – typically Hong Kong **Optional fields** (enable in the input) add website, description, maps, hours, registration, media, reviews, and metadata — same structure as other Yello-family directory actors in this monorepo. --- ### 📤 Output Format The Actor outputs a dataset. Each item is one company with the selected fields. Download as **JSON**, **CSV**, or **Excel** from the Apify run. --- ### 💰 Pricing (Pay per event) The Actor uses tiered pricing based on your input: | Tier | Price per 1,000 results | When it applies | |------|--------------------------|-----------------| | **Base** | $0.50 | No extended fields, no search keywords, no individual reviews | | **Extended** | $1.00 | Any extended / metadata / media / review-summary options | | **Premium** | $2.00 | Search keywords **or** Include Individual Reviews | --- ### 💡 Tips - **Rate limiting** – Keep enabled to reduce the chance of being blocked. - **Individual reviews** – Turn on only when needed; it makes the run slower. - **Proxy** – Residential **HK** proxy is preconfigured for Cloudflare-heavy pages. # Actor input Schema ## `categories` (type: `array`): Optional: Filter by business categories. Example: For category page like `https://www.yelo.hk/category/estate-agents` enter only `estate-agents`. ## `searchKeywords` (type: `string`): Optional: Search for specific companies or keywords. Enables premium pricing. ## `locations` (type: `string`): Hidden default: `hong-kong` (single location on this site). Use empty string via API to browse/search without a location filter. ## `maxResults` (type: `integer`): Maximum number of companies to scrape ## `startPage` (type: `integer`): Page number to start scraping from. Useful for resuming previous searches. ## `maxPages` (type: `integer`): Maximum number of pages to scrape. Each page usually contains around 20 companies. ## `enableRateLimiting` (type: `boolean`): Enable rate limiting (2 seconds delay) or disable (0.5 seconds delay) ## `hybridStrategy` (type: `string`): `fast` = Cheerio + Impit HTTP (default). `browser` = Playwright (fallback). ## `includeContactDetails` (type: `boolean`): Include business hours, year established, employees, contact person ## `includeExtendedCompanyInfo` (type: `boolean`): Include website, description, and maps coordinates ## `includeRegistrationLegal` (type: `boolean`): Include registration number and VAT number ## `includeMetadata` (type: `boolean`): Include listing type, verified status, years with platform, tags ## `includeMediaContent` (type: `boolean`): Include photos, logo, products ## `includeReviewSummary` (type: `boolean`): Include review summary (rating and count) - Fast extraction ## `includeIndividualReviews` (type: `boolean`): Include individual reviews - Slower (requires additional pages). Enables premium pricing. ## `proxy` (type: `object`): Select proxies to be used by the crawler. Recommended: Use Apify Proxy with Residential proxies for better Cloudflare bypass. ## Actor input object example ```json { "categories": [ "restaurants", "consultants" ], "searchKeywords": "restaurant, IT services", "locations": "hong-kong", "maxResults": 20, "startPage": 1, "maxPages": 5, "enableRateLimiting": true, "hybridStrategy": "fast", "includeContactDetails": false, "includeExtendedCompanyInfo": false, "includeRegistrationLegal": false, "includeMetadata": false, "includeMediaContent": false, "includeReviewSummary": false, "includeIndividualReviews": false, "proxy": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "HK" } } ```` # Actor output Schema ## `companyData` (type: `string`): Dataset containing all scraped company information # 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 = { "categories": [ "restaurants" ], "locations": "hong-kong", "proxy": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "HK" } }; // Run the Actor and wait for it to finish const run = await client.actor("nickslam/yelo-hk-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 = { "categories": ["restaurants"], "locations": "hong-kong", "proxy": { "useApifyProxy": True, "apifyProxyGroups": ["RESIDENTIAL"], "apifyProxyCountry": "HK", }, } # Run the Actor and wait for it to finish run = client.actor("nickslam/yelo-hk-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 '{ "categories": [ "restaurants" ], "locations": "hong-kong", "proxy": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "HK" } }' | apify call nickslam/yelo-hk-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=nickslam/yelo-hk-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Hong Kong Business Directory Scraper", "description": "Scrapes business directory data from Yelo.hk (Hong Kong) including company information, reviews, products, and more", "version": "1.0", "x-build-id": "rqwpMZJPQtLbU1EhH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nickslam~yelo-hk-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nickslam-yelo-hk-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/nickslam~yelo-hk-scraper/runs": { "post": { "operationId": "runs-sync-nickslam-yelo-hk-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/nickslam~yelo-hk-scraper/run-sync": { "post": { "operationId": "run-sync-nickslam-yelo-hk-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": { "categories": { "title": "Categories", "type": "array", "description": "Optional: Filter by business categories.\n\nExample: For category page like `https://www.yelo.hk/category/estate-agents` enter only `estate-agents`.", "items": { "type": "string" } }, "searchKeywords": { "title": "Search Keywords ($$)", "type": "string", "description": "Optional: Search for specific companies or keywords. Enables premium pricing." }, "locations": { "title": "Locations", "type": "string", "description": "Hidden default: `hong-kong` (single location on this site). Use empty string via API to browse/search without a location filter." }, "maxResults": { "title": "Max Results", "minimum": 1, "type": "integer", "description": "Maximum number of companies to scrape", "default": 20 }, "startPage": { "title": "Start Page", "minimum": 1, "type": "integer", "description": "Page number to start scraping from. Useful for resuming previous searches.", "default": 1 }, "maxPages": { "title": "Max Pages", "minimum": 1, "type": "integer", "description": "Maximum number of pages to scrape. Each page usually contains around 20 companies.", "default": 5 }, "enableRateLimiting": { "title": "Enable Rate Limiting", "type": "boolean", "description": "Enable rate limiting (2 seconds delay) or disable (0.5 seconds delay)", "default": true }, "hybridStrategy": { "title": "Strategy", "type": "string", "description": "`fast` = Cheerio + Impit HTTP (default). `browser` = Playwright (fallback).", "default": "fast" }, "includeContactDetails": { "title": "Include Contact & Details ($)", "type": "boolean", "description": "Include business hours, year established, employees, contact person", "default": false }, "includeExtendedCompanyInfo": { "title": "Include Extended Company Information ($)", "type": "boolean", "description": "Include website, description, and maps coordinates", "default": false }, "includeRegistrationLegal": { "title": "Include Registration & Legal ($)", "type": "boolean", "description": "Include registration number and VAT number", "default": false }, "includeMetadata": { "title": "Include Metadata ($)", "type": "boolean", "description": "Include listing type, verified status, years with platform, tags", "default": false }, "includeMediaContent": { "title": "Include Media & Product Information ($)", "type": "boolean", "description": "Include photos, logo, products", "default": false }, "includeReviewSummary": { "title": "Include Review Summary ($)", "type": "boolean", "description": "Include review summary (rating and count) - Fast extraction", "default": false }, "includeIndividualReviews": { "title": "Include Individual Reviews ($$)", "type": "boolean", "description": "Include individual reviews - Slower (requires additional pages). Enables premium pricing.", "default": false }, "proxy": { "title": "Proxy Configuration", "type": "object", "description": "Select proxies to be used by the crawler. Recommended: Use Apify Proxy with Residential proxies for better Cloudflare bypass." } } }, "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 } } } } } } } } } } ```