{ "openapi": "3.0.1", "info": { "title": "App Store Scraper With Star Breakdown & In-App Prices", "description": "App Store Scraper With Star Breakdown & In-App Prices collects publicly available data from the App Store, including app titles, descriptions, ratings, reviews, categories, and developer details. Use it for research, analytics, or large-scale app data collection with structured output.", "version": "0.1", "x-build-id": "rJplk6L5FBqyOUxqt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~app-store-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-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/scraper-engine~app-store-reviews-scraper/runs": { "post": { "operationId": "runs-sync-scraper-engine-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/scraper-engine~app-store-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-scraper-engine-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": [ "process" ], "properties": { "process": { "title": "Process", "enum": [ "Search by AppId", "Search by Keyword", "Search by DeveloperId", "Get Reviews", "List Collection", "Get Privacy Data" ], "type": "string", "description": "Select the type of scraping process", "default": "Search by AppId" }, "appIds": { "title": "App IDs", "type": "string", "description": "Comma-separated list of Apple App Store app IDs (e.g., '1514844618' or '1514844618,123456789'). Required for 'Search by AppId', 'Get Reviews', and 'Get Privacy Data' processes.", "default": "1514844618" }, "keywords": { "title": "Keywords", "type": "string", "description": "Comma-separated list of keywords to search for apps (e.g., 'Translate' or 'Translate,Calculator'). Required for 'Search by Keyword' process.", "default": "Translate" }, "developerIds": { "title": "Developer IDs", "type": "string", "description": "Comma-separated list of developer IDs (e.g., '284417353' or '284417353,123456789'). Required for 'Search by DeveloperId' process.", "default": "284417353" }, "lang": { "title": "Language", "type": "string", "description": "ISO 639-1 language code (e.g., 'en', 'es', 'fr')", "default": "en" }, "country": { "title": "Country", "type": "string", "description": "ISO 3166 country code (e.g., 'us', 'gb', 'ca')", "default": "us" }, "sorting": { "title": "Review Sorting", "enum": [ "sort.RECENT", "sort.HELPFUL" ], "type": "string", "description": "Sort order for reviews: 'sort.RECENT' or 'sort.HELPFUL'", "default": "sort.RECENT" }, "collection": { "title": "Collection Type", "enum": [ "TOP_FREE_IOS", "TOP_PAID_IOS", "TOP_GROSSING_IOS", "TOP_FREE_IPAD", "TOP_PAID_IPAD", "TOP_GROSSING_IPAD", "TOP_FREE_MAC", "TOP_PAID_MAC", "TOP_GROSSING_MAC" ], "type": "string", "description": "Top charts collection type", "default": "TOP_FREE_IOS" }, "maximum": { "title": "Maximum Results", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum number of results to return (1-200)", "default": 25 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. If Apple App Store blocks requests, will automatically fallback to datacenter then residential proxy." }, "includeRatingBreakdown": { "title": "⭐ Real star breakdown", "type": "boolean", "description": "Reads Apple's published rating counts from the app's product page - how many 5★, 4★, 3★, 2★ and 1★ ratings the app actually has, plus the total and the average Apple shows. Returned in new fields; the base's own `histogram` object is left untouched.", "default": true }, "includeInAppPurchases": { "title": "💳 In-app purchases and prices", "type": "boolean", "description": "Returns the in-app purchase names and prices Apple lists on the product page, so the real cost of an app after install is visible next to its free/paid price.", "default": true }, "includeProductPageInfo": { "title": "📋 Product page information rows", "type": "boolean", "description": "Adds the rest of the information panel as fields: seller, download size as Apple prints it, category, compatibility, supported languages, age rating, copyright - plus the current version's \"What's New\" note and the release date shown on the page.", "default": true }, "minTotalRatings": { "title": "🔢 Minimum total ratings", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Drops apps whose real total rating count is below this - the quickest way to clear out apps with a flattering 5.0 average built on eleven ratings. 0 keeps everything.", "default": 0 } } }, "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 } } } } } } } } } }