{ "openapi": "3.0.1", "info": { "title": "Apple App Store Scraper", "description": "Extract Apple App Store app details, ratings, reviews, charts, and search results by keyword or direct app ID/URL.", "version": "0.0", "x-build-id": "Kybdo2VgyX8zaYVjC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/karamelo~apple-app-store-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-karamelo-apple-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/karamelo~apple-app-store-scraper/runs": { "post": { "operationId": "runs-sync-karamelo-apple-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/karamelo~apple-app-store-scraper/run-sync": { "post": { "operationId": "run-sync-karamelo-apple-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": "🔧 Mode", "enum": [ "search", "details", "reviews", "charts" ], "type": "string", "description": "Choose what to scrape: search apps by keyword, look up app details by ID/URL, extract customer reviews, or discover top charts.", "default": "search" }, "searchTerm": { "title": "Search keyword", "type": "string", "description": "Keyword to search the App Store for in search mode. For example: \"budget planner\", \"language learning\"." }, "appIds": { "title": "App IDs or URLs", "type": "array", "description": "Apple App Store URLs or numeric app IDs. Used in 'details' and 'reviews' modes. For example: \"https://apps.apple.com/us/app/duolingo-language-lessons/id570060128\" or \"570060128\".", "default": [], "items": { "type": "string" } }, "chartType": { "title": "Chart", "enum": [ "top-free", "top-paid" ], "type": "string", "description": "Apple chart feed to discover in 'charts' mode: Top Free or Top Paid apps.", "default": "top-free" }, "chartLimit": { "title": "Chart results", "minimum": 1, "maximum": 100, "type": "integer", "description": "Number of ranked apps to resolve from the ranking feed in 'charts' mode (1–100).", "default": 50 }, "country": { "title": "🌍 Country", "type": "string", "description": "Two-letter country code for the target App Store storefront (e.g. \"us\", \"gb\", \"de\", \"fr\", \"jp\"). Affects pricing currency, availability, and review language.", "default": "us" }, "priceFilter": { "title": "Price filter", "enum": [ "all", "free", "paid" ], "type": "string", "description": "Filter results by app pricing tier: all apps, free apps only, or paid apps only.", "default": "all" }, "maxItems": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Maximum records to output for each requested item type per query. In details mode with reviews enabled, this limits app rows and review rows independently. Set 0 for unlimited.", "default": 50 }, "includeReviews": { "title": "Include reviews with app details", "type": "boolean", "description": "When in 'details' or 'search' mode, also fetch customer reviews for each resolved app alongside its metadata.", "default": false }, "reviewSort": { "title": "Review sort order", "enum": [ "mostRecent", "mostHelpful" ], "type": "string", "description": "How to sort customer reviews. Used in 'reviews' mode or when 'Include reviews' is enabled.", "default": "mostRecent" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy or custom proxy settings to ensure high concurrency, speed, and avoid rate limits.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }