{ "openapi": "3.0.1", "info": { "title": "App Store Scraper — Reviews, Ratings & App Details", "description": "Scrape Apple App Store reviews (full history, developer responses, any country), app details with rating histogram and version history, and keyword search results.", "version": "0.1", "x-build-id": "v5PY74RXWSN8mfZxw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tortuga~appstore-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tortuga-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/tortuga~appstore-scraper/runs": { "post": { "operationId": "runs-sync-tortuga-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/tortuga~appstore-scraper/run-sync": { "post": { "operationId": "run-sync-tortuga-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": { "mode": { "title": "Mode", "enum": [ "reviews", "details", "search" ], "type": "string", "description": "What to scrape. `reviews`: user reviews of each app in **Apps**, in each country. `details`: one app item per app and country (price, rating histogram, version history, size, privacy labels and more). `search`: App Store search results for each keyword in **Search terms**.", "default": "reviews" }, "apps": { "title": "Apps", "type": "array", "description": "App Store URLs, numeric app IDs or bundle IDs, one per line: `https://apps.apple.com/us/app/whatsapp-messenger/id310633997`, `310633997`, `net.whatsapp.WhatsApp`. Used by the `reviews` and `details` modes.", "items": { "type": "string" } }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Keywords for the `search` mode, one per line, e.g. `habit tracker`. Apple returns up to 200 apps per keyword and country, in App Store search order.", "items": { "type": "string" } }, "countries": { "title": "Countries", "type": "array", "description": "Two-letter App Store country codes, e.g. `us`, `gb`, `de`, `jp`, `br`. Each country has its own reviews, prices and search results. Enter `all` for all 175 storefronts. Leave empty to use the country in each app URL (or `us`).", "items": { "type": "string" } }, "sort": { "title": "Review order", "enum": [ "mostRecent", "mostHelpful" ], "type": "string", "description": "`mostRecent`: newest first (default). `mostHelpful`: Apple's most-helpful order. Both reach the full review history, not only the 500 that the RSS feed shows.", "default": "mostRecent" }, "maxReviewsPerCountry": { "title": "Max reviews per app and country", "minimum": 1, "type": "integer", "description": "Cap on reviews collected for each app in each country (`reviews` mode). Leave empty to use only **Max items**." }, "reviewsNewerThan": { "title": "Only reviews newer than", "type": "string", "description": "A date (YYYY-MM-DD) or a period such as '2 days' or '3 weeks' (counted back from the start of each run, so a schedule always gets the latest reviews). With **Review order** = Most recent, the scraper stops at the first older review, so you pay only for new ones. This is the date input for daily or weekly monitoring; combine it with **Only new or changed items**." }, "includeAppVersion": { "title": "Add app version and helpful votes", "type": "boolean", "description": "Adds `appVersion`, `helpfulVotes`, `totalVotes` and `reviewerUrl` to reviews from Apple's reviews RSS feed (one extra request per 50 reviews). Apple publishes these only for the first 500 reviews per country in the chosen order; older reviews keep them empty.", "default": true }, "searchPlatform": { "title": "Search platform", "enum": [ "iphone", "ipad", "mac" ], "type": "string", "description": "Which store to search in `search` mode: iPhone apps (default), iPad apps or Mac apps.", "default": "iphone" }, "maxItems": { "title": "Max items (total)", "minimum": 1, "type": "integer", "description": "Overall cap on dataset items for the run (reviews, apps or search results). Keeps cost predictable.", "default": 100 }, "onlyNewOrChanged": { "title": "Only new or changed items", "type": "boolean", "description": "Remember what earlier runs of this input returned and output only new items: in `reviews` mode only reviews not output before (read newest first, one page at a time, stopping where the previous run's reviews begin; forces **Review order** = Most recent); in `details` mode apps whose price, version or star rating changed per country; in `search` mode apps that are new in the results or whose price or version changed. Use with a Schedule; unchanged items are not charged.", "default": false }, "monitoringKey": { "title": "Monitoring key", "type": "string", "description": "Name for this watch, so several schedules on the same search stay separate; defaults to a key derived from the search input. Only used with **Only new or changed items**." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify datacenter proxy (default) is enough: Apple's endpoints are public. Requests rotate IPs to spread Apple's per-IP rate limit.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }