{ "openapi": "3.0.1", "info": { "title": "App Store Top Charts Monitor - Rank Changes & New #1 Alerts", "description": "App Store Top Charts (Top Free, Top Paid) for 175 countries from Apple's own RSS feed: rank, app, developer, app ID, URL. Monitoring mode returns only apps that entered, left, moved N places or took number 1, with the previous rank. Track your app and rivals by ID.", "version": "0.1", "x-build-id": "XJ0xIgEPOMr24RbiJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/neverempty~app-store-top-charts-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-neverempty-app-store-top-charts-monitor", "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/neverempty~app-store-top-charts-monitor/runs": { "post": { "operationId": "runs-sync-neverempty-app-store-top-charts-monitor", "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/neverempty~app-store-top-charts-monitor/run-sync": { "post": { "operationId": "run-sync-neverempty-app-store-top-charts-monitor", "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", "type": "array", "description": "Two-letter App Store storefront codes (us, gb, de, jp, fr, br, in, kr...), one per line. 175 storefronts are available, the same list as in Apple's RSS Feed Generator. A code that is not a storefront (for example uk instead of gb) comes back as a free row that says so. Each country and chart type is one chart. Up to 100 charts per run. Empty = us (not allowed in monitoring mode).", "items": { "type": "string" } }, "charts": { "title": "Chart types", "type": "array", "description": "Which charts to read for each country. Apple's feed offers Top Free and Top Paid apps (no Top Grossing and no per-category charts). Empty = Top Free.", "items": { "type": "string", "enum": [ "top-free", "top-paid" ], "enumTitles": [ "Top Free Apps", "Top Paid Apps" ] } }, "topN": { "title": "How many apps per chart", "minimum": 1, "maximum": 100, "type": "integer", "description": "How deep to read each chart, from 1 to 100 (Apple's feed stops at 100). Empty = 50. With monitoring off, each app is one result row. In monitoring mode this is the part of the chart that is watched: an app that falls below it counts as leaving the chart. Changing this number starts a new starting point." }, "appIds": { "title": "App IDs (optional)", "type": "array", "description": "Optional. App Store app IDs (389801252), id389801252, or apps.apple.com app URLs, one per line. When given, only these apps are returned or watched: your app and your competitors. An app that is not in the chart comes back as a free row. Up to 200. Empty = the whole chart.", "items": { "type": "string" } }, "monitoringMode": { "title": "Monitoring mode (only return changes)", "type": "boolean", "description": "On = for scheduled runs and alerts. The first run remembers each chart as a starting point and returns no app rows (free). Later runs return a row only for an app that entered the chart, left it, moved by at least the number of places set below, or became number 1, each with its previous rank. A chart with no change costs one chart check and returns a free no-change row. Off (or empty) = always return the chart." }, "minRankChange": { "title": "Report a move of at least this many places", "minimum": 1, "maximum": 99, "type": "integer", "description": "Monitoring mode only. An app still in the chart is returned when its rank differs by at least this many places from the rank in the last row you received for it (or from the starting point). Empty = 5. Entering the chart, leaving it and a new number 1 are always returned." }, "watchName": { "title": "Watch name", "pattern": "^[A-Za-z0-9._-]{0,40}$", "type": "string", "description": "Optional, used with monitoring mode. Runs with the same watch name share what is remembered. Give a different name to each schedule. Do not run two schedules with the same watch name at the same time. Letters, digits, dot, dash and underscore." }, "resetMonitoringState": { "title": "Reset monitoring state", "type": "boolean", "description": "Forget what this watch remembered at the start of this run, so every chart gets a new starting point. Turn it off again for scheduled runs." } } }, "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 } } } } } } } } } }