{ "openapi": "3.0.1", "info": { "title": "Google Maps Reviews Scraper", "description": "Extract every public review for a place on Google Maps by URL or place ID: review text with English translation, star rating, dates, likes, owner_response, attached photos and reviewer details. Export JSON, CSV or Excel.", "version": "2.1", "x-build-id": "2ud2hJVQV3IFqsVMj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/herus13~google-maps-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-herus13-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/herus13~google-maps-reviews-scraper/runs": { "post": { "operationId": "runs-sync-herus13-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/herus13~google-maps-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-herus13-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": "Place URLs", "type": "array", "description": "Google Maps places to pull reviews from, one per entry: the place URL from the address bar, a share link (maps.app.goo.gl), a ?cid= link, or a place_id link. Ids work here too, so this field and placeIds take the same formats. Search URLs and saved lists are skipped: give each place on its own. Give at least one of startUrls or placeIds; leave empty when you are supplying placeIds instead.", "items": { "type": "string" } }, "placeIds": { "title": "Place IDs", "type": "array", "description": "Google place ids, one per entry: a ChIJ… place id, a 0x…:0x… feature id, or a numeric CID. URLs work here too, so this field and startUrls take the same formats. A place given in several forms is read once. Give at least one of startUrls or placeIds; leave empty when you are supplying startUrls instead.", "items": { "type": "string" } }, "maxReviews": { "title": "Max reviews per place", "type": "integer", "description": "How many reviews to return for each place. Default 100. Set 0 to take every review the place has. Google counts star-only ratings in the headline total it shows, while only reviews that carry text come back as rows, so a place advertising 500 reviews can return fewer.", "default": 100 }, "reviewsSort": { "title": "Sort order", "enum": [ "newest", "mostRelevant", "highestRating", "lowestRating" ], "type": "string", "description": "Which reviews you get first: newest for the most recent, mostRelevant for Google's own ranking, highestRating for the best, lowestRating for the worst. Default newest. Pair highestRating with a small maxReviews to lift a place's showcase reviews, or newest to watch fresh feedback.", "default": "newest" }, "includeRatingOnlyReviews": { "title": "Include star-only ratings", "type": "boolean", "description": "Also return the star-only ratings — reviews with a rating but no text — which are left out by default. Default false. No longer available: Google stopped showing star-only ratings to signed-out visitors, so this option has no effect and only text reviews are returned. It is kept so saved inputs that set it still run.", "default": false }, "language": { "title": "Language", "type": "string", "description": "BCP-47 language code for the review text, for example en, de, fr or vi. Default en. A review written in another language still comes back in the original, with the English translation in `text_translated`.", "default": "en" }, "debugDumpRaw": { "title": "Debug: save the raw response", "type": "boolean", "description": "Save the first raw reviews response Google returned into the run's key-value store, under the key `DEBUG_LISTUGCPOSTS_RAW`, so there is something concrete to look at when a place comes back empty. Default false; leave it off for normal runs.", "default": false }, "proxyUrls": { "title": "Your own proxy URLs (optional)", "type": "array", "description": "Leave empty and the run uses a residential proxy that is included in the price of the run. To route through your own account instead, add one gateway URL per entry, for example http://user:pass@host:port. Works with any provider that issues URLs. When set, the run uses these first and switches to the included proxy if they stop working, so a broken proxy never fails the run.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }