{ "openapi": "3.0.1", "info": { "title": "Apple App Store Scraper: App Store Reviews, iOS Ratings, Search", "description": "Scrape Apple App Store reviews for iOS apps, star ratings, app details and search results for many apps and countries in one run. Uses Apple's public review feed and the official iTunes Search and Lookup API. New-reviews-only mode for daily monitoring.", "version": "0.1", "x-build-id": "nbfICZbDslT34qDSO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ctriolab~appstore-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ctriolab-appstore-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/ctriolab~appstore-scraper/runs": { "post": { "operationId": "runs-sync-ctriolab-appstore-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/ctriolab~appstore-scraper/run-sync": { "post": { "operationId": "run-sync-ctriolab-appstore-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 (ID, App Store URL or bundle ID)", "type": "array", "description": "One app per line. Accepts a numeric App Store ID (389801252), an App Store URL (https://apps.apple.com/us/app/instagram/id389801252) or a bundle ID (com.burbn.instagram). Leave empty if you only want search results.", "default": [ "389801252" ], "items": { "type": "string" } }, "countries": { "title": "Countries (App Store storefronts)", "type": "array", "description": "2-letter country codes: US, GB, DE, FR, JP, KR, BR, IN ... Every app and search term is collected in every country. Reviews, prices, ratings and ranking differ per storefront.", "default": [ "us" ], "items": { "type": "string" } }, "includeReviews": { "title": "Reviews", "type": "boolean", "description": "Collect customer reviews (title, text, star rating, app version, author, date, votes) for each app and country.", "default": true }, "reviewSort": { "title": "Sort reviews by", "enum": [ "mostrecent", "mosthelpful" ], "type": "string", "description": "Most recent is best for monitoring. Most helpful returns the reviews other users voted up.", "default": "mostrecent" }, "maxReviewsPerApp": { "title": "Max reviews per app and country", "minimum": 0, "maximum": 500, "type": "integer", "description": "Apple's public feed returns at most 500 reviews (10 pages of 50) per app, country and sort order. 0 means as many as available.", "default": 100 }, "onlyNewSince": { "title": "Only reviews since", "type": "string", "description": "Optional. A date (2026-09-01 or 2026-09-01T12:00:00Z) or a relative value (24 hours, 7 days, 2 weeks). Older reviews are skipped and not charged." }, "onlyNewReviews": { "title": "Only reviews not seen in previous runs", "type": "boolean", "description": "Remembers review IDs per app and country in a named key-value store. The first run returns the latest reviews, later runs (for example a daily schedule) return only new ones. Runs with no new reviews succeed and cost almost nothing.", "default": false }, "monitorName": { "title": "Monitor name for new-only mode", "type": "string", "description": "Use a different name for each schedule or project so their memories do not mix.", "default": "default" }, "includeAppDetails": { "title": "App details", "type": "boolean", "description": "One row per app and country: name, developer, price, currency, genres, average rating, rating count, current version rating, version, release notes, size, content rating, languages, description, icon, screenshots, URL.", "default": true }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Optional. Searches the App Store like the search box (for example \"habit tracker\") and returns one row per app with its rank and full details. Runs in every country above.", "default": [], "items": { "type": "string" } }, "searchLimit": { "title": "Max search results per term and country", "minimum": 1, "maximum": 200, "type": "integer", "description": "1 to 200.", "default": 50 }, "maxRetries": { "title": "Max retries per request", "minimum": 0, "maximum": 10, "type": "integer", "description": "Retries on rate limits (HTTP 403, 429) and server errors with exponential backoff. Invalid apps and countries are never retried.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Not needed for normal runs. Apple's public endpoints work without a proxy.", "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 } } } } } } } } } }