{ "openapi": "3.0.1", "info": { "title": "Google Maps Extractor - Fast Business Data & Leads", "description": "Extract Google Maps business data at scale: names, categories, addresses, coordinates, phones, websites, opening hours, ratings and review counts. Business data only, no review texts or photo lists, so it runs far faster and cheaper than browser-based extractors. Export to CSV, Excel, JSON.", "version": "0.2", "x-build-id": "Xim4gJ7jVpBvdgn9z" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/andrew_babo~google-maps-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-andrew_babo-google-maps-extractor", "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/andrew_babo~google-maps-extractor/runs": { "post": { "operationId": "runs-sync-andrew_babo-google-maps-extractor", "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/andrew_babo~google-maps-extractor/run-sync": { "post": { "operationId": "run-sync-andrew_babo-google-maps-extractor", "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": { "searchStringsArray": { "title": "Search terms", "type": "array", "description": "Queries to search on Google Maps, e.g. [\"coffee shop\", \"restaurant\"]. Combined with the location below.", "items": { "type": "string" } }, "locationQuery": { "title": "Location", "type": "string", "description": "Free-form location (city, region, country) geocoded via OpenStreetMap, e.g. \"New York, USA\". The area is split into adaptive tiles to bypass the ~120 results per viewport limit." }, "customGeolocation": { "title": "Custom geolocation (GeoJSON)", "type": "object", "description": "Optional GeoJSON Point/Polygon/MultiPolygon (or {type:'Feature', geometry: ...}). Overrides the location. Point uses a 5 km radius by default." }, "maxCrawledPlacesPerSearch": { "title": "Max places per search", "minimum": 0, "type": "integer", "description": "Maximum number of places to extract per search term. 0 or empty = unlimited.", "default": 100 }, "language": { "title": "Language", "type": "string", "description": "Google Maps interface language (hl), e.g. en, es, vi.", "default": "en" }, "countryCode": { "title": "Country code", "type": "string", "description": "Country for the Google geo parameter (gl), lowercase ISO code, e.g. us, gb, sg.", "default": "us" }, "categoryFilterWords": { "title": "Category filter words", "type": "array", "description": "Keep only places whose categories contain at least one of these words (case-insensitive). Empty = keep all.", "default": [], "items": { "type": "string" } }, "placeMinimumStars": { "title": "Minimum stars", "enum": [ "", "two", "twoAndHalf", "three", "threeAndHalf", "four", "fourAndHalf" ], "type": "string", "description": "Keep only places rated at or above this value.", "default": "" }, "skipClosedPlaces": { "title": "Skip permanently closed places", "type": "boolean", "description": "Drop places marked permanently or temporarily closed.", "default": true }, "scrapePlaceDetailPage": { "title": "Enrich with place details", "type": "boolean", "description": "Fetch the place payload when the listing record is missing website, phone, hours or review count. Turning this off is faster but much less complete.", "default": true }, "speedMode": { "title": "Speed mode", "enum": [ "turbo", "fast", "balanced", "accurate" ], "type": "string", "description": "Trade-off between wall-clock speed and retry depth. Turbo is the default and already reaches 99%+ field coverage.", "default": "turbo" }, "detailMode": { "title": "Detail request mode", "enum": [ "auto", "always", "never" ], "type": "string", "description": "auto = only when a field is missing, always = every place, never = listing data only.", "default": "auto" }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 100, "type": "integer", "description": "Upper bound on parallel requests. Leave empty to use the speed mode default." }, "seedByCities": { "title": "Seed by sub-areas", "type": "boolean", "description": "Also seed searches from sub-areas (districts, wards) inside the location for deeper recall.", "default": true }, "dedupeByPlaceId": { "title": "Deduplicate by place ID", "type": "boolean", "description": "Emit each place once, even when several search terms or tiles return it.", "default": true }, "failOnZeroResults": { "title": "Fail run when nothing is found", "type": "boolean", "description": "Off by default: an empty result finishes as a successful run and the reason (blocked / no results / outside area) is reported in the run summary. Turn on to mark such runs as failed.", "default": false }, "includeRunSummary": { "title": "Include run summary in dataset", "type": "boolean", "description": "Append one final item with per-field coverage, timings and health flags.", "default": true }, "maxRunTimeSecs": { "title": "Max run time (seconds)", "minimum": 60, "maximum": 86400, "type": "integer", "description": "Hard wall-clock limit for the whole run.", "default": 3600 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy with RESIDENTIAL groups is strongly recommended: Google blocks datacenter IPs within minutes. If the group is unavailable on your plan, the run falls back to the default Apify proxy automatically.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }