{ "openapi": "3.0.1", "info": { "title": "Google Maps Scraper - Places, Phones, Websites, Emails, Reviews", "description": "Google Maps scraper for leads: name, category, address, phone, website, rating, reviews count, hours, coordinates and IDs from searches, Maps URLs or place IDs. Add-ons: emails + socials from the business website, details, top reviews. Grid search past Google's cap, dedup, lead score.", "version": "1.0", "x-build-id": "2ObcKxednB3PSlCLh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kantolabs~google-maps-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kantolabs-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/kantolabs~google-maps-scraper/runs": { "post": { "operationId": "runs-sync-kantolabs-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/kantolabs~google-maps-scraper/run-sync": { "post": { "operationId": "run-sync-kantolabs-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": { "searchStringsArray": { "title": "Search terms", "type": "array", "description": "What you would type into Google Maps, one per line: \"dentist\", \"coffee shop\", \"plumber\". Each term is searched in the location below. Leave empty if you only use Maps URLs or place IDs.", "items": { "type": "string" } }, "locationQuery": { "title": "Location", "type": "string", "description": "City, region or country, e.g. \"Austin, TX, USA\", \"Manila, Philippines\", \"Praha\". Places outside this area are dropped (free). Big areas are split into a grid automatically to get past Google's ~240-results-per-search limit." }, "maxCrawledPlacesPerSearch": { "title": "Number of places per search", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum places to return for each search term (or Maps URL). The run stops exactly at this number. Above ~200 the area is searched cell by cell (grid).", "default": 20 }, "language": { "title": "Language", "enum": [ "en", "cs", "de", "es", "fr", "it", "pt", "pt-BR", "nl", "pl", "sk", "hu", "ro", "sv", "da", "no", "fi", "el", "tr", "ru", "uk", "ja", "ko", "zh-CN", "zh-TW", "id", "vi", "th", "ms", "tl", "hi", "ar", "he", "bg", "hr", "sr", "sl", "lt", "lv", "et" ], "type": "string", "description": "Language of names, categories, addresses and opening hours, as Google Maps shows them in that language.", "default": "en" }, "countryCode": { "title": "Country code (optional)", "type": "string", "description": "Two-letter country code Google should rank results for, e.g. \"us\", \"ph\", \"cz\". Usually not needed when a location is set." }, "latitude": { "title": "Latitude (custom area)", "type": "number", "description": "Centre of a circle to search in. Use with Longitude and Radius instead of the Location field. Example: 30.2672" }, "longitude": { "title": "Longitude (custom area)", "type": "number", "description": "Centre of the circle. Example: -97.7431" }, "radiusKm": { "title": "Radius (km)", "minimum": 0.2, "maximum": 300, "type": "number", "description": "Radius of the custom circle in kilometres.", "default": 5 }, "startUrls": { "title": "Google Maps URLs", "type": "array", "description": "Search URLs (google.com/maps/search/...) or place URLs (google.com/maps/place/..., ?cid=...). Short maps.app.goo.gl links are not resolved - open them and copy the full URL.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "placeIds": { "title": "Place IDs", "type": "array", "description": "Google place IDs (ChIJ...), CID numbers or feature IDs (0x...:0x...). One place per line.", "items": { "type": "string" } }, "categoryFilterWords": { "title": "Only these categories", "type": "array", "description": "Keep a place only if one of its Google categories contains one of these words, e.g. \"dentist\", \"orthodontist\". Filtered-out places are free and do not count toward the limit.", "items": { "type": "string" } }, "placeMinimumStars": { "title": "Minimum rating", "enum": [ "", "2", "2.5", "3", "3.5", "4", "4.5" ], "type": "string", "description": "Drop places rated below this (places without a rating are dropped too when set).", "default": "" }, "website": { "title": "Website", "enum": [ "allPlaces", "withWebsite", "withoutWebsite" ], "type": "string", "description": "\"Only without a website\" is a classic lead list for web designers.", "default": "allPlaces" }, "skipClosedPlaces": { "title": "Skip closed places", "type": "boolean", "description": "Drop places Google marks as permanently or temporarily closed.", "default": false }, "scrapePlaceDetailPage": { "title": "Add-on: place details", "type": "boolean", "description": "Opens each place for: plus code, description, star distribution (1-5), review keywords, booking/order links, menu link. Charged as \"Place details\" per place where it loaded.", "default": false }, "scrapeContacts": { "title": "Add-on: emails & social profiles from the website", "type": "boolean", "description": "Reads the business's own website (home page + up to 2 contact/about pages, robots.txt respected) for emails, Facebook/Instagram/LinkedIn/X/YouTube/TikTok links and phone numbers. Charged as \"Contact details\" only when at least one was found.", "default": false }, "maxReviews": { "title": "Add-on: reviews per place (0-5)", "minimum": 0, "maximum": 5, "type": "integer", "description": "Up to 5 reviews per place, newest first, with stars, text, date and owner reply. Google shows signed-out visitors only these few reviews; this actor never signs in. Charged per review delivered.", "default": 0 }, "reviewsIncludeAuthor": { "title": "Include reviewer names", "type": "boolean", "description": "Reviewer names are personal data. Leave off unless you have a lawful reason to process them (GDPR).", "default": false }, "splitLargeAreas": { "title": "Grid search for big areas", "type": "boolean", "description": "When a search hits Google's results limit and you asked for more, split the area into cells and search each (duplicates removed). Turn off to get only the first ~240.", "default": true }, "skipPlacesFromDatasetId": { "title": "Only new places - skip places in this dataset", "type": "string", "description": "Pick the dataset of an earlier run of this actor. Places already in it are skipped and not charged - run it weekly to get only newly listed businesses." } } }, "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 } } } } } } } } } }