{ "openapi": "3.0.1", "info": { "title": "Apple App Store Reviews Scraper", "description": "Scrape Apple App Store reviews and app metadata from Apple's public feeds. Filter by star rating and keyword, scrape many countries in one run, and get only new reviews on each run. Accepts app ids, URLs or bundle ids.", "version": "1.0", "x-build-id": "vfcDoiC9k5hywKaTb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/chrisp28103~apple-app-store-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-chrisp28103-apple-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/chrisp28103~apple-app-store-reviews-scraper/runs": { "post": { "operationId": "runs-sync-chrisp28103-apple-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/chrisp28103~apple-app-store-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-chrisp28103-apple-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", "required": [ "apps" ], "properties": { "apps": { "title": "Apps", "type": "array", "description": "App Store apps to scrape. Use numeric ids (389801252), ids with prefix (id389801252), App Store URLs or bundle ids (com.duolingo.DuolingoMobile).", "items": { "type": "string" } }, "countries": { "title": "Countries", "type": "array", "description": "Two-letter App Store country codes, for example us, gb, de.", "default": [ "us" ], "items": { "type": "string" } }, "maxReviewsPerApp": { "title": "Max reviews per app and country", "minimum": 0, "maximum": 500, "type": "integer", "description": "Apple's feed gives about 500 reviews at most for each app and country.", "default": 100 }, "includeMetadata": { "title": "Include app metadata", "type": "boolean", "description": "Every review row already has the app fields (name, developer, bundle id, average stars, rating count, link). Turn this on with Max reviews set to 0 to get one app row for each app and country, for metadata-only runs. See the Apps view.", "default": false }, "onlyNewReviews": { "title": "Only new reviews", "type": "boolean", "description": "Emit only reviews newer than the last run. The Actor keeps the state in the named key-value store appstore-reviews-state.", "default": false }, "stateKey": { "title": "State key", "type": "string", "description": "Optional name that keeps the saved state of this task apart from other tasks that track the same app. Use a different value for each task. Only used with Only new reviews." }, "sinceDate": { "title": "Since date", "type": "string", "description": "Optional ISO date, for example 2026-01-01. Older reviews are skipped." }, "sort": { "title": "Sort", "enum": [ "mostrecent", "mosthelpful" ], "type": "string", "description": "Order of the reviews. Most helpful needs no date order, so Only new reviews does not work with it.", "default": "mostrecent" }, "minRating": { "title": "Minimum stars", "minimum": 1, "maximum": 5, "type": "integer", "description": "Optional. Keep only reviews with at least this many stars (1 to 5). Filtered-out reviews are not charged." }, "maxRating": { "title": "Maximum stars", "minimum": 1, "maximum": 5, "type": "integer", "description": "Optional. Keep only reviews with at most this many stars (1 to 5). Filtered-out reviews are not charged." }, "keywords": { "title": "Keywords", "type": "array", "description": "Optional. Keep only reviews whose title or text has any of these words. Case does not matter. Filtered-out reviews are not charged.", "items": { "type": "string" } }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. Use a proxy if Apple blocks the requests with HTTP 403. The default is no 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 } } } } } } } } } }