{ "openapi": "3.0.1", "info": { "title": "App Store Reviews Scraper - iOS Reviews, Ratings & Details", "description": "Scrape Apple App Store reviews from many countries in one run: rating, title, text, date and app version. App details and app search included. No login needed.", "version": "1.0", "x-build-id": "jEo5lFxImhF3DgbQW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pipiagent~app-store-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pipiagent-app-store-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/pipiagent~app-store-reviews-scraper/runs": { "post": { "operationId": "runs-sync-pipiagent-app-store-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/pipiagent~app-store-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-pipiagent-app-store-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": { "mode": { "title": "What to scrape", "enum": [ "reviews", "appDetails", "search" ], "type": "string", "description": "Choose the kind of data you need. Each mode uses the matching input below.", "default": "reviews" }, "appIds": { "title": "Apps", "type": "array", "description": "Used in reviews and app details modes. Paste App Store links or app ids. The app id is the number at the end of the link, for example 324684580 in apps.apple.com/us/app/spotify/id324684580.", "items": { "type": "string" } }, "countries": { "title": "Countries", "type": "array", "description": "Two-letter country codes of the App Store, for example us, gb, de or jp. Apple shows at most 500 reviews per app in each country, so add more countries to get more reviews. Type \"all\" to go through every country.", "default": [ "us" ], "items": { "type": "string" } }, "searchQueries": { "title": "Search keywords", "type": "array", "description": "Used in search mode. For example \"meditation\" or \"photo editor\". The App Store returns up to 200 apps per keyword and country.", "items": { "type": "string" } }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of results to save in this run.", "default": 100 }, "maxItemsPerApp": { "title": "Max reviews per app", "minimum": 1, "type": "integer", "description": "Optional. Limits the reviews saved for each app, so that one app does not use up the whole run." }, "maxItemsPerCountry": { "title": "Max reviews per app and country", "minimum": 1, "type": "integer", "description": "Optional. Limits the reviews saved for each app in each country. Useful to get an even sample across countries." }, "sort": { "title": "Sort reviews by", "enum": [ "mostRecent", "mostHelpful", "both" ], "type": "string", "description": "Used in reviews mode. \"Both\" reads the newest and the most helpful list and removes duplicates, which gives up to 1,000 reviews per country.", "default": "mostRecent" }, "maxItemsPerQuery": { "title": "Max apps per keyword", "minimum": 1, "maximum": 200, "type": "integer", "description": "Used in search mode. Limits the apps saved for each keyword in each country. The maximum is 200." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. The Actor works without a proxy. Turn one on only if runs start failing with blocked requests.", "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 } } } } } } } } } }