{ "openapi": "3.0.1", "info": { "title": "Apple App Store Scraper (search, app details, reviews, monitor)", "description": "App Store scraper for iOS apps: search by keyword or pass app IDs and get one row per app with price, rating, rating count, version, size, genres, release dates and developer, plus App Store reviews with rating, version and date. Monitor mode alerts on price, version and rating changes.", "version": "0.1", "x-build-id": "CmZIVeYbvrJnWZlad" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datahamster~apple-app-store-apps/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datahamster-apple-app-store-apps", "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/datahamster~apple-app-store-apps/runs": { "post": { "operationId": "runs-sync-datahamster-apple-app-store-apps", "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/datahamster~apple-app-store-apps/run-sync": { "post": { "operationId": "run-sync-datahamster-apple-app-store-apps", "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": { "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Stop after this many results (you are charged only for pushed items)", "default": 100 }, "mode": { "title": "Mode", "enum": [ "scrape", "monitor" ], "type": "string", "description": "scrape = full results; monitor = only new/changed items since the previous run of this task", "default": "scrape" }, "monitorKey": { "title": "Monitor key", "type": "string", "description": "Optional state key when not running as a saved task" }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "POST a change summary here in monitor mode" }, "telegramBotToken": { "title": "Telegram bot token", "type": "string", "description": "Optional: bot token for monitor-mode change summaries" }, "telegramChatId": { "title": "Telegram chat id", "type": "string", "description": "Optional: chat id that receives monitor-mode summaries" }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Keywords to search the App Store for, one per line, e.g. \"meditation\", \"budget tracker\", \"habit tracker\". Each term returns up to 200 apps ranked as the store ranks them.", "default": [ "meditation" ], "items": { "type": "string" } }, "appIds": { "title": "App IDs or URLs", "type": "array", "description": "Apps to scrape directly: numeric IDs (\"324684580\") or App Store URLs (\"https://apps.apple.com/us/app/spotify-music-and-podcasts/id324684580\"). Can be combined with Search terms or used alone.", "items": { "type": "string" } }, "country": { "title": "Storefront country", "type": "string", "description": "Two-letter storefront code, e.g. \"us\", \"gb\", \"de\", \"jp\". Price, currency, availability, ratings and reviews are all storefront-specific.", "default": "us" }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "true = also return customer reviews for every app in the run (one extra row per review). false = app rows only. Example: true.", "default": true }, "maxReviewsPerApp": { "title": "Max reviews per app", "minimum": 0, "maximum": 500, "type": "integer", "description": "How many reviews to return per app, e.g. 100. Apple's public review feed serves 50 per page and 10 pages per storefront, so 500 is the hard ceiling; apps with fewer reviews return fewer rows.", "default": 100 }, "reviewSort": { "title": "Review sort", "enum": [ "mostrecent", "mosthelpful" ], "type": "string", "description": "Order Apple serves the reviews in. \"mostrecent\" is what you want for monitoring; \"mosthelpful\" surfaces the long-form complaints and praise.", "default": "mostrecent" }, "maxAppsPerSearch": { "title": "Max apps per search term", "minimum": 1, "maximum": 200, "type": "integer", "description": "How many apps to return per search term, e.g. 50. Apple caps a single search at 200 results.", "default": 50 } } }, "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 } } } } } } } } } }