{ "openapi": "3.0.1", "info": { "title": "Local Business Growth Signal Enricher", "description": "Enrich local business leads with public growth and outreach signals - website presence, ratings, review volume, contact and digital-presence hints, and a transparent growth/opportunity score. One flat CSV-ready row per business. No login or cookies.", "version": "1.0", "x-build-id": "KyHBc5x6C9dusYadP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/coregent~local-business-growth-signal-enricher/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-coregent-local-business-growth-signal-enricher", "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/coregent~local-business-growth-signal-enricher/runs": { "post": { "operationId": "runs-sync-coregent-local-business-growth-signal-enricher", "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/coregent~local-business-growth-signal-enricher/run-sync": { "post": { "operationId": "run-sync-coregent-local-business-growth-signal-enricher", "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": { "inputMode": { "title": "Input mode", "enum": [ "businessUrls", "searchQueries", "mixed" ], "type": "string", "description": "How to interpret your inputs. \"Business URLs\" treats each item as a business website or Google Maps place URL. \"Search queries\" runs lightweight public discovery on local search terms. \"Mixed\" accepts both (URL-like values are fetched directly; the rest are treated as queries).", "default": "businessUrls" }, "businessUrls": { "title": "Business URLs", "type": "array", "description": "Direct business website URLs or Google Maps place URLs to enrich, for example \"https://www.exampleplumbing.com.au\" or a Google Maps place link. Used when input mode is \"Business URLs\" or \"Mixed\". Max 1,000 per run.", "default": [], "items": { "type": "string" } }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Lightweight local search terms such as \"plumbers Canberra\" or \"restaurants Parramatta\". Used when input mode is \"Search queries\" or \"Mixed\". Discovery is best-effort and less stable without a proxy. Max 100 per run.", "default": [], "items": { "type": "string" } }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of valid unique business rows to save per run. The run stops saving once this is reached. Range 1-5000.", "default": 100 }, "maxResultsPerQuery": { "title": "Max results per query", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum businesses discovered per search query (search/mixed modes only). Prevents one query from consuming the whole run. Range 1-500.", "default": 50 }, "includeHomepageSignals": { "title": "Include homepage signals", "type": "boolean", "description": "For businesses with a website, fetch the homepage once to derive title, meta description, HTTPS status, and contact/social hints. Turning this off skips all website fetches.", "default": true }, "includeContactPageHint": { "title": "Include contact-page hint", "type": "boolean", "description": "Detect whether the homepage links to a likely contact/booking/quote page. Only the homepage is read - the contact page itself is not crawled.", "default": true }, "minRating": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Keep only businesses with a rating at or above this value (decimals allowed, e.g. 4.5). Businesses with no visible rating pass this filter. Range 0-5.", "default": 0 }, "minReviews": { "title": "Minimum reviews", "minimum": 0, "type": "integer", "description": "Keep only businesses with at least this many visible reviews. Businesses with no visible review count pass this filter.", "default": 0 }, "requireWebsite": { "title": "Require website", "type": "boolean", "description": "Keep only businesses that have a detected website URL.", "default": false }, "onlyMissingWebsite": { "title": "Only businesses missing a website", "type": "boolean", "description": "Keep only businesses without a detected website - useful for web design / SEO prospecting. Ignored if \"Require website\" is also enabled.", "default": false }, "categoryKeywords": { "title": "Category keywords", "type": "array", "description": "Keep only businesses whose category (or, if missing, name) contains at least one of these keywords, for example \"plumber\", \"electrician\".", "default": [], "items": { "type": "string" } }, "locationKeywords": { "title": "Location keywords", "type": "array", "description": "Keep only businesses whose address/city/state/country contains at least one of these keywords, for example \"Canberra\". Businesses with no detected location are filtered out.", "default": [], "items": { "type": "string" } }, "deduplicate": { "title": "Deduplicate businesses", "type": "boolean", "description": "Return only one row per business (by place URL, website domain, phone, or name + address) so you are not charged for duplicates.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy configuration. Defaults to Apify Proxy enabled. Apify Residential is NOT supported and will fail the run at startup; if you need residential routing, supply your own provider via Custom proxy URLs (proxyUrls).", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }