{ "openapi": "3.0.1", "info": { "title": "App Reviews Scraper (App Store + Google Play)", "description": "Reviews from the Apple App Store and Google Play in one run: rating, title, text, app version, helpful votes and developer replies. Paste app URLs, ids or package names. Bounded retries on fresh sessions; failed apps are never charged.", "version": "0.1", "x-build-id": "1FCZbugveOO4OfmQu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/signalclear~app-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-signalclear-app-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/signalclear~app-reviews-scraper/runs": { "post": { "operationId": "runs-sync-signalclear-app-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/signalclear~app-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-signalclear-app-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": [ "apps" ], "properties": { "apps": { "title": "Apps", "type": "array", "description": "One app per line. App Store: an apps.apple.com URL or the numeric app id (e.g. 310633997). Google Play: a play.google.com URL or the package name (e.g. com.whatsapp). The store is detected automatically.", "items": { "type": "string" } }, "country": { "title": "Country", "type": "string", "description": "Two-letter country code, such as us, gb or de. Picks the App Store storefront (reviews differ per country) and is sent to Google Play as the country.", "default": "us" }, "language": { "title": "Language", "type": "string", "description": "Language code, such as en, de or pt-BR. Google Play returns reviews written in this language. For the App Store it only localizes the request; App Store reviews follow the country.", "default": "en" }, "sort": { "title": "Sort by", "enum": [ "newest", "mostHelpful" ], "type": "string", "description": "Order reviews by newest first or by the store's most-helpful ranking. Most helpful always uses the deeper Apple endpoint.", "default": "newest" }, "maxReviewsPerApp": { "title": "Maximum reviews per app", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Stop after this many reviews for each app.", "default": 100 }, "minRating": { "title": "Minimum star rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Keep only reviews with at least this many stars (1-5). Leave empty for all ratings. Filtering scans at most 10x the maximum (at least 500 reviews) per app, so a rare rating can return fewer results." }, "includeAppMetadata": { "title": "Also fetch app metadata", "type": "boolean", "description": "Adds an appInfo object to each review: developer, category, average rating, rating count, price, icon and description (App Store also: current version and release dates).", "default": false }, "appleSource": { "title": "App Store review source", "enum": [ "auto", "rss", "amp" ], "type": "string", "description": "Auto uses Apple's RSS feed (includes app version and vote counts, newest only, at most 500 reviews) when it can, otherwise the App Store web API (deeper, supports most helpful, includes developer replies, no version or votes).", "default": "auto" }, "maxConcurrency": { "title": "Apps in parallel", "minimum": 1, "maximum": 10, "type": "integer", "description": "Apps fetched at the same time. Higher is faster but more likely to be rate-limited.", "default": 3 }, "maxAttempts": { "title": "Attempts per app", "minimum": 1, "maximum": 3, "type": "integer", "description": "Each attempt uses a fresh proxy session and resumes where the last one stopped. Apps that still fail are listed in FAILED_APPS and are not charged.", "default": 3 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "How long to wait for a single HTTP response before the attempt counts as failed and is retried on a fresh session.", "default": 30 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Both stores' review endpoints work from datacenter IPs, so the default Apify proxy is usually enough. Switch to residential if you see many retries.", "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 } } } } } } } } } }