{ "openapi": "3.0.1", "info": { "title": "Apple App Store Reviews Scraper", "description": "Scrape Apple App Store apps and reviews by keyword or app ID, across as many country storefronts as you like. Every review row carries rating, title, text, author_name, review_date and country. Export JSON, CSV or Excel, or pull it from the API.", "version": "2.0", "x-build-id": "GbTTR5aYFLzNpQqHB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/herus13~apple-app-store-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-herus13-apple-app-store-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/herus13~apple-app-store-scraper/runs": { "post": { "operationId": "runs-sync-herus13-apple-app-store-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/herus13~apple-app-store-scraper/run-sync": { "post": { "operationId": "run-sync-herus13-apple-app-store-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": { "app_ids": { "title": "App IDs or URLs", "type": "array", "description": "Apps to pull reviews for, one numeric App Store ID or full apps.apple.com URL per entry, for example `324684580` or `https://apps.apple.com/us/app/spotify-music-and-podcasts/id324684580`. Each app returns its reviews in every storefront listed in `countries`. Leave empty to work from `search_queries` instead; provide at least one of `app_ids` or `search_queries`.", "items": { "type": "string" } }, "search_queries": { "title": "Search Queries", "type": "array", "description": "Keywords to search the App Store with, one per entry, for example `meditation app`. Each keyword returns the apps that match it as rows carrying developer, category, price and aggregate rating, and then the reviews of those apps. Leave empty to work from `app_ids` instead; provide at least one of `search_queries` or `app_ids`.", "items": { "type": "string" } }, "countries": { "title": "Countries", "type": "array", "description": "App Store storefronts to cover, one two-letter country code per entry, for example `us`, `gb`, `de`. The storefront decides which apps a search returns and which reviews come back: every country carries its own distinct set of up to 8 reviews per app, so listing more countries returns more reviews. Leave empty to use the United States storefront (`us`).", "items": { "type": "string" } }, "max_apps_per_search": { "title": "Max Apps Per Search Query", "minimum": 1, "maximum": 250, "type": "integer", "description": "How many apps to keep from each entry in `search_queries`, from 1 to 250. Default 10. Every kept app becomes one row and has its reviews collected in each country you list, so this is the main lever on how much a keyword run returns and costs. Apps given directly in `app_ids` are not affected.", "default": 10 }, "rating_filter": { "title": "Rating Filter", "uniqueItems": true, "type": "array", "description": "Keep only reviews with these star ratings; tick any of 1, 2, 3, 4 and 5. Leave empty to keep every rating. The App Store publishes a fixed set of up to 8 reviews per app per country, so this narrows that set rather than reaching further back — add more `countries` when you want a larger review sample.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ] } }, "date_from": { "title": "Reviews From Date", "type": "string", "description": "Keep only reviews published on or after this date, written as YYYY-MM-DD, for example 2026-01-01. Leave empty for no lower bound. Set it together with `date_to` to take a single window." }, "date_to": { "title": "Reviews To Date", "type": "string", "description": "Keep only reviews published on or before this date, written as YYYY-MM-DD, for example 2026-06-30. Leave empty for no upper bound. Set it together with `date_from` to take a single window." }, "proxyUrls": { "title": "Your own proxy URLs (optional)", "type": "array", "description": "Leave empty and the run uses the residential proxy this actor ships with, included in the price of the run. To route the run through your own account instead, add one gateway URL per entry, for example http://user:pass@host:port — works with DataImpulse, Bright Data, Oxylabs, Smartproxy or any provider that issues URLs. When set, only these URLs are used.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }