{ "openapi": "3.0.1", "info": { "title": "Yellow Pages NZ Scraper — Business Leads, Phone & Email", "description": "Scrape New Zealand business leads from yellow.co.nz — name, phone, email, website, category, full split address, coordinates, opening hours, rating, reviews and description. Search by keyword + city or paste yellow.co.nz URLs. Email included in every result. JSON/CSV export.", "version": "0.0", "x-build-id": "IFyTcDV6WlGFUS5rS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/memo23~yellowpages-nz-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-memo23-yellowpages-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/memo23~yellowpages-nz-scraper/runs": { "post": { "operationId": "runs-sync-memo23-yellowpages-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/memo23~yellowpages-nz-scraper/run-sync": { "post": { "operationId": "run-sync-memo23-yellowpages-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", "properties": { "searchQueries": { "title": "Search Queries", "type": "array", "description": "Business types or keywords to search on yellow.co.nz, one per line (e.g. plumber, cafe, accountant, electrician). Each query runs across every location in the Locations field.", "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "New Zealand cities or regions to search, one per line (e.g. Auckland, Wellington, Christchurch). Leave empty to search nationwide (New Zealand).", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs (paste yellow.co.nz links)", "type": "array", "description": "Paste yellow.co.nz search or business-profile URLs, one per line. A search URL (https://www.yellow.co.nz/search?search_terms=plumber&geo_location_terms=Auckland) is decomposed into its keyword + location and returns the same results. A business-profile URL (https://www.yellow.co.nz/auckland/bpp/ak-speech-therapy-579486261) is scraped directly for full details. Combines with the Search Queries / Locations fields.", "items": { "type": "string" } }, "fetchFullDetails": { "title": "Fetch Full Details (Email + Hours + Reviews)", "type": "boolean", "description": "When on, each business profile page is opened to add its email, full split address, opening hours, coordinates, description, payment methods, and reviews. When off, only the fast listing-level fields (name, phone, category, website, address, rating) are returned. Email is only available with full details.", "default": true }, "maxItems": { "title": "Max Businesses", "type": "integer", "description": "Maximum number of businesses to collect across all searches.", "default": 1000 }, "maxPages": { "title": "Max pages per search", "type": "integer", "description": "Maximum number of search pages to crawl per query×location (30 businesses per page). 0 = unlimited.", "default": 0 }, "maxConcurrency": { "title": "Max concurrency", "type": "integer", "description": "Maximum number of pages fetched in parallel.", "default": 10 }, "proxy": { "title": "Proxy configuration (optional override)", "type": "object", "description": "Leave empty to use the default residential proxy. yellow.co.nz is behind Cloudflare, so a residential proxy is required." } } }, "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 } } } } } } } } } }