{ "openapi": "3.0.1", "info": { "title": "Apple App Store Reviews Scraper & API", "description": "Extract Apple App Store customer reviews as clean JSON for any app and any country storefront. Optional new-only mode returns just the reviews that appeared since the last run. No API key, no proxies.", "version": "1.0", "x-build-id": "Id4Fk3wwIUELP9ffD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alfdev996~app-store-reviews-scraper-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alfdev996-app-store-reviews-scraper-api", "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/alfdev996~app-store-reviews-scraper-api/runs": { "post": { "operationId": "runs-sync-alfdev996-app-store-reviews-scraper-api", "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/alfdev996~app-store-reviews-scraper-api/run-sync": { "post": { "operationId": "run-sync-alfdev996-app-store-reviews-scraper-api", "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": [ "appIds" ], "properties": { "appIds": { "title": "Apps", "minItems": 1, "type": "array", "description": "The apps to fetch reviews for. Accepts numeric App Store IDs (e.g. '324684580') or full App Store URLs (e.g. 'https://apps.apple.com/us/app/spotify/id324684580'). The numeric ID is the number after 'id' in the URL.", "items": { "type": "string" } }, "countries": { "title": "Country storefronts", "type": "array", "description": "Two-letter ISO country codes of the App Store storefronts to read. Apple keeps reviews separate per storefront, so 'us' returns only US reviews. Each extra country is a separate set of reviews.", "default": [ "us" ], "items": { "type": "string" } }, "sortBy": { "title": "Sort order", "enum": [ "mostRecent", "mostHelpful" ], "type": "string", "description": "'mostRecent' returns newest reviews first and is what you want for monitoring. 'mostHelpful' returns Apple's ranked reviews and is better for a one-off overview of sentiment.", "default": "mostRecent" }, "maxReviewsPerApp": { "title": "Max reviews per app and country", "minimum": 1, "maximum": 500, "type": "integer", "description": "Upper bound on reviews returned for each app/country pair. Apple's public feed exposes at most 500 reviews per app per storefront, so values above 500 have no effect. Keep this small (20-50) when calling from an AI agent so the response stays readable.", "default": 100 }, "onlyNew": { "title": "Only reviews new since the last run", "type": "boolean", "description": "Turn on to make repeated runs incremental: the Actor remembers the newest review it has already returned for each app/country pair and returns only what appeared since. The first run returns at most the 50 most recent reviews and records the starting point, so switching this on never dumps the whole backlog. Use it with a schedule to build a 'new review' alert.", "default": false }, "stateStoreName": { "title": "Name of the memory used for monitoring", "type": "string", "description": "Only used when 'Only reviews new since the last run' is on. Runs sharing this name share the same memory of what was already returned. Use different names to monitor different sets of apps independently.", "default": "app-review-state" }, "minRating": { "title": "Minimum star rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Drop reviews below this rating. Set both this and the maximum to 1 to get only 1-star reviews, which is the usual setup for a complaint alert.", "default": 1 }, "maxRating": { "title": "Maximum star rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Drop reviews above this rating.", "default": 5 }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Pause between calls to Apple's feed. The default is polite and rarely needs changing.", "default": 250 } } }, "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 } } } } } } } } } }