{ "openapi": "3.0.1", "info": { "title": "Apple App Store Scraper", "description": "Scrapes the Apple App Store: search, app details, iPhone/iPad/Mac charts, developer catalogues, reviews, and rating histograms.", "version": "0.0", "x-build-id": "C639u43IC2xn6hNpG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mina_safwat~apple-app-store-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mina_safwat-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/mina_safwat~apple-app-store-scraper/runs": { "post": { "operationId": "runs-sync-mina_safwat-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/mina_safwat~apple-app-store-scraper/run-sync": { "post": { "operationId": "run-sync-mina_safwat-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": "What to scrape", "enum": [ "Search", "App details", "Top charts", "Developer apps", "Similar apps" ], "type": "string", "description": "Search finds apps by keyword. App details looks up exact app IDs. Top charts lists the ranked charts. Developer apps lists a publisher’s catalogue. Similar apps returns Apple’s own “you might also like” list.", "default": "Search" }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Keywords to search, one per line. Used by the Search mode. Results from several terms are merged and de-duplicated.", "default": [], "items": { "type": "string" } }, "appIds": { "title": "App IDs", "type": "array", "description": "Numeric App Store IDs (the id… number in an App Store URL) or bundle IDs like \"com.spotify.client\". Used by App details and Similar apps.", "default": [], "items": { "type": "string" } }, "developerId": { "title": "Developer ID", "type": "string", "description": "Numeric developer ID — read it from the \"developerId\" field of any of that publisher’s apps. Used by the Developer apps mode." }, "collection": { "title": "Chart", "enum": [ "Top free (iPhone)", "Top paid (iPhone)", "Top grossing (iPhone)", "Top free (iPad)", "Top paid (iPad)", "New (iPhone)", "Top free (Mac)", "Top paid (Mac)" ], "type": "string", "description": "Which chart to read, including iPad and Mac charts. Used by the Top charts mode.", "default": "Top free (iPhone)" }, "category": { "title": "Category", "enum": [ "All categories", "BOOKS", "BUSINESS", "CATALOGS", "EDUCATION", "ENTERTAINMENT", "FINANCE", "FOOD_AND_DRINK", "GAMES", "GAMES_ACTION", "GAMES_ADVENTURE", "GAMES_ARCADE", "GAMES_BOARD", "GAMES_CARD", "GAMES_CASINO", "GAMES_DICE", "GAMES_EDUCATIONAL", "GAMES_FAMILY", "GAMES_MUSIC", "GAMES_PUZZLE", "GAMES_RACING", "GAMES_ROLE_PLAYING", "GAMES_SIMULATION", "GAMES_SPORTS", "GAMES_STRATEGY", "GAMES_TRIVIA", "GAMES_WORD", "HEALTH_AND_FITNESS", "LIFESTYLE", "MAGAZINES_AND_NEWSPAPERS", "MAGAZINES_ARTS", "MAGAZINES_AUTOMOTIVE", "MAGAZINES_WEDDINGS", "MAGAZINES_BUSINESS", "MAGAZINES_CHILDREN", "MAGAZINES_COMPUTER", "MAGAZINES_FOOD", "MAGAZINES_CRAFTS", "MAGAZINES_ELECTRONICS", "MAGAZINES_ENTERTAINMENT", "MAGAZINES_FASHION", "MAGAZINES_HEALTH", "MAGAZINES_HISTORY", "MAGAZINES_HOME", "MAGAZINES_LITERARY", "MAGAZINES_MEN", "MAGAZINES_MOVIES_AND_MUSIC", "MAGAZINES_POLITICS", "MAGAZINES_OUTDOORS", "MAGAZINES_FAMILY", "MAGAZINES_PETS", "MAGAZINES_PROFESSIONAL", "MAGAZINES_REGIONAL", "MAGAZINES_SCIENCE", "MAGAZINES_SPORTS", "MAGAZINES_TEENS", "MAGAZINES_TRAVEL", "MAGAZINES_WOMEN", "MEDICAL", "MUSIC", "NAVIGATION", "NEWS", "PHOTO_AND_VIDEO", "PRODUCTIVITY", "REFERENCE", "SHOPPING", "SOCIAL_NETWORKING", "SPORTS", "TRAVEL", "UTILITIES", "WEATHER" ], "type": "string", "description": "Restrict the chart to one category. Used by the Top charts mode.", "default": "All categories" }, "country": { "title": "Country", "type": "string", "description": "Two-letter App Store country code. Charts, prices, and availability are store-specific.", "default": "us" }, "language": { "title": "Language", "type": "string", "description": "Locale for titles and descriptions, e.g. \"en-us\", \"de-de\".", "default": "en-us" }, "maxApps": { "title": "Max apps", "minimum": 1, "type": "integer", "description": "Stops after this many apps.", "default": 50 }, "fullDetails": { "title": "Fetch full app details", "type": "boolean", "description": "Chart results carry only a summary. Leave this on to fetch the complete record — description, release notes, screenshots, supported devices. Turn it off for a faster run.", "default": true }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Attach user reviews to each app record. Apple caps paging at 10 pages (about 500 reviews per app).", "default": false }, "maxReviewsPerApp": { "title": "Max reviews per app", "minimum": 1, "type": "integer", "description": "Reviews arrive 50 per page, so 500 is the practical ceiling Apple allows.", "default": 100 }, "reviewsSort": { "title": "Sort reviews by", "enum": [ "Most helpful", "Newest" ], "type": "string", "description": "Order in which reviews are collected.", "default": "Most helpful" }, "includeRatings": { "title": "Include rating breakdown", "type": "boolean", "description": "Attach the 1–5 star histogram and the total number of ratings.", "default": false }, "includeSimilar": { "title": "Include similar apps", "type": "boolean", "description": "Attach up to 20 apps Apple considers similar — useful for mapping competitors.", "default": false } } }, "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 } } } } } } } } } }