{ "openapi": "3.0.1", "info": { "title": "Google Maps Reviews Scraper", "description": "Collect public Google Maps reviews from place URLs, with ratings, text, reviewer details and available place metadata. Export your dataset to CSV, Excel or JSON.", "version": "0.1", "x-build-id": "wzUPyTRug0WkVGGYQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fetch_cat~google-maps-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fetch_cat-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/fetch_cat~google-maps-reviews-scraper/runs": { "post": { "operationId": "runs-sync-fetch_cat-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/fetch_cat~google-maps-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-fetch_cat-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", "required": [ "startUrls" ], "properties": { "startUrls": { "title": "Google Maps place URLs", "type": "array", "description": "Paste one or more full Google Maps place URLs. URLs containing a 0x…:0x… place identifier are recommended. Share URLs depend on successful resolution; bare place IDs and broad searches are not a separate supported mode. Broad search URLs without a place identifier are skipped with a visible warning and RUN_SUMMARY reason, without requesting reviews.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Maximum reviews", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum saved reviews across all places, processed in input order. This is a ceiling, not a guaranteed count. The form default is 10. If absent from the effective API input, the runtime uses 50; set this explicitly in automations.", "default": 10 }, "reviewsPerPlace": { "title": "Reviews per place", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum saved reviews per place, also bounded by Maximum reviews. The form default is 10. If absent from the effective API input, the runtime uses the total review limit.", "default": 10 }, "sort": { "title": "Sort order", "enum": [ "mostRelevant", "newest", "highestRating", "lowestRating" ], "type": "string", "description": "Request most relevant, newest, highest-rating or lowest-rating order. Default: most relevant. Available preview results may not follow the requested order. Results are not reordered locally; sorting is not a rating or date filter.", "default": "mostRelevant" }, "language": { "title": "Language", "type": "string", "description": "Language hint for the initial Google Maps place page; default en. This does not filter or translate review text. Some subsequent review requests use English settings, so a chosen language does not guarantee review-language coverage.", "default": "en" }, "country": { "title": "Country", "type": "string", "description": "Country/region hint for the initial Google Maps place page; default US. Some subsequent review requests use US settings. This does not restrict the input places to a country.", "default": "US" }, "pageSize": { "title": "Page size", "minimum": 1, "maximum": 20, "type": "integer", "description": "Advanced page-size hint from 1 to 20, default 10. Applies only to an alternative review request; the primary request uses its own page size. Does not set the number of saved reviews.", "default": 10 }, "requestDelayMillis": { "title": "Request delay (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Delay between review page requests for the same place.", "default": 500 }, "maxRequestRetries": { "title": "Max request retries", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum place-resolution attempts, including the first attempt; default 3. This does not retry every review-page failure and does not guarantee additional results when Google returns no usable reviews.", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy is used from the first request by default, including when this field is omitted. You may supply managed Apify Proxy settings or custom proxy URLs. Explicit settings are passed to the proxy client; use useApifyProxy: false without custom URLs to opt out. There is no automatic direct-first fallback or connection selector. Invalid settings can fail validation; they are not a request to enable a different route. Keep proxy credentials private.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }