{ "openapi": "3.0.1", "info": { "title": "Google Maps Scraper", "description": "Extracts public place and business results from Google Maps: names, categories, addresses, coordinates, ratings, reviews, hours, phones, websites, and photos.", "version": "2.0", "x-build-id": "GqCgiNUwpWupxVMa2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/searchapi~google-maps-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-searchapi-google-maps-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/searchapi~google-maps-scraper/runs": { "post": { "operationId": "runs-sync-searchapi-google-maps-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/searchapi~google-maps-scraper/run-sync": { "post": { "operationId": "run-sync-searchapi-google-maps-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": { "query": { "title": "Search Query", "type": "string", "description": "The place/business search term (e.g. 'restaurants in New York', 'coffee shops London')", "default": "restaurants in New York" }, "searchTerms": { "title": "Search terms (batch)", "minItems": 1, "maxItems": 50, "type": "array", "description": "Optional batch of public Google Maps place searches. When supplied, one search is run for each term.", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "searchStringsArray": { "title": "Legacy search terms", "minItems": 1, "maxItems": 50, "type": "array", "description": "Backward-compatible alias for searchTerms.", "items": { "type": "string", "minLength": 1, "maxLength": 200 } }, "locationQuery": { "title": "Location", "maxLength": 200, "type": "string", "description": "Optional location appended to every batch search term." }, "maxItems": { "title": "Maximum Items", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of place results to retrieve", "default": 10 }, "maxPlaces": { "title": "Maximum places per batch search", "minimum": 1, "maximum": 500, "type": "integer", "description": "Batch-mode maximum places per search term.", "default": 20 }, "maxCrawledPlacesPerSearch": { "title": "Legacy maximum places", "minimum": 1, "maximum": 500, "type": "integer", "description": "Backward-compatible alias for maxPlaces." }, "minimumRating": { "title": "Minimum rating", "minimum": 1, "maximum": 5, "type": "number", "description": "Batch-mode filter for source-backed ratings." }, "placeMinimumStars": { "title": "Legacy minimum rating", "pattern": "^(?:[1-5](?:\\.[0-9])?)?$", "type": "string", "description": "Backward-compatible string alias for minimumRating." }, "closedPlacesFilter": { "title": "Closed place filter", "enum": [ "all", "skipClosed", "onlyClosed" ], "type": "string", "description": "Keep all places, skip explicit permanent closures, or keep only explicit permanent closures.", "default": "all" }, "language": { "title": "Batch language", "pattern": "^[a-zA-Z]{2,3}(?:-[A-Z]{2})?$", "type": "string", "description": "Google Maps language code for batch searches.", "default": "en" }, "country": { "title": "Batch country", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "Two-letter Google Maps country code for batch searches.", "default": "US" }, "fingerprintProfile": { "title": "Browser fingerprint profile", "enum": [ "chrome-windows", "chrome-macos" ], "type": "string", "description": "Coherent desktop browser profile for batch searches.", "default": "chrome-windows" }, "proxySessionId": { "title": "Proxy session ID", "pattern": "^(?:[\\w._~]+)?$", "maxLength": 50, "type": "string", "description": "Optional stable Apify Proxy session identifier." }, "includeDetails": { "title": "Fetch place details", "type": "boolean", "description": "Open selected place pages concurrently to enrich address, phone, website, rating, reviews, hours, coordinates, plus code, and images.", "default": true }, "requireDetails": { "title": "Require all place details", "type": "boolean", "description": "Fail atomically if any selected place cannot be enriched instead of saving truthful list-level records.", "default": false }, "maxDetailConcurrency": { "title": "Detail concurrency", "minimum": 1, "maximum": 15, "type": "integer", "description": "Maximum simultaneous place-detail pages.", "default": 5 }, "maxRequestRetries": { "title": "Maximum request retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Bounded retries for temporary browser/network failures.", "default": 2 }, "navigationTimeoutSecs": { "title": "Navigation timeout", "minimum": 10, "maximum": 180, "type": "integer", "description": "Maximum seconds for search and detail page navigation.", "default": 60 }, "gl": { "title": "Google Country", "type": "string", "description": "Two-letter country code for localized Maps results (e.g. 'us', 'uk', 'in')", "default": "us" }, "hl": { "title": "Language", "type": "string", "description": "Two-letter language code for Maps interface (e.g. 'en', 'es', 'de')", "default": "en" }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Optional Residential or custom browser proxy. GOOGLE_SERP is incompatible with interactive Google Maps and is rejected.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }