{ "openapi": "3.0.1", "info": { "title": "App Store Reviews Scraper", "description": "Scrape Apple App Store reviews by app ID or App Store URL for any country storefront, up to 10,000 per run: rating, title, text, author and date, newest or most helpful first. Delta mode returns only reviews not returned before, so scheduled runs get just what is new.", "version": "1.0", "x-build-id": "8JYQGOGvQUGEc62UP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axiomworks~review-firehose/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axiomworks-review-firehose", "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/axiomworks~review-firehose/runs": { "post": { "operationId": "runs-sync-axiomworks-review-firehose", "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/axiomworks~review-firehose/run-sync": { "post": { "operationId": "run-sync-axiomworks-review-firehose", "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": [ "appId" ], "properties": { "appId": { "title": "App Store app ID or URL", "pattern": "^([0-9]+|https?://(apps|itunes)\\.apple\\.com/.*id[0-9]+.*)$", "type": "string", "description": "Numeric Apple App Store app ID, or the app's App Store URL. App names such as 'Spotify' are not accepted. The ID is the number after `id` in the URL, e.g. https://apps.apple.com/us/app/whatsapp-messenger/id310633997 has ID 310633997." }, "country": { "title": "Store country", "type": "string", "description": "Two-letter lowercase ISO country code of the App Store storefront, e.g. `us`, `gb` (United Kingdom, not `uk`), `de`, `jp`. Default `us`.", "default": "us" }, "mode": { "title": "Mode", "enum": [ "full", "delta" ], "type": "string", "description": "`full` returns the most recent reviews on every run. `delta` returns only reviews not seen in previous runs, tracked per app and country. Use `delta` for scheduled runs. The first delta run behaves like `full`.", "default": "full" }, "sort": { "title": "Sort order", "enum": [ "recent", "helpful" ], "type": "string", "description": "`recent` returns newest reviews first. `helpful` returns Apple's most helpful reviews first. Delta mode always uses `recent`.", "default": "recent" }, "stateKey": { "title": "State key (delta mode)", "type": "string", "description": "Optional. Key under which delta mode remembers already-returned reviews in the `review-firehose` key-value store. Leave empty to use one automatic key per app and country." }, "maxReviews": { "title": "Max reviews", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of reviews to return in this run (min 1, max 10,000). Apple keeps the full review history, so large backlogs are available. In delta mode, set this high enough to cover new reviews between runs.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy is used by default. If Apple returns nothing for the proxy IPs, the Actor automatically retries through residential proxies and then a direct connection. Data volume is only a few hundred KB per run.", "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 } } } } } } } } } }