{ "openapi": "3.0.1", "info": { "title": "Google Maps Reviews Scraper", "description": "Scrape Google Maps reviews from any place. This actor extracts reviewer names, ratings, dates, comments, and review counts. Ideal for sentiment analysis, competitor research, customer insights, and performance tracking.", "version": "0.1", "x-build-id": "442xF9lYOgGb7Gb7F" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~google-maps-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-google-maps-reviews-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/scraper-engine~google-maps-reviews-scraper/runs": { "post": { "operationId": "runs-sync-scraper-engine-google-maps-reviews-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/scraper-engine~google-maps-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-scraper-engine-google-maps-reviews-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 URLs", "type": "array", "description": "πŸ“βž• Add one or more Google Maps place URLs (example: https://www.google.com/maps/place/Restaurant+Name/...).", "items": { "type": "string" } }, "placeIds": { "title": "πŸ†”πŸ“Œ Google Place IDs", "type": "array", "description": "πŸ“Œβœ¨ Optional. Each place ID (e.g. `ChIJ...`) is auto-converted into a Maps URL and scraped together with `startUrls`.", "items": { "type": "string" } }, "maxReviews": { "title": "πŸ§ΎπŸ“Š Maximum Reviews per URL", "minimum": 1, "maximum": 100000, "type": "integer", "description": "πŸ“ŠπŸŽšοΈ Set the maximum number of reviews to extract for every place URL.", "default": 10 }, "reviewsSort": { "title": "πŸ—‚οΈβ­ Review Sort Order", "enum": [ "newest", "mostRelevant", "highestRanking", "lowestRanking" ], "type": "string", "description": "⭐↕️ Choose sorting exactly like Google Maps: newest, most relevant, highest rating, or lowest rating.", "default": "newest" }, "reviewsStartDateAbsolute": { "title": "πŸ“…πŸ§­ Reviews Start Date (Absolute)", "type": "string", "description": "πŸ—“οΈβœ… Pick an exact calendar date (YYYY-MM-DD). Reviews older than this cutoff are skipped.", "default": "" }, "reviewsStartDateRelative": { "title": "β³πŸ•’ Reviews Start Date (Relative)", "enum": [ "", "7 days", "1 month", "3 months", "6 months", "1 year", "2 years" ], "type": "string", "description": "βŒ›πŸ“† Choose a relative time window when you want recent reviews without selecting an exact date.", "default": "" }, "language": { "title": "πŸŒπŸ—£οΈ Language", "enum": [ "en", "es", "fr", "de", "it", "pt", "nl", "bn", "hi", "ar", "tr", "id", "ja", "ko", "zh-CN" ], "type": "string", "description": "πŸ—£οΈπŸŒ Select your preferred language. Applied to Maps cookies, locale, and Accept-Language headers.", "default": "en" }, "personalData": { "title": "πŸͺͺπŸ”’ Include Personal Data", "type": "boolean", "description": "πŸ”’πŸ™ˆ If disabled, reviewer name and profile link are hidden in all output rows.", "default": true }, "proxy": { "title": "πŸŒπŸ›‘οΈ Proxy Configuration", "type": "object", "description": "πŸ›‘οΈβš™οΈ Optional proxy settings block. Set `use_proxy: false` to scrape directly. `username` / `password` can stay empty for unauthenticated proxies. Used by Playwright + aiohttp so all requests go through one IP." } } }, "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 } } } } } } } } } }