{ "openapi": "3.0.1", "info": { "title": "App Store Rank Tracker – iOS Keyword Rankings & App Changes", "description": "Track where iOS apps rank for your keywords in any App Store country, plus version, price and rating changes between runs. Uses Apple's official public iTunes Search and Lookup APIs.", "version": "0.1", "x-build-id": "AaomvI04ntwEw4CuC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/skuang~app-store-rank-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-skuang-app-store-rank-tracker", "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/skuang~app-store-rank-tracker/runs": { "post": { "operationId": "runs-sync-skuang-app-store-rank-tracker", "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/skuang~app-store-rank-tracker/run-sync": { "post": { "operationId": "run-sync-skuang-app-store-rank-tracker", "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": { "keywords": { "title": "Keywords", "minItems": 1, "maxItems": 50, "type": "array", "description": "Search terms to check, one per line, as a user would type them in the App Store. Up to 50 keywords; keywords × countries can be at most 100 searches per run. Letter case and extra spaces are ignored when finding duplicates.", "default": [ "habit tracker" ], "items": { "type": "string" } }, "countries": { "title": "Countries", "minItems": 1, "maxItems": 10, "type": "array", "description": "Two-letter App Store country codes (us, gb, de, jp, ...). Every keyword is searched in every country. Up to 10. \"uk\" is accepted as an alias for \"gb\".", "default": [ "us" ], "items": { "type": "string" } }, "trackApps": { "title": "Apps to track", "maxItems": 50, "type": "array", "description": "Your apps and competitors: App Store URLs (https://apps.apple.com/us/app/habit-tracker/id1438388363) or numeric app IDs. For each one you get its rank in every keyword search (or \"not in top N\") and, per country, a snapshot of version, price and ratings. Up to 50. Leave empty to only record the keyword rankings.", "default": [ "1438388363" ], "items": { "type": "string" } }, "topN": { "title": "Results per keyword (top N)", "minimum": 1, "maximum": 200, "type": "integer", "description": "How many search results to keep per keyword and country, and how deep to look for your tracked apps. The actor asks Apple for 10 more (at most 200), because Apple often returns a few fewer than asked. Keep it the same between runs: a different value starts a new rank baseline, because Apple's order can depend on how many results are requested.", "default": 10 }, "trackChanges": { "title": "Track changes since the previous run", "type": "boolean", "description": "Compare with the snapshot saved by this actor's previous run and output one change row per change: a tracked app's rank moved, entered or left the top N, a new version was released, the price changed, the average rating moved by 0.05 or more, or the number of ratings moved by at least 10 or 1% (whichever is larger). The first run only saves the baseline. Schedule the actor (for example daily) to get changes.", "default": true }, "outputMode": { "title": "Output", "enum": [ "all", "changes_only", "rankings_only" ], "type": "string", "description": "\"Everything\": keyword rankings, app snapshots and changes. \"Changes only\": only change rows (cheapest for daily monitoring; needs change tracking on). \"Rankings only\": only keyword rankings; no app lookups, no changes, and the saved snapshots are not touched.", "default": "all" } } }, "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 } } } } } } } } } }