{ "openapi": "3.0.1", "info": { "title": "Google Business Reviews Scraper", "description": "Scrape reviews from any Google Business Profile on Google Maps. Get review text, star ratings, reviewer info, photos, owner responses, and more. Supports sorting by relevance, newest, highest or lowest rating. Fast, lightweight, no browser needed Perfect for reputation monitoring and market research", "version": "1.0", "x-build-id": "0KnBw8rx82N35N1cJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapeforge~google-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapeforge-google-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/scrapeforge~google-reviews-scraper/runs": { "post": { "operationId": "runs-sync-scrapeforge-google-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/scrapeforge~google-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-scrapeforge-google-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": { "placeURLs": { "title": "Google Maps Place URLs", "type": "array", "description": "List of Google Maps place URLs to scrape reviews from.", "default": [], "items": { "type": "string" } }, "searchQueries": { "title": "Search Queries", "type": "array", "description": "Search for businesses by keyword (e.g., 'restaurants in New York'). Reviews from all found places will be scraped.", "default": [], "items": { "type": "string" } }, "country": { "title": "Country", "type": "string", "description": "Country name to narrow search queries (e.g., 'United States', 'Spain'). Only applies to searchQueries.", "default": "" }, "state": { "title": "State / Region", "type": "string", "description": "State or region name (e.g., 'California', 'Catalonia'). Only applies to searchQueries.", "default": "" }, "city": { "title": "City", "type": "string", "description": "City name (e.g., 'New York', 'Barcelona'). Only applies to searchQueries.", "default": "" }, "maxReviewsPerPlace": { "title": "Max reviews per place", "minimum": 0, "type": "integer", "description": "Maximum number of reviews to scrape per place. Set to 0 for all reviews.", "default": 0 }, "sortBy": { "title": "Sort reviews by", "enum": [ "relevant", "newest", "highest", "lowest" ], "type": "string", "description": "Sort order for reviews.", "default": "relevant" }, "language": { "title": "Language", "type": "string", "description": "Language code for reviews (e.g., en, es, fr, de).", "default": "en" }, "reviewsStartDate": { "title": "Reviews start date", "type": "string", "description": "Only return reviews published after this date. Supports absolute dates (YYYY-MM-DD, ISO datetime) or relative dates (e.g., '3 months', '1 year', '30 days'). Works best with sortBy set to 'newest'.", "default": "" }, "reviewsFilterString": { "title": "Filter by keyword", "type": "string", "description": "Only return reviews containing this keyword (case-insensitive). Leave empty for all reviews.", "default": "" }, "reviewsTranslation": { "title": "Review translation mode", "enum": [ "onlyOriginal", "onlyTranslated", "originalAndTranslated" ], "type": "string", "description": "How to handle review translations. 'onlyOriginal' returns original text only. 'onlyTranslated' returns only the translated text. 'originalAndTranslated' returns both.", "default": "onlyOriginal" }, "translateLanguage": { "title": "Translate to language", "type": "string", "description": "Target language code for translation (e.g., 'en', 'es', 'fr'). Required when reviewsTranslation is not 'onlyOriginal'.", "default": "" }, "scrapeReviewsPersonalData": { "title": "Include reviewer personal data", "type": "boolean", "description": "When enabled, reviewer name, profile URL, avatar, and ID are included. Disable for GDPR compliance.", "default": true }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Recommended for avoiding rate limits.", "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 } } }, "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 } } } } } } } } } }