{ "openapi": "3.0.1", "info": { "title": "App Store & Google Play Reviews Scraper", "description": "Scrape Apple App Store and Google Play reviews for iOS/Android app and competitor analysis. Export ratings, text, dates, available versions, developer replies, full app metadata and raw data. Bulk JSON/CSV export, filters and AI agent/MCP support.", "version": "0.1", "x-build-id": "61Qu64N2NewDjEEqH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/whoareyouanas~app-store-google-play-review-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-whoareyouanas-app-store-google-play-review-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/whoareyouanas~app-store-google-play-review-scraper/runs": { "post": { "operationId": "runs-sync-whoareyouanas-app-store-google-play-review-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/whoareyouanas~app-store-google-play-review-scraper/run-sync": { "post": { "operationId": "run-sync-whoareyouanas-app-store-google-play-review-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": [ "apps" ], "properties": { "apps": { "title": "Apps", "type": "array", "description": "Required, nonempty array. Apple numeric app IDs (310633997), Android package names (com.whatsapp) or HTTPS apps.apple.com/play.google.com URLs. Both stores can be mixed. App discovery by search/name is not supported.", "items": { "type": "string" } }, "countries": { "title": "Countries", "type": "array", "description": "Two-letter codes. Overrides URL countries when supplied; otherwise URL country or US is used.", "items": { "type": "string" } }, "languages": { "title": "Google Play languages", "type": "array", "description": "Each language is a separate request context. Defaults to the Play URL language or English. It does not translate text or identify its actual language.", "items": { "type": "string" } }, "sort": { "title": "Sort reviews", "enum": [ "newest", "mostHelpful" ], "type": "string", "description": "Sort within each source context. The combined dataset is not globally date sorted.", "default": "newest" }, "maxReviews": { "title": "Maximum reviews in the run", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Unique exported reviews across all apps; 0 means no result ceiling.", "default": 10000 }, "maxReviewsPerAppCountry": { "title": "Maximum reviews per app / country / language", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Unique emitted rows attributed to each context. Duplicates do not consume the cap. 0 means no result ceiling.", "default": 1000 }, "ratings": { "title": "Star ratings", "type": "array", "description": "Keep any listed star rating. Other filters combine with AND.", "items": { "type": "integer", "minimum": 1, "maximum": 5 }, "default": [ 1, 2, 3, 4, 5 ] }, "dateFrom": { "title": "Reviews from", "type": "string", "description": "YYYY-MM-DD or ISO timestamp with timezone. Compared with sourceDate, which may be an edit date." }, "dateTo": { "title": "Reviews through", "type": "string", "description": "Inclusive YYYY-MM-DD UTC day or ISO timestamp with timezone." }, "keywords": { "title": "Keywords", "type": "array", "description": "Case-insensitive title/body match; any listed keyword matches. Searches retrieved candidates within the work limits.", "items": { "type": "string" } }, "appVersions": { "title": "Review app versions", "type": "array", "description": "Exact versions attached to source reviews. Apple catalog versions may be unavailable outside the finite RSS enrichment window.", "items": { "type": "string" } }, "replyFilter": { "title": "Developer replies", "enum": [ "all", "withReply", "withoutReply" ], "type": "string", "description": "RSS cannot determine reply status. Unsupported collection is reported as a source error, rather than an empty export.", "default": "all" }, "appleSource": { "title": "Apple review source", "enum": [ "auto", "catalog", "rss" ], "type": "string", "description": "Auto uses deeper catalog pagination and discloses any limited RSS fallback. Catalog mode fails visibly if catalog becomes unavailable.", "default": "auto" }, "enrichAppleReviews": { "title": "Enrich Apple fields from RSS", "type": "boolean", "description": "Fetch up to ten RSS pages to add available source versions and vote counts to catalog reviews. Includes additional requests.", "default": true }, "includeAppMetadata": { "title": "Include full app metadata", "type": "boolean", "description": "Store app profiles, rating histograms and available source metadata in the run key-value store. Metadata is not a charged review row.", "default": true }, "includeRawData": { "title": "Preserve original source data", "type": "boolean", "description": "Preserves original review payloads and app metadata sections, including unmapped fields. Increases export size.", "default": true }, "maxReviewsScannedPerAppCountry": { "title": "Maximum candidates per context", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Counts examined candidates, including duplicates and filter rejects. Must be at least the per-context review cap; 0 removes this ceiling.", "default": 100000 }, "maxRequestsPerAppCountry": { "title": "Maximum requests per context", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Counts metadata, enrichment, page requests and retries. 0 removes this ceiling. Endpoint exhaustion still does not prove complete historical coverage.", "default": 10000 }, "maxConcurrency": { "title": "Concurrent contexts", "minimum": 1, "maximum": 10, "type": "integer", "description": "Independent app/country/language contexts. Continuation pages within each context run sequentially.", "default": 3 }, "requestIntervalMillis": { "title": "Delay between source requests (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Shared per-host delay. Apple metadata lookups have an additional 3-second spacing.", "default": 350 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 1, "maximum": 120, "type": "integer", "description": "Timeout applied to each HTTP attempt.", "default": 30 }, "maxRetries": { "title": "Retries per request", "minimum": 0, "maximum": 8, "type": "integer", "description": "Bounded backoff for throttling and transient failures. Permanent errors and parser changes fail visibly.", "default": 3 }, "proxyConfiguration": { "title": "Proxy settings", "type": "object", "description": "Optional proxy configuration, applied to all source and metadata requests. Direct requests are the default.", "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 } } } } } } } } } }