{ "openapi": "3.0.1", "info": { "title": "App Store Reviews Scraper, Top Charts & App Details API", "description": "App Store reviews scraper and top charts API: iOS app reviews, app details and top free, paid and grossing charts for any country, from Apple's official feeds. Monitor mode returns only new reviews. $0.10 per 1,000 reviews, $0.10 per 100-app chart. No reviewer names.", "version": "0.1", "x-build-id": "nOUm6xa6zWVgXbQUh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/localwire~app-store-reviews/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-localwire-app-store-reviews", "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/localwire~app-store-reviews/runs": { "post": { "operationId": "runs-sync-localwire-app-store-reviews", "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/localwire~app-store-reviews/run-sync": { "post": { "operationId": "run-sync-localwire-app-store-reviews", "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": { "mode": { "title": "What to get", "enum": [ "reviews", "appDetails", "topCharts" ], "type": "string", "description": "reviews: customer reviews of the apps (needs apps or searchTerms). appDetails: the store listing of each app (ratings, price, version, description, screenshots), plus search results (needs apps or searchTerms). topCharts: Apple's top free, paid or grossing charts by country, device and genre (needs nothing else). reviews if left out.", "default": "reviews" }, "apps": { "title": "Apps", "type": "array", "description": "App Store URLs (https://apps.apple.com/gb/app/instagram/id389801252), numeric app ids (389801252) or bundle ids (com.burbn.instagram). Required for reviews and appDetails unless searchTerms is given; there is no default app. Not used for top charts.", "items": { "type": "string" } }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Search the App Store and use the top results, e.g. \"budget planner\". Combine with apps or use on its own. In appDetails mode each result carries its searchRank.", "items": { "type": "string" } }, "searchLimit": { "title": "Apps per search term", "minimum": 1, "maximum": 200, "type": "integer", "description": "How many search results to use per term and country.", "default": 10 }, "countries": { "title": "Countries (App Store storefronts)", "type": "array", "description": "Two-letter App Store storefront codes: gb, us, de, fr, au, ca, jp… Reviews, prices and charts differ by storefront. Every country is fetched in the same run, so each one multiplies the results. gb and us if left out.", "default": [ "gb", "us" ], "items": { "type": "string" } }, "maxReviewsPerApp": { "title": "Max reviews per app and country", "minimum": 1, "maximum": 500, "type": "integer", "description": "Reviews to return per app and country (100 if left out). Apple's feed holds an app's latest 500 reviews per country, so 500 is the most you can get.", "default": 100 }, "sort": { "title": "Order", "enum": [ "mostRecent", "mostHelpful" ], "type": "string", "description": "Most recent first, or most helpful first.", "default": "mostRecent" }, "minRating": { "title": "Minimum stars", "minimum": 1, "maximum": 5, "type": "integer", "description": "Only reviews with at least this many stars. Use 1 and a maximum of 2 to collect complaints.", "default": 1 }, "maxRating": { "title": "Maximum stars", "minimum": 1, "maximum": 5, "type": "integer", "description": "Only reviews with at most this many stars.", "default": 5 }, "dateFrom": { "title": "Reviews since", "type": "string", "description": "Only reviews posted on or after this date, e.g. 2026-10-01." }, "onlyNewReviews": { "title": "Only new reviews (monitor mode)", "type": "boolean", "description": "Remember what earlier runs returned and return only reviews you haven't had before. Schedule the Actor daily with this on to get each new review once. State is kept in a key-value store named app-store-reviews-monitor in your account.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Keeps separate monitors apart (one per client or task). Runs with the same name share what has been seen.", "default": "default" }, "charts": { "title": "Charts", "type": "array", "description": "Which top charts to get in topCharts mode: topFree, topPaid, topGrossing. topFree if left out. One chart is fetched per chart × device × genre × country.", "items": { "type": "string", "enum": [ "topFree", "topPaid", "topGrossing" ], "enumTitles": [ "Top free", "Top paid", "Top grossing" ] }, "default": [ "topFree" ] }, "devices": { "title": "Devices", "type": "array", "description": "iPhone and/or iPad charts (topCharts mode). iphone if left out.", "items": { "type": "string", "enum": [ "iphone", "ipad" ], "enumTitles": [ "iPhone", "iPad" ] }, "default": [ "iphone" ] }, "genres": { "title": "Genres", "type": "array", "description": "Narrow the charts to genres by name (Finance, Games, Health & Fitness, Productivity…) or id (6015). Leave empty for the overall chart of all apps.", "items": { "type": "string" } }, "chartLimit": { "title": "Apps per chart", "minimum": 1, "maximum": 100, "type": "integer", "description": "Apps per chart. Apple's charts list up to 100 apps (the default); each chart position costs $0.001.", "default": 100 }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Stop after this many records in total across all apps, countries and charts (10,000 if left out). You can also cap spending with the run's maximum cost.", "default": 10000 } } }, "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 } } } } } } } } } }