{ "openapi": "3.0.1", "info": { "title": "LINK Business Scraper - Businesses for Sale NZ & AU", "description": "Scrape businesses for sale from LINK Business Brokers in New Zealand and Australia: asking price, profit, sales revenue, industry, region, city and full description. Filter by country, industry, location, price or keyword. Export to Excel, CSV, JSON or API.", "version": "0.1", "x-build-id": "jy9jjbchOi3M7WmcS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pshivam~link-business-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pshivam-link-business-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/pshivam~link-business-scraper/runs": { "post": { "operationId": "runs-sync-pshivam-link-business-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/pshivam~link-business-scraper/run-sync": { "post": { "operationId": "run-sync-pshivam-link-business-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": { "countries": { "title": "Countries", "type": "array", "description": "New Zealand, Australia or both. Default: both.", "items": { "type": "string", "enum": [ "NZ", "AU" ], "enumTitles": [ "New Zealand", "Australia" ] }, "default": [ "NZ", "AU" ] }, "industries": { "title": "Industries", "type": "array", "description": "Only these industries, e.g. 'Food/Hospitality' or 'Automotive'. Empty = all.", "items": { "type": "string", "enumSuggestedValues": [ "Accommodation/Motel/Hotel", "Accommodation/Tourism", "Automotive", "Bars/Nightclubs", "Beauty/Health", "Businesses with Real Estate", "Construction", "Dairies & Superettes", "Education/Training", "Food/Hospitality", "Franchise", "Home & Garden", "Home/Garden", "Import/Export/Wholesale", "Industrial Manufacturing", "Intellectual Property Rights", "Leisure/Entertainment", "Medical Services", "Professional", "Retail", "Retail Food", "Retail General", "Rural", "Services", "Technology / Computer / IT", "Tourism", "Transport/Distribution" ] } }, "locations": { "title": "Locations", "type": "array", "description": "Only listings whose region or city contains one of these words, e.g. 'Auckland', 'Canterbury', 'Gold Coast', 'Queensland' or 'Sydney'. Checked on the listing page (on the card region in fast mode).", "items": { "type": "string" } }, "keyword": { "title": "Keyword", "type": "string", "description": "Only listings that mention this word, e.g. \"cafe\", \"franchise\" or \"freehold\". Checked in the title and description (title only in fast mode)." }, "minPrice": { "title": "Minimum asking price", "minimum": 0, "type": "integer", "description": "In NZD or AUD. Listings with 'Refer to Broker' instead of a price are kept." }, "maxPrice": { "title": "Maximum asking price", "minimum": 0, "type": "integer", "description": "In NZD or AUD. Listings with 'Refer to Broker' instead of a price are kept." }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Optional: the businesses-for-sale list or single listing URLs, scraped as given.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "includeDetails": { "title": "Open each listing for full details", "type": "boolean", "description": "On: profit, sales revenue, city, subcategory and the full description. Off: a fast, cheaper run with what the list pages show.", "default": true }, "onlyNew": { "title": "Only new listings", "type": "boolean", "description": "Skip listings that earlier runs of this same search already returned, so you never get or pay for the same listing twice. Turn it on for a scheduled run or a saved task to get only what's new each time. The first run works as usual and remembers what it returned, in your key-value store 'link-business-scraper-only-new' (delete it to start over).", "default": false }, "maxItems": { "title": "Maximum listings", "minimum": 1, "type": "integer", "description": "Stop after this many listings. You are charged per listing.", "default": 100 }, "maxConcurrency": { "title": "Max parallel requests", "minimum": 1, "maximum": 8, "type": "integer", "description": "Pages loaded at the same time. Keep it low to be polite to the website.", "default": 4 } } }, "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 } } } } } } } } } }