{ "openapi": "3.0.1", "info": { "title": "App Store Top Charts Scraper: iOS App Rankings by Country", "description": "Track App Store rankings: top 100 apps by country, top charts by country and category rankings on iPhone and iPad, daily. Top free apps, top paid apps, top grossing apps, top games and new apps, with rank, rating, developer, price. An ASO app rank tracker with rank changes since your last run.", "version": "0.1", "x-build-id": "gLn2aGa4RvDMrLLhE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/glitchbound~app-charts-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-glitchbound-app-charts-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/glitchbound~app-charts-scraper/runs": { "post": { "operationId": "runs-sync-glitchbound-app-charts-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/glitchbound~app-charts-scraper/run-sync": { "post": { "operationId": "run-sync-glitchbound-app-charts-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": { "countries": { "title": "Countries", "uniqueItems": true, "type": "array", "description": "Two-letter App Store country codes, one per line (us, gb, de, jp, il...). Add several to compare the same chart across markets in one run.", "items": { "type": "string" } }, "charts": { "title": "Charts", "type": "array", "description": "Which chart(s) to pull. The top charts rank what is winning now; the three 'new' charts list what launched recently, which Apple publishes as its own feed. Note that Apple ignores the row limit on the new charts and returns about a hundred, so this Actor truncates to your limit itself. Leave empty when you only want app details (appIds); with no apps either, Top Free (iPhone) is read.", "items": { "type": "string", "enum": [ "top-free", "top-paid", "top-grossing", "top-free-ipad", "top-paid-ipad", "top-grossing-ipad", "new", "new-free", "new-paid" ], "enumTitles": [ "Top Free (iPhone)", "Top Paid (iPhone)", "Top Grossing (iPhone)", "Top Free (iPad)", "Top Paid (iPad)", "Top Grossing (iPad)", "New Apps", "New Free Apps", "New Paid Apps" ] } }, "categories": { "title": "Categories", "type": "array", "description": "App Store categories. Use \"all\" for the overall chart.", "items": { "type": "string", "enum": [ "all", "games", "business", "education", "entertainment", "finance", "food-drink", "health-fitness", "lifestyle", "medical", "music", "navigation", "news", "photo-video", "productivity", "reference", "shopping", "social-networking", "sports", "travel", "utilities", "weather", "books", "developer-tools", "graphics-design" ], "enumTitles": [ "All categories", "Games", "Business", "Education", "Entertainment", "Finance", "Food & Drink", "Health & Fitness", "Lifestyle", "Medical", "Music", "Navigation", "News", "Photo & Video", "Productivity", "Reference", "Shopping", "Social Networking", "Sports", "Travel", "Utilities", "Weather", "Books", "Developer Tools", "Graphics & Design" ] }, "default": [ "all" ] }, "limit": { "title": "Apps per chart", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many ranked apps to return per chart (Apple serves up to 100).", "default": 50 }, "includeDetails": { "title": "Include app details", "type": "boolean", "description": "Add each app's star rating, rating count, version, last update date, size, age rating, minimum iOS version and seller website. One extra request per country covers every chart in it.", "default": false }, "trackRankChanges": { "title": "Track rank changes", "type": "boolean", "description": "Compare each chart with the last time your account read it, and add previousRank, rankChange (positive = moved up) and newInChart to every row. The last read is kept in a key-value store in your own account, named app-store-charts-history. Schedule the run daily and every row says what moved.", "default": true }, "appIds": { "title": "Apps (App Store ids, bundle ids or URLs)", "type": "array", "description": "One per line: the app's id (310633997, the number after 'id' in its App Store address), its bundle id (net.whatsapp.WhatsApp) or the App Store URL. Each app is read once for every country above, since price, currency, name and availability differ by country. Leave Charts empty to read only these apps.", "items": { "type": "string" } }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy settings.", "default": { "useApifyProxy": true } }, "maxItems": { "title": "Maximum results (whole run)", "minimum": 0, "type": "integer", "description": "A hard ceiling on rows for the entire run, across every target. The per-target limits above cap each one separately, so fifty targets at twenty each is still a thousand rows; this caps the total. The run stops cleanly when it is reached and nothing beyond that point is fetched or charged. Leave empty for no ceiling." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }