{ "openapi": "3.0.1", "info": { "title": "Google Maps Similar Places Scraper", "description": "Extracts public, source-labeled similar and related business recommendations from Google Maps place panels.", "version": "1.1", "x-build-id": "m4X853EhgpKZQknQV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/googleapi~google-maps-similar-places-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-googleapi-google-maps-similar-places-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-maps-similar-places-scraper/runs": { "post": { "operationId": "runs-sync-googleapi-google-maps-similar-places-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-maps-similar-places-scraper/run-sync": { "post": { "operationId": "run-sync-googleapi-google-maps-similar-places-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": { "startUrls": { "title": "Google Maps place or search URLs", "maxItems": 25, "type": "array", "description": "Public Maps place URLs are preferred. A Maps search URL is resolved to its first public place result.", "items": { "type": "object", "properties": { "url": { "title": "Google Maps URL", "type": "string", "description": "HTTP(S) Google Maps search or place URL.", "pattern": "^https?://(?:[^/]+\\.)?google\\.[^/]+/maps/" } }, "required": [ "url" ], "additionalProperties": false } }, "urls": { "title": "URL alias", "maxItems": 25, "type": "array", "description": "Compatibility alias for startUrls.", "items": { "type": "string", "minLength": 1, "pattern": "^https?://(?:[^/]+\\.)?google\\.[^/]+/maps/" } }, "queries": { "title": "Place search queries", "maxItems": 25, "type": "array", "description": "Maps searches used to find one source business when no place URLs are supplied.", "items": { "type": "string", "minLength": 3, "maxLength": 200 } }, "searchStringsArray": { "title": "Search queries (legacy)", "maxItems": 25, "type": "array", "description": "Compatibility alias for queries.", "items": { "type": "string", "minLength": 3, "maxLength": 200 } }, "searchKeywords": { "title": "Search keywords (legacy)", "maxItems": 25, "type": "array", "description": "Compatibility alias for queries.", "items": { "type": "string", "minLength": 3, "maxLength": 200 } }, "searchQuery": { "title": "Single place search", "maxLength": 200, "type": "string", "description": "Compatibility alias for one Maps place search." }, "similarTo": { "title": "Source business search (legacy)", "maxLength": 200, "type": "string", "description": "Compatibility alias for one source-place search. Similarity comes from Google's labeled recommendation section, not a locally generated score." }, "locationQuery": { "title": "Location suffix", "maxLength": 200, "type": "string", "description": "Optional location appended to generated place searches." }, "page": { "title": "Starting source page", "minimum": 1, "maximum": 25, "type": "integer", "description": "One-based starting position in the ordered list of supplied URLs or generated queries.", "default": 1 }, "maxItems": { "title": "Maximum similar places", "minimum": 1, "maximum": 100, "type": "integer", "description": "Global maximum of valid similar-business records." }, "maxCrawledPlacesPerSearch": { "title": "Maximum places (legacy)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Compatibility alias for maxItems." }, "maxPages": { "title": "Maximum source pages", "minimum": 1, "maximum": 25, "type": "integer", "description": "Maximum number of ordered source place or search pages to visit, starting at page.", "default": 3 }, "deduplicate": { "title": "Deduplicate businesses", "type": "boolean", "description": "Deduplicate by public place identity, then related source business and business name.", "default": true }, "minRating": { "title": "Minimum rating", "minimum": 1, "maximum": 5, "type": "number", "description": "Optional minimum rating shown on the recommendation card." }, "placeMinimumStars": { "title": "Minimum rating (legacy alias)", "minimum": 1, "maximum": 5, "type": "number", "description": "Compatibility alias for minRating. If both are supplied, they must match." }, "minReviews": { "title": "Minimum reviews", "minimum": 0, "type": "integer", "description": "Optional minimum review count shown on the recommendation card." }, "categoryFilter": { "title": "Category contains", "maxLength": 200, "type": "string", "description": "Optional case-insensitive category filter when Maps exposes a recommendation category." }, "sortBy": { "title": "Sort results", "enum": [ "recommended", "rating_desc", "reviews_desc", "name_asc" ], "type": "string", "description": "Keep source recommendation order or sort by visible rating, review count, or name.", "default": "recommended" }, "includeMedia": { "title": "Include place photos", "type": "boolean", "description": "Include filtered public photo URLs when present in the panel.", "default": true }, "includeDetails": { "title": "Open recommended place panels", "type": "boolean", "description": "Visit selected recommendation panels on the same public Maps page to add optional business profile fields. Disabled by default.", "default": false }, "maxDetailItems": { "title": "Maximum recommendation panels", "minimum": 0, "maximum": 10, "type": "integer", "description": "Global maximum number of recommendation-panel attempts across all selected source places when includeDetails is enabled." }, "requestTimeoutSecs": { "title": "Navigation timeout (seconds)", "minimum": 10, "maximum": 180, "type": "integer", "description": "Maximum wait for each public Maps page navigation." }, "requestTimeoutMs": { "title": "Navigation timeout (milliseconds alias)", "minimum": 10000, "maximum": 180000, "type": "integer", "description": "Millisecond compatibility alias for requestTimeoutSecs." }, "browserWaitMs": { "title": "Page settle wait (ms)", "minimum": 0, "maximum": 15000, "type": "integer", "description": "Bounded wait after Maps navigation for rendered public content.", "default": 2000 }, "requestDelayMs": { "title": "Delay between pages (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Bounded delay between source pages.", "default": 750 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify Proxy configuration for Puppeteer page requests." }, "userAgent": { "title": "User agent", "maxLength": 256, "type": "string", "description": "Optional ordinary browser user agent; no stealth or fingerprint overrides." }, "locale": { "title": "Locale", "maxLength": 16, "type": "string", "description": "Short Maps locale such as en or en-US." }, "language": { "title": "Language (legacy)", "maxLength": 16, "type": "string", "description": "Compatibility alias for locale." } } }, "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 } } } } } } } } } }