{ "openapi": "3.0.1", "info": { "title": "πŸ”₯ Apple Store Api", "description": "πŸš€ Discover the \"Apple Store API\" by Bebity! Unlock the power of the Apple Store and unleash its vast potential with ease and efficiency! 🌟 Whether you are an app developer πŸ› οΈ, a data analyst πŸ“Š, or a marketer πŸš€, this versatile tool is your ultimate companion for all your Apple Store data needs.", "version": "2.0", "x-build-id": "fvrXv8th6dMfFHIKg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bebity~apple-store-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bebity-apple-store-api", "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/bebity~apple-store-api/runs": { "post": { "operationId": "runs-sync-bebity-apple-store-api", "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/bebity~apple-store-api/run-sync": { "post": { "operationId": "run-sync-bebity-apple-store-api", "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", "required": [ "action" ], "properties": { "action": { "title": "Action", "enum": [ "searchApps", "appDetails", "similarApps", "appReviews" ], "type": "string", "description": "Search apps β†’ the apps found Β· App details β†’ one row per targeted app Β· Similar apps β†’ the similar apps of each targeted app Β· App reviews β†’ the reviews of each targeted app, into the Reviews dataset." }, "includeAppFullDetails": { "title": "Include app full details", "type": "boolean", "description": "The 43 full fields: description, price, developer, average rating, screenshots, version… β€” one batched request for 200 apps, $0.30 / 1,000 apps ($0.20 from the Gold plan). Always included with \"App details\". Unticked: an iPhone search or similar apps return only the id and the URL; a chart or a TV / Watch / Vision search returns a short card. Added automatically when ratings or a developer / genre filter need it on a source without full rows (iPhone / TV / Watch / Vision search, chart, similar apps).", "default": true }, "includeAppStorePage": { "title": "Include app privacy / in-app purchases / versions / chart rank / ratings histogram", "type": "boolean", "description": "Reads each app's App Store page: privacy, in-app purchases (the 10 Apple shows), version history (latest 25), chart rank and ratings histogram β€” one page per app, $0.30 / 1,000 apps ($0.20 from the Gold plan).", "default": false }, "includeRatings": { "title": "Include ratings / histogram", "type": "boolean", "description": "Total and 5β˜…β†’1β˜… histogram β€” one light page per app, $0.20 / 1,000 apps, not billed when Apple publishes no histogram. Already included when the previous box is ticked.", "default": false }, "appIdsOrUrls": { "title": "Apps", "type": "array", "description": "One app per line. E.g. 324684580 Β· com.spotify.client Β· https://apps.apple.com/us/app/id6448311069", "items": { "type": "string" } }, "developers": { "title": "Developers", "type": "array", "description": "Numeric ID (324684583) or name (Supercell). A name is resolved automatically and the row then carries a confidence score.", "items": { "type": "string" } }, "searchTerms": { "title": "Search terms", "type": "array", "description": "One term per line. Each term is a source of its own: the row budget is shared fairly between the terms, the chart and the developers.", "items": { "type": "string" } }, "chart": { "title": "Chart", "enum": [ "", "top-free", "top-paid", "top-grossing", "new", "new-free", "new-paid" ], "type": "string", "description": "Leave empty to skip charts.", "default": "" }, "genre": { "title": "Filter by genre", "enum": [ "", "6000", "6001", "6002", "6003", "6004", "6005", "6006", "6007", "6008", "6009", "6010", "6011", "6012", "6013", "6014", "7001", "7002", "7003", "7004", "7005", "7006", "7007", "7008", "7009", "7011", "7012", "7013", "7014", "7015", "7016", "7017", "7018", "7019", "6015", "6016", "6017", "6018", "6020", "6021", "13001", "13002", "13003", "13004", "13005", "13006", "13007", "13008", "13009", "13010", "13011", "13012", "13013", "13014", "13015", "13017", "13018", "13019", "13020", "13021", "13023", "13024", "13025", "13026", "13027", "13028", "13029", "13030", "6022", "6023", "6024", "6025", "16001", "16003", "16005", "16006", "16007", "16008", "16009", "16010", "16014", "16015", "16017", "16019", "16021", "16025", "16026", "6026", "6027" ], "type": "string", "description": "Store genre. Apple's full list (27 genres, 61 sub-genres). On a top chart, Apple applies the filter; on new releases, Apple ignores it: it is applied to the chart's apps afterwards, which can then hold far fewer than 100; on a search, it is applied to the results (Apple exposes no genre filter on search). Note: Stickers returns nothing on charts.", "default": "" }, "maxReviewsPerApp": { "title": "Max reviews per app", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Apple keeps the full review history: up to 100,000 per app. Many apps have fewer β€” the fetch stops by itself. The run's row cap and your budget apply too.", "default": 50 }, "reviewsSort": { "title": "Review sort", "enum": [ "recent", "helpful", "favorable", "critical" ], "type": "string", "description": "Review order: most recent, most helpful by votes, most favorable or most critical.", "default": "recent" }, "platform": { "title": "Platform", "enum": [ "iphone", "ipad", "mac", "tv", "watch", "vision" ], "type": "string", "description": "Acts on search and charts. No effect on a developer's catalog: Apple does not segment it by platform.", "default": "iphone" }, "country": { "title": "Country", "pattern": "^[a-zA-Z]{2}$", "type": "string", "description": "Country storefront, 2-letter code (115 stores supported). Determines the catalog, prices and currency. Left empty via the API: country of the first Store URL, us otherwise. A code without an App Store storefront is rejected before any request." }, "lang": { "title": "Language", "pattern": "^[a-zA-Z]{2}$", "type": "string", "description": "Metadata language, when the app is localized in that store. Codes accepted by Apple: ar, bg, bn, ca, cs, da, de, el, en, es, et, fi, fr, gu, he, hi, hr, hu, id, is, it, ja, kk, kn, ko, lt, lv, ml, mr, ms, nb, nl, or, pa, pl, pt, ro, ru, sk, sl, sv, ta, te, th, tr, uk, ur, vi, zh. No effect on reviews: Apple does not translate them.", "default": "en" }, "maxItems": { "title": "Max rows", "minimum": 1, "type": "integer", "description": "Global run cap across all sources. Protects your budget.", "default": 200 } } }, "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 } } } } } } } } } }