{ "openapi": "3.0.1", "info": { "title": "App Store Reviews Scraper", "description": "Pull Apple App Store reviews for any iPhone, iPad or Mac app from one country or more than 100 at once, with star, date and keyword filters. Each review includes rating, title, text, app version, helpful votes and optional app stats like overall rating, version and developer.", "version": "1.0", "x-build-id": "EaaLhFQ2LM3a2mhXQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datamole~app-store-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datamole-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/datamole~app-store-reviews-scraper/runs": { "post": { "operationId": "runs-sync-datamole-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/datamole~app-store-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-datamole-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 app IDs (324684580), app URLs (https://apps.apple.com/us/app/spotify/id324684580) or bundle IDs (com.spotify.client).", "items": { "type": "string" } }, "maxReviewsPerApp": { "title": "Max reviews per app", "minimum": 1, "type": "integer", "description": "Stop after this many reviews for each app, summed across all countries.", "default": 500 }, "maxItems": { "title": "Max reviews in total", "minimum": 1, "type": "integer", "description": "Hard cap for the whole run. Leave empty for no cap." }, "countries": { "title": "Countries", "type": "array", "description": "Two-letter App Store country codes (us, gb, mx, co, br, de...). Each country has its own reviews.", "default": [ "us" ], "items": { "type": "string" } }, "allCountries": { "title": "Scrape all countries", "type": "boolean", "description": "Scan 100+ App Store countries automatically. Best way to collect the largest number of reviews for global apps.", "default": false }, "searchQueries": { "title": "Find apps by keyword", "type": "array", "description": "Search the App Store and scrape reviews of the top matching apps (e.g. \"meditation\").", "items": { "type": "string" } }, "appsPerQuery": { "title": "Apps per search query", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many top search results to take for each keyword.", "default": 5 }, "sort": { "title": "Sort reviews by", "enum": [ "newest", "most_helpful", "both" ], "type": "string", "description": "Newest is best for monitoring and date filters. Both combines the two lists for extra coverage.", "default": "newest" }, "ratings": { "title": "Star ratings", "type": "array", "description": "Only keep reviews with these star ratings. Empty = all.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] } }, "dateFrom": { "title": "Reviews from date", "type": "string", "description": "Only reviews posted on or after this date (YYYY-MM-DD)." }, "dateTo": { "title": "Reviews to date", "type": "string", "description": "Only reviews posted on or before this date (YYYY-MM-DD)." }, "keywords": { "title": "Must contain any keyword", "type": "array", "description": "Only keep reviews whose title or text contains at least one of these words (case insensitive).", "items": { "type": "string" } }, "minTextLength": { "title": "Minimum review length (characters)", "minimum": 0, "type": "integer", "description": "Skip very short reviews.", "default": 0 }, "includeAppDetails": { "title": "Add app details to every review", "type": "boolean", "description": "Adds app name, overall rating, rating count, current version, developer, genre, price and release dates to each row.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Not needed in most cases. Use datacenter proxies if Apple starts rate limiting very large runs." } } }, "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 } } } } } } } } } }