{ "openapi": "3.0.1", "info": { "title": "App Store Reviews Scraper", "description": "Built to beat thewolves/appstore-reviews-scraper: 6,000 reviews per app and country in our Oct 2026 tests vs their documented 500 cap, many countries per run, links read in their own country. Stars, title, text, dates, developer responses. $0.09 per 1,000, $0.054 on Gold.", "version": "0.1", "x-build-id": "GUA73AtJdoUStZYQL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tidyharvest~appstore-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tidyharvest-appstore-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/tidyharvest~appstore-reviews-scraper/runs": { "post": { "operationId": "runs-sync-tidyharvest-appstore-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/tidyharvest~appstore-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-tidyharvest-appstore-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 (App Store ids or links)", "type": "array", "description": "One app per line: a numeric App Store id (`310633997`) or an apps.apple.com link (`https://apps.apple.com/us/app/whatsapp-messenger/id310633997`). Up to 200 per run. A link is read in its own country unless you list other countries below.", "default": [ "310633997" ], "items": { "type": "string" } }, "sort": { "title": "Sort", "enum": [ "recent", "helpful" ], "type": "string", "description": "`Newest` first (best for monitoring) or `Most helpful` (Apple's default ranking).", "default": "recent" }, "countries": { "title": "Countries (App Store storefronts)", "type": "array", "description": "Two-letter storefront codes, one per line (us, gb, de, fr, jp, br, ...). Reviews are fetched per country, so 3 countries and 100 reviews per app can return up to 300 per app. Left at us, an apps.apple.com link is read in its own country (a /de/ link gives German reviews) and bare ids in the US store; list other countries to read every app in each of them.", "default": [ "us" ], "items": { "type": "string" } }, "minRating": { "title": "Minimum stars", "minimum": 1, "maximum": 5, "type": "integer", "description": "Keep reviews with at least this many stars (1-5).", "default": 1 }, "maxRating": { "title": "Maximum stars", "minimum": 1, "maximum": 5, "type": "integer", "description": "Keep reviews with at most this many stars (1-5).", "default": 5 }, "keywords": { "title": "Keywords (match any)", "type": "array", "description": "Keep a review only if its title or text contains one of these words (case-insensitive). Empty = all reviews.", "items": { "type": "string" } }, "onlyWithText": { "title": "Only reviews with text", "type": "boolean", "description": "Skip star-only reviews that have no written text.", "default": false }, "includeAppDetails": { "title": "Add app details", "type": "boolean", "description": "Read the app's App Store record once per app and country to add its name, developer, average score and ratings count to every review row.", "default": true }, "maxReviewsPerApp": { "title": "Max reviews per app", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop each app and country after this many reviews (after filters).", "default": 100 }, "maxItems": { "title": "Max reviews in total", "minimum": 0, "maximum": 500000, "type": "integer", "description": "Hard cap on reviews for the whole run (also caps your cost). 0 = no limit beyond the per-app cap.", "default": 100 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed normally. The actor already retries through Apify datacenter and then residential proxy if Apple refuses a request; set this to start on a proxy.", "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 } } } } } } } } } }