# Yellow Pages NZ Scraper (`abotapi/yellow-nz-scraper`) Actor Scrapes business listings from Yellow.co.nz (New Zealand Yellow Pages). Extract comprehensive business information, including contact details, emails, ratings, reviews, opening hours, and geo coordinates. - **URL**: https://apify.com/abotapi/yellow-nz-scraper.md - **Developed by:** [AbotAPI](https://apify.com/abotapi) (community) - **Categories:** Lead generation, Automation, Developer tools - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $0.80 / 1,000 results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have. 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.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.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/platform/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 ## Yellow NZ Business Scraper Scrapes business listings from Yellow.co.nz (New Zealand Yellow Pages). Extract comprehensive business information including contact details, emails, ratings, reviews, opening hours, and geo coordinates. ### Features #### Core Capabilities - **Comprehensive Data Extraction**: Business names, phone, email, address, ratings, reviews, opening hours, geo coordinates, and more - **Flexible Search**: Search by any keyword and location across New Zealand - **Pagination Support**: Automatically handles pagination to fetch all results - **Detail Page Enrichment**: Optional deep scraping via JSON-LD structured data for full business profiles - **Proxy Support**: Optional proxy configuration for large-scale scraping #### Perfect for Lead Generation - **Direct Contact Information**: Extract phone numbers and email addresses for immediate outreach - **Location Intelligence**: Full addresses with latitude/longitude coordinates for geo-targeting - **Business Verification**: Year established, associations, and payment methods for lead qualification - **Customer Reviews**: Star ratings, review counts, and full review text for quality assessment #### AI-Ready Data Structure - **Structured JSON Output**: Clean, consistent data format perfect for AI processing and analysis - **Rich Context**: Business descriptions, services, slogan, and customer reviews for AI understanding - **Geo Data**: Latitude/longitude coordinates for location-based analysis and mapping - **Training Data**: Comprehensive business profiles ideal for training recommendation systems ### Input Parameters | Parameter | Type | Description | Default | |-----------|------|-------------|---------| | `searchTerms` | string | Business type or keyword (e.g., 'Plumbers', 'Restaurants') | `Plumbers` | | `location` | string | Location (e.g., 'New Zealand', 'Auckland', 'Wellington') | `New Zealand` | | `maxPages` | integer | Maximum search result pages to scrape (1-100) | `5` | | `scrapeDetails` | boolean | Fetch detail pages for rich data (email, geo, hours, reviews) | `true` | | `maxConcurrency` | integer | Concurrent detail page requests (1-20) | `5` | | `proxy` | object | Optional proxy configuration | `null` | ### Output Format #### Search-Only Data Each business record includes: ```json { "name": "Crawshaw Sample Ltd", "phone": "07 012 1234", "address": "Servicing: Waikato Region", "categories": ["Plumbers"], "rating": 5.0, "reviewCount": 2, "openStatus": "CLOSED NOW", "website": "https://example.co.nz", "description": "At Sample Plumbers we are experienced...", "detailUrl": "https://yellow.co.nz/hamilton/bpp/crawshaw-plumbers-ltd-12345678", "searchTerms": "Plumbers", "searchLocation": "New Zealand" } ```` #### Enriched Data (when `scrapeDetails: true`) Additional fields from detail pages: ```json { "email": "info@example.co.nz", "fullAddress": { "street": "10 Sample Street", "locality": "Lower Hutt", "region": "WGN", "postalCode": "5012", "country": "NZ" }, "latitude": -41.232006, "longitude": 174.89116, "openingHours": ["Mo-Fr 07:00-17:00", "Sa 08:00-12:00"], "paymentAccepted": "visa, cash, mastercard", "imageUrl": "https://i3.ypcdn.com/blob/...", "logoUrl": "https://i1.ypcdn.com/blob/...", "reviews": [ { "author": "John Smith", "rating": 5, "text": "Excellent service...", "date": "2024-03-15" } ], "yearEstablished": "1950", "slogan": "Your trusted local plumber", "associations": "Master Plumbers, Gasfitters & Drainlayers NZ", "generalInfo": "Full business description...", "servicesAndProducts": ["Plumbing", "Drainage", "Gasfitting"] } ``` # Actor input Schema ## `searchTerms` (type: `string`): Business type or keyword to search for (e.g., 'Plumbers', 'Electricians', 'Restaurants') ## `location` (type: `string`): Location to search in (e.g., 'New Zealand', 'Auckland', 'Wellington', 'Christchurch') ## `maxPages` (type: `integer`): Maximum number of search result pages to scrape (30 results per page) ## `scrapeDetails` (type: `boolean`): Fetch each business's detail page for rich data: email, full address, geo coordinates, opening hours, reviews, year established. Slower but much more comprehensive. ## `maxConcurrency` (type: `integer`): Maximum concurrent detail page requests. Lower values are safer against rate limiting. ## `proxy` (type: `object`): Optional proxy settings. Recommended for large scrapes to avoid IP-based blocking. ## Actor input object example ```json { "searchTerms": "Plumbers", "location": "New Zealand", "maxPages": 2, "scrapeDetails": true, "maxConcurrency": 5 } ``` # Actor output Schema ## `businesses` (type: `string`): Individual business records with contact info, ratings, reviews, and location data # 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 = {}; // Run the Actor and wait for it to finish const run = await client.actor("abotapi/yellow-nz-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 = {} # Run the Actor and wait for it to finish run = client.actor("abotapi/yellow-nz-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 '{}' | apify call abotapi/yellow-nz-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=abotapi/yellow-nz-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Yellow Pages NZ Scraper", "description": "Scrapes business listings from Yellow.co.nz (New Zealand Yellow Pages). Extract comprehensive business information, including contact details, emails, ratings, reviews, opening hours, and geo coordinates.", "version": "0.1", "x-build-id": "haNFWuKIm5RCkXAPr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abotapi~yellow-nz-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abotapi-yellow-nz-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/abotapi~yellow-nz-scraper/runs": { "post": { "operationId": "runs-sync-abotapi-yellow-nz-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/abotapi~yellow-nz-scraper/run-sync": { "post": { "operationId": "run-sync-abotapi-yellow-nz-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", "required": [ "searchTerms", "location" ], "properties": { "searchTerms": { "title": "Search Terms", "type": "string", "description": "Business type or keyword to search for (e.g., 'Plumbers', 'Electricians', 'Restaurants')", "default": "Plumbers" }, "location": { "title": "Location", "type": "string", "description": "Location to search in (e.g., 'New Zealand', 'Auckland', 'Wellington', 'Christchurch')", "default": "New Zealand" }, "maxPages": { "title": "Maximum Pages", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of search result pages to scrape (30 results per page)", "default": 2 }, "scrapeDetails": { "title": "Scrape Detail Pages", "type": "boolean", "description": "Fetch each business's detail page for rich data: email, full address, geo coordinates, opening hours, reviews, year established. Slower but much more comprehensive.", "default": true }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum concurrent detail page requests. Lower values are safer against rate limiting.", "default": 5 }, "proxy": { "title": "Proxy Configuration", "type": "object", "description": "Optional proxy settings. Recommended for large scrapes to avoid IP-based blocking." } } }, "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 } } } } } } } } } } ```