{ "openapi": "3.0.1", "info": { "title": "Apple App Store Reviews Scraper - Ratings & App Data", "description": "Apple App Store reviews from Apple's official public feed: stars, title, text, app version and date for any app in 150+ countries. Rating filters, monitoring, app details. Pay per review.", "version": "0.1", "x-build-id": "Xkizef8KLCsJMjrHd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tinyrex~app-store-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tinyrex-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/tinyrex~app-store-reviews-scraper/runs": { "post": { "operationId": "runs-sync-tinyrex-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/tinyrex~app-store-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-tinyrex-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": { "apps": { "title": "Apps", "type": "array", "description": "App Store URLs (https://apps.apple.com/us/app/.../id570060128), app IDs (570060128 or id570060128) or app names (the best App Store search match is used).", "default": [ "https://apps.apple.com/us/app/duolingo-language-lessons/id570060128" ], "items": { "type": "string" } }, "mode": { "title": "What to get", "enum": [ "reviews", "apps" ], "type": "string", "description": "Reviews (one row per review) or app details (rating, rating count, version, price, developer, description... one row per app and country).", "default": "reviews" }, "countries": { "title": "Countries", "type": "array", "description": "App Store countries as 2-letter codes (us, gb, de, fr, ba...). Each country has its own reviews. Use 'all' for every App Store country.", "default": [ "us" ], "items": { "type": "string" } }, "maxReviewsPerApp": { "title": "Max reviews per app and country", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Apple's public feed gives up to 500 reviews per sort order and country (up to ~1,000 with 'Both'). 0 = as many as available.", "default": 500 }, "sortBy": { "title": "Sort order", "enum": [ "mostrecent", "mosthelpful", "both" ], "type": "string", "description": "Most recent reviews, most helpful reviews, or both (more unique reviews per country).", "default": "mostrecent" }, "minRating": { "title": "Min star rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Keep reviews with at least this many stars. Filtered reviews are free.", "default": 1 }, "maxRating": { "title": "Max star rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Keep reviews with at most this many stars (e.g. 2 for complaints only).", "default": 5 }, "reviewsSince": { "title": "Reviews since", "type": "string", "description": "Only reviews from this date on (YYYY-MM-DD). Older reviews are free.", "default": "" }, "keywords": { "title": "Review must contain", "type": "array", "description": "Keep only reviews whose title or text contains any of these words (e.g. crash, login, price).", "default": [], "items": { "type": "string" } }, "searchResultsPerTerm": { "title": "Apps per name search", "minimum": 1, "maximum": 50, "type": "integer", "description": "When you give app names, how many App Store search results to use per name (1 = best match only).", "default": 1 }, "onlyNewReviews": { "title": "Only new reviews (monitoring)", "type": "boolean", "description": "Return only reviews not returned by previous runs with the same state key. Ideal for daily schedules. The first run returns everything.", "default": false }, "stateKey": { "title": "State key", "type": "string", "description": "Name of the monitoring state. Use different keys for different schedules.", "default": "default" }, "maxConcurrency": { "title": "Parallel app/country feeds", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many app/country feeds are read at once.", "default": 4 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed normally.", "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 } } } } } } } } } }