{ "openapi": "3.0.1", "info": { "title": "Google Play Scraper: Reviews, App Details & Search", "description": "Scrape Google Play reviews, app details, search results, featured apps and developer catalogues in any country. Monitor mode returns only reviews posted since your last run. No login or API key.", "version": "0.0", "x-build-id": "RYnG54ipa5c8lg0gF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/winterlock~google-play-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-winterlock-google-play-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/winterlock~google-play-scraper/runs": { "post": { "operationId": "runs-sync-winterlock-google-play-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/winterlock~google-play-scraper/run-sync": { "post": { "operationId": "run-sync-winterlock-google-play-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": [ "mode" ], "properties": { "mode": { "title": "What to scrape", "enum": [ "reviews", "appDetails", "search", "featured", "developerApps" ], "type": "string", "description": "Reviews and app details for apps you name, search results, the apps Play is promoting, or a developer's catalogue.", "default": "reviews" }, "apps": { "title": "Apps", "type": "array", "description": "For Reviews and App details. Paste Play Store links (https://play.google.com/store/apps/details?id=com.example) or package names (com.example).", "items": { "type": "string" } }, "searchTerms": { "title": "Search terms", "type": "array", "description": "For Search results. Each term returns apps in Play Store ranking order, with a position field.", "items": { "type": "string" } }, "developers": { "title": "Developers", "type": "array", "description": "For Developer's apps. The developer name exactly as the store shows it (such as Spotify AB), the numeric developer ID, or a link to the developer's page.", "items": { "type": "string" } }, "countries": { "title": "Countries", "type": "array", "description": "Two-letter country codes such as us, gb, de, in, br. Each country has its own reviews, ratings, pricing and charts.", "items": { "type": "string" } }, "language": { "title": "Language", "type": "string", "description": "Two-letter language code for descriptions and reviews, such as en, es, de, pt.", "default": "en" }, "reviewSort": { "title": "Review order", "enum": [ "newest", "mostRelevant", "rating" ], "type": "string", "description": "Newest is best for monitoring. Most relevant matches what the store shows by default.", "default": "newest" }, "maxReviewsPerAppPerCountry": { "title": "Max reviews per app per country", "minimum": 1, "maximum": 6000, "type": "integer", "description": "Google pages reviews 100 at a time. Popular apps can return many thousands, so set this to control cost.", "default": 200 }, "onlyNewReviews": { "title": "Only new reviews since the last run (monitoring)", "type": "boolean", "description": "Remembers the newest review date for each app and country, and on later runs returns only reviews posted after it. Schedule the Actor daily to get a feed of new reviews and pay only for those.", "default": false }, "minRating": { "title": "Minimum star rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Keep only reviews with at least this many stars." }, "maxRating": { "title": "Maximum star rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Keep only reviews with at most this many stars. Set to 2 to collect only complaints." }, "includeReviewerNames": { "title": "Include reviewer names", "type": "boolean", "description": "Turn off to leave out reviewer display names and avatars.", "default": true }, "categories": { "title": "Categories (optional)", "type": "array", "description": "For Featured & promoted apps. Play category IDs such as GAME, FINANCE or SOCIAL. Leave empty for the store-wide featured page. One run per category.", "items": { "type": "string" } }, "maxResultsPerSearch": { "title": "Max apps per search, chart or developer", "minimum": 1, "maximum": 300, "type": "integer", "description": "Each app costs one extra request because its facts are read from its own page.", "default": 30 }, "maxItems": { "title": "Max items in total", "minimum": 1, "type": "integer", "description": "Stop the run after saving this many items. Leave empty for no limit." }, "maxConcurrency": { "title": "Max parallel requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "Lower this if you see rate-limit retries in the log.", "default": 4 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Google rate-limits heavy scraping by IP. Turn on Apify Proxy for large jobs or if the log shows blocked requests.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }