{ "openapi": "3.0.1", "info": { "title": "Kiwi Directory Scraper - New Zealand Business Directory", "description": "Scrape kiwidirectory.co.nz, a New Zealand business directory. Search by category and region, or fetch full business profiles by URL. Get names, addresses, phone numbers, categories, opening hours, websites, social links, images and geo-coordinates.", "version": "1.0", "x-build-id": "TcmYhjcmWpkdkYMth" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~kiwi-directory-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-kiwi-directory-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/crawlerbros~kiwi-directory-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-kiwi-directory-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/crawlerbros~kiwi-directory-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-kiwi-directory-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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "byCategory", "byRegion", "byUrl" ], "type": "string", "description": "What to fetch: a general search (category and/or region and/or keyword), browse one category, browse one region, or fetch full business profiles from direct listing URLs.", "default": "search" }, "category": { "title": "Category", "enum": [ "", "automotive", "entertainment", "health", "home-garden", "marine", "miscellaneous", "professional", "real-estate", "travel-tourism" ], "type": "string", "description": "Business category to browse (mode=search or mode=byCategory). Leave as 'All categories' to not filter by category.", "default": "" }, "region": { "title": "Region", "enum": [ "", "auckland", "canterbury", "northland", "wellington", "waikato", "marlborough", "manawatu-whanganui" ], "type": "string", "description": "New Zealand region to browse or filter by (mode=search or mode=byRegion). Leave as 'All regions' to not filter by region.", "default": "" }, "keyword": { "title": "Keyword", "type": "string", "description": "Free-text keyword to search business names/descriptions for, e.g. 'plumber' or 'cafe' (mode=search, used only when 'Category' is 'All categories'). Matches kiwidirectory.co.nz's own search index.", "default": "" }, "businessUrls": { "title": "Business profile URLs (mode=byUrl)", "type": "array", "description": "Direct kiwidirectory.co.nz listing URLs to fetch, e.g. https://kiwidirectory.co.nz/listings/some-business/. Use the 'sourceUrl' field from search results.", "items": { "type": "object", "properties": { "url": { "title": "URL", "type": "string", "description": "kiwidirectory.co.nz listing URL." } } }, "default": [] }, "sortBy": { "title": "Sort order", "enum": [ "relevance", "name", "region" ], "type": "string", "description": "How to order results after fetching (mode=search, byCategory, byRegion). The site itself only returns its own listing order, so 'name' and 'region' are applied client-side across the fetched batch.", "default": "relevance" }, "hasWebsiteOnly": { "title": "Only businesses with a website", "type": "boolean", "description": "Only return businesses that have a website link on their listing.", "default": false }, "hasPhoneOnly": { "title": "Only businesses with a phone number", "type": "boolean", "description": "Only return businesses that have a phone number on their listing.", "default": false }, "featuredOnly": { "title": "Only featured listings", "type": "boolean", "description": "Only return businesses that kiwidirectory.co.nz marks with its own 'Featured' badge on the listing/browse pages (mode=search, byCategory, byRegion).", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 500, "type": "integer", "description": "Hard cap on the number of business records to return.", "default": 20 } } }, "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 } } } } } } } } } }