{ "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": "sGIg3Zrizbns60Zby" }, "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 to scrape", "enum": [ "rankings", "reviews", "appDetails", "search" ], "type": "string", "description": "rankings = top-chart apps by category & country; reviews = app reviews; appDetails = full app info; search = apps for a keyword.", "default": "rankings" }, "collection": { "title": "Ranking chart (rankings mode)", "enum": [ "TOP_FREE_IOS", "TOP_PAID_IOS", "TOP_GROSSING_IOS", "NEW_IOS" ], "type": "string", "description": "Which chart to scrape.", "default": "TOP_FREE_IOS" }, "category": { "title": "Category (rankings mode)", "type": "string", "description": "Category for the ranking chart. Leave empty for the overall chart, or use a category like GAMES, SOCIAL_NETWORKING, PHOTO_AND_VIDEO, FINANCE, HEALTH_AND_FITNESS, PRODUCTIVITY, ENTERTAINMENT, SHOPPING, GAMES_PUZZLE.", "default": "" }, "appIds": { "title": "App IDs / URLs (reviews & appDetails modes)", "type": "array", "description": "Apple numeric app IDs (e.g. 389801252), bundle IDs (e.g. com.burbn.instagram) or App Store URLs.", "items": { "type": "string" } }, "searchTerms": { "title": "Search terms (search mode)", "type": "array", "description": "Keywords to search for apps.", "items": { "type": "string" } }, "maxReviewsPerApp": { "title": "Max reviews per app (reviews mode)", "minimum": 1, "maximum": 500, "type": "integer", "description": "Reviews to pull per app. Apple serves up to ~500 per app per country.", "default": 200 }, "reviewsSort": { "title": "Reviews sort (reviews mode)", "enum": [ "RECENT", "HELPFUL" ], "type": "string", "description": "Order of reviews.", "default": "RECENT" }, "country": { "title": "Country", "type": "string", "description": "Two-letter App Store country code, e.g. us, gb, de, kr, jp, br. Rankings, prices and reviews are localized per country.", "default": "us" }, "fullDetail": { "title": "Full app details (rankings & search)", "type": "boolean", "description": "Fetch complete app details (rating, ratings count, description, size, version) for each ranked/found app. ON by default. Turn off for a faster, lighter list.", "default": true }, "maxItems": { "title": "Max items", "minimum": 0, "type": "integer", "description": "Maximum records (apps or reviews). Use 0 for no limit.", "default": 1000 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional — Apple's iTunes/RSS APIs are open. Proxies help avoid rate limits on large runs." }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 15, "type": "integer", "description": "Maximum parallel apps processed.", "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 } } } } } } } } } }