{ "openapi": "3.0.1", "info": { "title": "Google Maps Scraper [Advance]", "description": "Most powerful actory that automatically extracts business data from Google Maps, including names, addresses, phone numbers, ratings, reviews, and more.", "version": "0.7", "x-build-id": "avcCHjvdF5UQndSia" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapeio~google-maps-scraper-advance/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapeio-google-maps-scraper-advance", "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/scrapeio~google-maps-scraper-advance/runs": { "post": { "operationId": "runs-sync-scrapeio-google-maps-scraper-advance", "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/scrapeio~google-maps-scraper-advance/run-sync": { "post": { "operationId": "run-sync-scrapeio-google-maps-scraper-advance", "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": "What to find on Maps, e.g. coffee shop, dentist, hotel." }, "searchTerms": { "title": "Additional search queries", "type": "array", "description": "Optional extra phrases — each runs as its own Maps search (same location applies).", "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "City, region, or country added to every keyword search above." }, "startUrls": { "title": "Google Maps URLs", "type": "array", "description": "Full Maps search or place links — one URL per line.", "items": { "type": "string" } }, "placeIds": { "title": "Place IDs", "type": "array", "description": "Google place IDs (strings starting with ChIJ…).", "items": { "type": "string" } }, "customGeolocation": { "title": "GeoJSON area or point", "type": "object", "description": "Point (+ optional radiusKm), Polygon, or MultiPolygon. The actor searches multiple map points inside the shape." }, "exploreMapInsteadOfSearch": { "title": "Explore map at coordinates (no keyword)", "type": "boolean", "description": "Opens the map at the center below and scrolls visible listings — use with map center JSON.", "default": false }, "mapCenter": { "title": "Map center", "type": "object", "description": "Required for explore: { \"lat\": number, \"lng\": number, \"zoom\": optional 1–21 }." }, "maxResults": { "title": "Max places to collect", "minimum": 1, "maximum": 500, "type": "integer", "description": "Stop after this many unique businesses (1–500).", "default": 100 }, "languageCode": { "title": "Maps language", "type": "string", "description": "UI language code, e.g. en, de, es, fr.", "default": "en" }, "city": { "title": "City", "type": "string", "description": "Optional — combined with the fields below into one location if \"Location\" above is empty." }, "state": { "title": "State / region", "type": "string", "description": "Optional." }, "county": { "title": "County", "type": "string", "description": "Optional." }, "postalCode": { "title": "Postal code", "type": "string", "description": "Optional." }, "countryCode": { "title": "Country code", "type": "string", "description": "Optional, e.g. us, gb, de." }, "categories": { "title": "Keep rows matching topics", "type": "array", "description": "After scraping, only keep places whose name or snippet mentions one of these words.", "items": { "type": "string" } }, "minRating": { "title": "Minimum star rating (number)", "type": "number", "description": "Keep places with at least this rating when stars are visible (0–5)." }, "placeMinimumStars": { "title": "Minimum stars (preset text)", "type": "string", "description": "Alternative to the number above: two, three, four, fourAndHalf, etc." }, "searchMatching": { "title": "Business name vs search text", "enum": [ "all", "only_includes", "only_exact" ], "type": "string", "description": "How strictly the place name must match your queries.", "default": "all" }, "website": { "title": "Website filter", "enum": [ "allPlaces", "withWebsite", "withoutWebsite" ], "type": "string", "description": "Requires place detail scraping to detect websites.", "default": "allPlaces" }, "skipClosedPlaces": { "title": "Skip closed businesses", "type": "boolean", "description": "Remove listings that appear permanently or temporarily closed in the UI.", "default": false }, "scrapePlaceDetailPage": { "title": "Open each place page (details)", "type": "boolean", "description": "Slower but fills phone, website, address, coordinates. Turned on automatically if you request reviews, images, or certain extras below.", "default": false }, "maxReviews": { "title": "Max reviews per place", "minimum": 0, "type": "integer", "description": "0 = skip. Otherwise up to 5000 per place (subject to Maps UI)." }, "reviewsSort": { "title": "Review sort order", "enum": [ "newest", "mostRelevant", "highestRanking", "lowestRanking" ], "type": "string", "description": "Best-effort: the actor tries to pick this in the Reviews menu.", "default": "newest" }, "reviewsFilterString": { "title": "Review text must contain", "type": "string", "description": "Only keep reviews whose text includes this phrase (case-insensitive)." }, "scrapeReviewsPersonalData": { "title": "Include reviewer names", "type": "boolean", "description": "If off, reviewerName is omitted from each review object.", "default": true }, "maxImages": { "title": "Max photos per place", "minimum": 0, "type": "integer", "description": "0 = skip. Up to 200 per place." }, "scrapeImageAuthors": { "title": "Photo author / alt text", "type": "boolean", "description": "Include image author when available.", "default": false }, "includeWebResults": { "title": "Web results block", "type": "boolean", "description": "Extract links from the Web results section when present.", "default": false }, "scrapeDirectories": { "title": "Directory / related place links", "type": "boolean", "description": "Extra Maps place links (e.g. listings inside a mall).", "default": false }, "maxQuestions": { "title": "Q&A pairs to extract", "minimum": 0, "type": "integer", "description": "When this field exists in input, Q&A runs. Use 0 for one heuristic pair; higher = cap on pairs." }, "scrapeTableReservationProvider": { "title": "Reservation hints", "type": "boolean", "description": "Best-effort reservation URL or provider name from page text.", "default": false }, "enrichContactsFromWebsite": { "title": "Crawl business website for contacts", "type": "boolean", "description": "After a website URL is found, visit it to extract emails, phones, and social profile links.", "default": false }, "enrichSocialFacebook": { "title": "Fetch Facebook page preview", "type": "boolean", "description": "If a Facebook URL was found, load public meta (title/description).", "default": false }, "enrichSocialInstagram": { "title": "Fetch Instagram profile preview", "type": "boolean", "description": "If an Instagram URL was found, load public meta.", "default": false }, "enrichSocialYoutube": { "title": "Fetch YouTube channel preview", "type": "boolean", "description": "If a YouTube URL was found, load public meta.", "default": false }, "enrichSocialTiktok": { "title": "Fetch TikTok profile preview", "type": "boolean", "description": "If a TikTok URL was found, load public meta.", "default": false }, "enrichSocialTwitter": { "title": "Fetch X (Twitter) profile preview", "type": "boolean", "description": "If an X/Twitter URL was found, load public meta.", "default": false }, "includeReviewsDatasetView": { "title": "Also save flat reviews file", "type": "boolean", "description": "Writes REVIEWS_ROWS to key-value storage (JSON list) in addition to the dataset.", "default": false }, "searchStringsArray": { "title": "Search term(s) — API alias", "type": "array", "description": "Same as \"Additional search queries\" (searchTerms). For tasks and API compatibility.", "items": { "type": "string" } }, "locationQuery": { "title": "Location (alias)", "type": "string", "description": "Same as Location in section 1." }, "mapsUrls": { "title": "Maps URLs (alias)", "type": "array", "description": "Same as Google Maps URLs in section 2.", "items": { "type": "string" } }, "maxCrawledPlacesPerSearch": { "title": "Max places (alias)", "minimum": 1, "maximum": 500, "type": "integer", "description": "Same as Max places to collect." }, "language": { "title": "Language (alias)", "type": "string", "description": "Same as Maps language." }, "categoryFilterWords": { "title": "Category filters (alias)", "type": "array", "description": "Same as Keep rows matching topics.", "items": { "type": "string" } }, "scrapeContacts": { "title": "Scrape contacts (alias)", "type": "boolean", "description": "Same as Crawl business website for contacts.", "default": false }, "allPlacesNoSearchAction": { "title": "Explore mode (legacy text flag)", "type": "string", "description": "If set to any non-empty value, same as explore mode. Prefer the checkbox in section 4." }, "scrapeSocialMediaProfiles": { "title": "Social fetch (JSON override)", "type": "object", "description": "Expert JSON: { \"facebooks\": true, \"instagrams\": true, … }. If set, overrides the checkboxes above." } } }, "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 } } } } } } } } } }