{ "openapi": "3.0.1", "info": { "title": "Apple App Store Reviews API – iOS Reviews & Ratings", "description": "Extract public Apple App Store reviews as structured JSON across multiple apps and countries.", "version": "1.0", "x-build-id": "vdM9g0S2JMJpnZgBY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/genial_candlestand~apple-app-store-reviews-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-genial_candlestand-apple-app-store-reviews-api", "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/genial_candlestand~apple-app-store-reviews-api/runs": { "post": { "operationId": "runs-sync-genial_candlestand-apple-app-store-reviews-api", "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/genial_candlestand~apple-app-store-reviews-api/run-sync": { "post": { "operationId": "run-sync-genial_candlestand-apple-app-store-reviews-api", "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 — IDs or App Store URLs", "maxItems": 20, "uniqueItems": true, "type": "array", "description": "Add up to 20 numeric App Store IDs, id-prefixed IDs, or full apps.apple.com URLs. Replace the prefilled Facebook ID, or remove it to use only app-name search. URL storefronts are used when Storefront countries is empty; duplicate apps are removed automatically.", "items": { "type": "string", "maxLength": 2048 } }, "appNames": { "title": "Search by app names — optional", "maxItems": 20, "uniqueItems": true, "type": "array", "description": "Add up to 20 app names. For each name, the first Apple software search result is used and logged. Results are combined with Apps and duplicates are removed.", "items": { "type": "string", "maxLength": 200 } }, "countries": { "title": "Storefront countries — optional", "minItems": 1, "maxItems": 20, "uniqueItems": true, "type": "array", "description": "Select common storefronts or enter any two-letter App Store country code. United States is prefilled; remove it to use storefronts found in Apps URLs.", "items": { "type": "string", "enumSuggestedValues": [ "us", "gb", "ca", "au", "de", "fr", "es", "it", "jp", "kr", "in", "br", "mx", "nl", "se", "no", "dk", "fi", "pl", "ua" ], "enumTitles": [ "United States (US)", "United Kingdom (GB)", "Canada (CA)", "Australia (AU)", "Germany (DE)", "France (FR)", "Spain (ES)", "Italy (IT)", "Japan (JP)", "South Korea (KR)", "India (IN)", "Brazil (BR)", "Mexico (MX)", "Netherlands (NL)", "Sweden (SE)", "Norway (NO)", "Denmark (DK)", "Finland (FI)", "Poland (PL)", "Ukraine (UA)" ] } }, "maxReviews": { "title": "Reviews per app–country pair", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum delivered reviews after filters for each app × country pair. For example, 2 apps × 3 countries × 1,000 can return up to 6,000 billable reviews.", "default": 1000 }, "sort": { "title": "Sort reviews by", "enum": [ "mostRecent", "mostHelpful" ], "type": "string", "description": "Newest first is fastest with a date boundary. Most helpful follows Apple's helpfulness order and may need to scan more pages.", "default": "mostRecent" }, "ratings": { "title": "Star ratings — optional", "minItems": 1, "maxItems": 5, "uniqueItems": true, "type": "array", "description": "Select one or more ratings. Leave empty to include all ratings; the review limit is counted after filtering.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "★ 1 star", "★★ 2 stars", "★★★ 3 stars", "★★★★ 4 stars", "★★★★★ 5 stars" ] } }, "since": { "title": "Reviews since — optional", "type": "string", "description": "Choose the earliest review date. Leave empty for all available dates. Full ISO timestamps remain accepted in JSON and API input." }, "includeReviewedVersion": { "title": "Include reviewed app version — slower", "type": "boolean", "description": "Also query Apple RSS to populate reviewedVersion where matching data exists. This increases Apple requests but never blocks delivery of otherwise valid reviews.", "default": false }, "maxConcurrency": { "title": "Concurrent app–country jobs", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of app × country combinations processed at once.", "default": 5 } } }, "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 } } } } } } } } } }