{ "openapi": "3.0.1", "info": { "title": "Apple App Store Scraper: Apps, Reviews and Top Charts", "description": "Search apps, look up apps by id or bundle id, pull customer reviews and read the top charts, from Apple's official public APIs. No HTML scraping, no reviewer names, and a source link on every record.", "version": "0.0", "x-build-id": "uh3e6dwhJ5SUB2GjT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/groundtruth~app-store-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-groundtruth-app-store-data", "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/groundtruth~app-store-data/runs": { "post": { "operationId": "runs-sync-groundtruth-app-store-data", "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/groundtruth~app-store-data/run-sync": { "post": { "operationId": "run-sync-groundtruth-app-store-data", "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 get", "enum": [ "search", "lookup", "reviews", "top_charts" ], "type": "string", "description": "search: find apps by keyword. lookup: get apps by id or bundle id. reviews: get customer reviews for apps. top_charts: get the current top apps for a country and category.", "default": "search" }, "search_terms": { "title": "Search keywords", "type": "array", "description": "Used by mode search. One search per keyword per country. Example: meditation, budget planner.", "default": [ "meditation" ], "items": { "type": "string" } }, "app_ids": { "title": "App ids", "type": "array", "description": "Used by modes lookup and reviews. The number in the App Store URL (310633997 in apps.apple.com/us/app/whatsapp-messenger/id310633997). A full App Store URL also works.", "items": { "type": "string" } }, "bundle_ids": { "title": "Bundle ids", "type": "array", "description": "Used by modes lookup and reviews, as an alternative to app ids. Example: net.whatsapp.WhatsApp.", "items": { "type": "string" } }, "countries": { "title": "Countries", "type": "array", "description": "Two letter App Store country codes, such as us, gb, de, jp. Every search, lookup, review pull and chart runs once per country. Maximum 20.", "default": [ "us" ], "items": { "type": "string" } }, "max_results": { "title": "Apps per search", "minimum": 1, "maximum": 200, "type": "integer", "description": "Mode search: how many apps to return for each keyword and country. 1 to 200.", "default": 10 }, "max_reviews_per_app": { "title": "Reviews per app and country", "minimum": 1, "maximum": 500, "type": "integer", "description": "Mode reviews: how many reviews to return for each app in each country. 1 to 500. Apple publishes at most 500 recent reviews per app and country.", "default": 50 }, "review_sort": { "title": "Review order", "enum": [ "mostrecent", "mosthelpful" ], "type": "string", "description": "Mode reviews: newest first, or most helpful first.", "default": "mostrecent" }, "chart": { "title": "Chart", "enum": [ "top-free", "top-paid", "top-grossing" ], "type": "string", "description": "Mode top_charts: which chart to read.", "default": "top-free" }, "category": { "title": "Chart category", "enum": [ "all", "business", "weather", "utilities", "travel", "sports", "social-networking", "reference", "productivity", "photo-and-video", "news", "navigation", "music", "lifestyle", "health-and-fitness", "games", "finance", "entertainment", "education", "books", "medical", "food-and-drink", "shopping", "developer-tools" ], "type": "string", "description": "Mode top_charts: limit the chart to one App Store category, or all.", "default": "all" }, "max_chart_items": { "title": "Apps per chart", "minimum": 1, "maximum": 100, "type": "integer", "description": "Mode top_charts: how many apps to return per country. 1 to 100, the most Apple publishes per chart.", "default": 25 }, "include_description": { "title": "Include description and release notes", "type": "boolean", "description": "Add the store description and the latest release notes to each app record. Makes records larger.", "default": false }, "max_total_records": { "title": "Maximum records per run", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "A safety cap on apps plus reviews in one run. The run stops when it is reached.", "default": 20000 } } }, "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 } } } } } } } } } }