{ "openapi": "3.0.1", "info": { "title": "App Store Reviews Scraper", "description": "Extract customer reviews for any Apple App Store app - rating, title, review text, author, app version, date and vote counts - via Apple's open no-auth feed. Optional app details. No login, no API key.", "version": "0.1", "x-build-id": "uS2fS81HQ2HLCybRr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/xtracto~appstore-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-xtracto-appstore-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/xtracto~appstore-reviews-scraper/runs": { "post": { "operationId": "runs-sync-xtracto-appstore-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/xtracto~appstore-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-xtracto-appstore-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", "properties": { "appId": { "title": "App ID", "type": "string", "description": "The numeric App Store ID of the app to get reviews for. Find it in the app's App Store URL, e.g. .../id310633997 -> 310633997 (WhatsApp). Leave blank if you use 'App IDs' below." }, "appIds": { "title": "App IDs (multiple)", "type": "array", "description": "Optional. Several numeric App Store IDs to scrape in one run. Combined with 'App ID' above if both are given.", "items": { "type": "string" } }, "country": { "title": "Country", "type": "string", "description": "Two-letter storefront code for the country whose reviews you want, e.g. us, gb, de, id, br. Reviews differ per country.", "default": "us" }, "sortBy": { "title": "Sort reviews by", "enum": [ "mostrecent", "mosthelpful" ], "type": "string", "description": "'Most recent' returns the newest reviews first. 'Most helpful' returns the reviews with the most votes first.", "default": "mostrecent" }, "maxReviews": { "title": "Max reviews per app", "minimum": 1, "maximum": 500, "type": "integer", "description": "How many reviews to fetch per app (per country). Apple only exposes up to about 500 reviews per app per country, so values above 500 are capped.", "default": 200 }, "includeMetadata": { "title": "Include app details", "type": "boolean", "description": "If on, also emit one record per app with its App Store details (name, developer, category, average rating, icon, etc.) alongside the reviews.", "default": true }, "maxItems": { "title": "Max records total (0 = no cap)", "minimum": 0, "type": "integer", "description": "Global cap on the total number of records pushed in this run across all apps. 0 = no cap.", "default": 0 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. Apple's review feeds are public, so a proxy is not required. A residential proxy can help if you scrape many apps and hit soft rate limits.", "default": { "useApifyProxy": false, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }