{ "openapi": "3.0.1", "info": { "title": "Apple App Store Scraper - Rankings, Reviews & Apps", "description": "Apple App Store scraper & data API: export top-chart rankings (Top Free, Paid, Grossing, New) by category & country, scrape app reviews & ratings, full app details, metadata and ASO keyword search. iOS app market intelligence & competitor tracking — fast, no login. Pairs with a Google Play scraper.", "version": "0.1", "x-build-id": "xeQxs5tA1tXlyPapy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/haketa~app-store-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-haketa-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/haketa~app-store-scraper/runs": { "post": { "operationId": "runs-sync-haketa-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/haketa~app-store-scraper/run-sync": { "post": { "operationId": "run-sync-haketa-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": { "mode": { "title": "What do you want to scrape?", "enum": [ "rankings", "reviews", "appDetails", "search" ], "type": "string", "description": "Pick a task: top-chart Rankings by category & country, App reviews & ratings, full App details, or a Keyword search. Just leave everything on defaults to get the current US Top Free chart.", "default": "rankings" }, "collection": { "title": "Ranking chart", "enum": [ "TOP_FREE_IOS", "TOP_PAID_IOS", "TOP_GROSSING_IOS", "NEW_IOS", "NEW_FREE_IOS", "NEW_PAID_IOS", "TOP_FREE_IPAD", "TOP_PAID_IPAD", "TOP_GROSSING_IPAD" ], "type": "string", "description": "Used in Rankings mode. Choose which App Store chart to export.", "default": "TOP_FREE_IOS" }, "category": { "title": "Category", "enum": [ "", "GAMES", "BUSINESS", "EDUCATION", "ENTERTAINMENT", "FINANCE", "FOOD_AND_DRINK", "HEALTH_AND_FITNESS", "LIFESTYLE", "MEDICAL", "MUSIC", "NAVIGATION", "NEWS", "PHOTO_AND_VIDEO", "PRODUCTIVITY", "REFERENCE", "SHOPPING", "SOCIAL_NETWORKING", "SPORTS", "TRAVEL", "UTILITIES", "WEATHER", "BOOKS", "MAGAZINES_AND_NEWSPAPERS", "CATALOGS", "GAMES_ACTION", "GAMES_ADVENTURE", "GAMES_ARCADE", "GAMES_BOARD", "GAMES_CARD", "GAMES_CASINO", "GAMES_FAMILY", "GAMES_PUZZLE", "GAMES_RACING", "GAMES_ROLE_PLAYING", "GAMES_SIMULATION", "GAMES_SPORTS", "GAMES_STRATEGY", "GAMES_TRIVIA", "GAMES_WORD" ], "type": "string", "description": "Used in Rankings mode. Pick a category to narrow the chart, or leave on \"Overall (all categories)\" for the whole store.", "default": "" }, "country": { "title": "App Store country", "enum": [ "us", "gb", "ca", "au", "de", "fr", "it", "es", "nl", "se", "no", "dk", "fi", "ie", "ch", "at", "be", "pt", "pl", "ru", "tr", "br", "mx", "ar", "cl", "co", "jp", "kr", "cn", "hk", "tw", "sg", "in", "id", "th", "vn", "ph", "my", "ae", "sa", "il", "za", "nz", "gr", "cz", "ro", "ua" ], "type": "string", "description": "Rankings, prices and reviews are localized per country. Pick the storefront you want.", "default": "us" }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Used in Keyword search mode. Add one or more keywords (like an app name, brand or topic) and get matching apps for each. Leave empty and we'll run a popular mixed sample.", "items": { "type": "string" } }, "appIds": { "title": "Apps to look up", "type": "array", "description": "Used in App reviews & App details modes. Paste one app per line — an App Store link, a numeric App ID (e.g. 389801252) or a bundle ID (e.g. com.burbn.instagram).", "items": { "type": "string" } }, "maxReviewsPerApp": { "title": "Max reviews per app", "minimum": 1, "maximum": 500, "type": "integer", "description": "Used in App reviews mode. Reviews to pull per app. Apple serves up to ~500 per app per country.", "default": 200 }, "reviewsSort": { "title": "Sort reviews by", "enum": [ "RECENT", "HELPFUL" ], "type": "string", "description": "Used in App reviews mode. Order in which reviews are collected.", "default": "RECENT" }, "fullDetail": { "title": "Include full app details", "type": "boolean", "description": "In Rankings & Keyword search modes, also fetch rating, ratings count, description, size and version for every app. On by default. Turn off for a faster, lighter list.", "default": true }, "maxItems": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Cap on how many records (apps or reviews) to return. Use 0 for no limit.", "default": 0 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. The scraper works great out of the box with a direct connection. Turn on a proxy only for very large runs.", "default": { "useApifyProxy": false } }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 15, "type": "integer", "description": "How many apps to process in parallel. Higher is faster but heavier.", "default": 4 } } }, "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 } } } } } } } } } }