{ "openapi": "3.0.1", "info": { "title": "Apple App Store Reviews Scraper — App Reviews & Ratings", "description": "Apple App Store reviews for any iOS app, across every country storefront in one run: 1-5 rating, title, review text, reviewer, app version, date and the developer's reply. Give app ids, App Store URLs or app names. Filters bill only the reviews you keep. Pay per review.", "version": "1.0", "x-build-id": "oEmiy0idiLwUlHbs5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kestrel~app-store-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kestrel-app-store-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/kestrel~app-store-reviews-scraper/runs": { "post": { "operationId": "runs-sync-kestrel-app-store-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/kestrel~app-store-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-kestrel-app-store-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": { "appIds": { "title": "App ids", "uniqueItems": true, "type": "array", "description": "Apple's numeric app ids, e.g. 310633997 (the digits after /id in any App Store URL) — the fastest input, and what an earlier run's app_id gives you.", "default": [], "items": { "type": "string" } }, "startUrls": { "title": "App Store URLs", "uniqueItems": true, "type": "array", "description": "App pages, e.g. https://apps.apple.com/us/app/whatsapp-messenger/id310633997 — the id is read from the URL for you.", "default": [], "items": { "type": "string" } }, "appNames": { "title": "App names", "uniqueItems": true, "type": "array", "description": "App names as you would type them into App Store search, e.g. \"Duolingo\". Each is resolved to the top search hit on each storefront through Apple's own search API — no id hunting.", "default": [], "items": { "type": "string" } }, "countries": { "title": "Countries (storefronts)", "uniqueItems": true, "type": "array", "description": "Two-letter storefront codes, one per line: us, gb, de, fr, jp, br, in… Reviews live per storefront, so a global app needs several. Every review row carries its `country`; a review Apple lists on two storefronts is delivered and billed once.", "default": [ "us" ], "items": { "type": "string" } }, "maxReviewsPerApp": { "title": "Max reviews per app per country", "minimum": 0, "maximum": 100000, "type": "integer", "description": "0 = every review Apple pages out (big apps run into the tens of thousands per storefront). N = the first N in the order below. The main cost control.", "default": 100 }, "sort": { "title": "Order", "enum": [ "most_recent", "most_helpful", "most_critical", "most_favorable" ], "type": "string", "description": "Most recent is the one to schedule; most critical puts the 1-star reviews first; most helpful is the App Store's own default order.", "default": "most_recent" }, "minRating": { "title": "Only reviews rated at least", "minimum": 0, "maximum": 5, "type": "integer", "description": "0 = keep every review. 1-5 = keep only reviews at or above this many stars. Filtered reviews are never charged.", "default": 0 }, "maxRating": { "title": "Only reviews rated at most", "minimum": 0, "maximum": 5, "type": "integer", "description": "0 = keep every review. 1-5 = keep only reviews at or below this many stars — set 2 for a complaints feed that pays nothing for the happy ones.", "default": 0 }, "sinceDate": { "title": "Only reviews on or after", "type": "string", "description": "Leave empty for all. YYYY-MM-DD, or relative so a schedule never goes stale: \"7 days\", \"2 weeks\", \"3 months\". Combine with \"Most recent\" for a daily new-reviews feed.", "default": "" }, "requireText": { "title": "Only reviews with written text", "type": "boolean", "description": "Drop reviews that are a star rating with no words, so you deliver and pay for only the ones that say something.", "default": false }, "includeAppRow": { "title": "Include an app row", "type": "boolean", "description": "Also emit one free row per app and storefront: name, developer, genre, price, version, average rating, rating count and the 1-5 star histogram.", "default": true }, "sessions": { "title": "Parallel sessions", "minimum": 1, "maximum": 16, "type": "integer", "description": "How many proxy sessions (egress IPs) run in parallel. More is faster; each is paced separately.", "default": 4 }, "perIp": { "title": "Requests per second per IP", "minimum": 0.1, "maximum": 3, "type": "number", "description": "Pace for each session. Apple answers about 1/s per IP; faster earns 429 replies and retries, not speed.", "default": 1 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apple's endpoints are public and need no login, but they cap each IP at about one request a second. Apify Proxy (the default datacentre group) spreads a large run over several IPs; small runs work without it.", "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 } } } } } } } } } }