{ "openapi": "3.0.1", "info": { "title": "Google Business Profile Scraper", "description": "Collect rich, source-backed public Google Maps business profile records with bounded search, optional detail visits, and clean business-only dataset output.", "version": "1.1", "x-build-id": "XW53MScEu2DQV7jgB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/googleapi~google-business-profile-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-googleapi-google-business-profile-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/googleapi~google-business-profile-scraper/runs": { "post": { "operationId": "runs-sync-googleapi-google-business-profile-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/googleapi~google-business-profile-scraper/run-sync": { "post": { "operationId": "run-sync-googleapi-google-business-profile-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": { "q": { "title": "Maps search query", "maxLength": 300, "type": "string", "description": "Public Google Maps search phrase. Used when no custom URL is supplied." }, "searchQuery": { "title": "Maps search query (alias)", "maxLength": 300, "type": "string", "description": "Compatibility alias for q." }, "queries": { "title": "Maps search queries", "maxItems": 50, "type": "array", "description": "Up to 50 public Maps search phrases.", "items": { "type": "string", "maxLength": 300 } }, "searchKeywords": { "title": "Search queries (alias)", "maxItems": 50, "type": "array", "description": "Compatibility alias for queries.", "items": { "type": "string", "maxLength": 300 } }, "startUrls": { "title": "Google Maps URLs", "maxItems": 100, "type": "array", "description": "Public Maps search or business-profile URLs. Custom URLs take precedence over generated queries.", "items": { "type": "object", "properties": { "url": { "title": "URL", "description": "HTTPS Google Maps search or business-profile URL.", "type": "string", "maxLength": 2000, "pattern": "^https:\\/\\/(?:www\\.google\\.com|google\\.com|maps\\.google\\.com)\\/maps(?:\\/|[?#]|$)" } }, "required": [ "url" ], "additionalProperties": false }, "default": [] }, "sourceUrls": { "title": "Source URLs (alias)", "maxItems": 100, "type": "array", "description": "Compatibility alias for startUrls.", "items": { "type": "string", "maxLength": 2000 } }, "urls": { "title": "URLs (alias)", "maxItems": 100, "type": "array", "description": "Compatibility alias for startUrls.", "items": { "type": "string", "maxLength": 2000 } }, "url": { "title": "Single Maps URL (alias)", "maxLength": 2000, "type": "string", "description": "Compatibility alias for one public Maps URL." }, "sourceUrl": { "title": "Single source URL (alias)", "maxLength": 2000, "type": "string", "description": "Compatibility alias for one public Maps URL." }, "maxItems": { "title": "Maximum businesses", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Global maximum number of normal business records.", "default": 100 }, "maxResults": { "title": "Maximum businesses (alias)", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Compatibility alias for maxItems." }, "maxPages": { "title": "Maximum result pages", "minimum": 1, "maximum": 30, "type": "integer", "description": "Maximum bounded result-feed scroll rounds per source.", "default": 5 }, "page": { "title": "Starting result page", "minimum": 1, "maximum": 30, "type": "integer", "description": "One-based feed page to begin at. Earlier result-feed sections are scrolled past first.", "default": 1 }, "deduplicate": { "title": "Deduplicate businesses", "type": "boolean", "description": "Remove repeated Place IDs across pages and search sources.", "default": true }, "keyword": { "title": "Business text filter", "maxLength": 200, "type": "string", "description": "Case-insensitive filter over public name, business category, and address." }, "minRating": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Keep businesses with a public rating at or above this value." }, "minReviewCount": { "title": "Minimum review count", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Keep businesses with a public review count at or above this value." }, "sortBy": { "title": "Sort businesses", "enum": [ "source", "name_asc", "rating_desc", "review_count_desc" ], "type": "string", "description": "Stable global order after collection and filtering.", "default": "source" }, "includeImages": { "title": "Include public photos", "type": "boolean", "description": "Include publicly displayed Google-hosted business photo URLs.", "default": true }, "includeProfileDetails": { "title": "Open profile details", "type": "boolean", "description": "Optionally visit each result profile to collect richer public business details, including weekly hours, review insights, service attributes, photos, and action links. Disabled by default; directly supplied profile URLs are still read as profiles.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify proxy configuration for public Google Maps navigation. Respect the target site's access controls; the Actor does not bypass challenges." } } }, "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 } } } } } } } } } }