{ "openapi": "3.0.1", "info": { "title": "ASO Rank Tracker API — App Store & Google Play Change Alerts", "description": "Monitor Apple App Store and Google Play keyword rankings via API, MCP, or schedule — emits only material rank changes, with confirmation runs to suppress rank jitter. Per-country checks, persistent baselines, uncharged change alerts. $1 per 1,000 rank checks. No browser, no API key.", "version": "0.0", "x-build-id": "zZy1Yc6tcLCLIipKT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kaz_kakyo~aso-rank-delta/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kaz_kakyo-aso-rank-delta", "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/kaz_kakyo~aso-rank-delta/runs": { "post": { "operationId": "runs-sync-kaz_kakyo-aso-rank-delta", "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/kaz_kakyo~aso-rank-delta/run-sync": { "post": { "operationId": "run-sync-kaz_kakyo-aso-rank-delta", "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": [ "checks" ], "properties": { "checks": { "title": "Rank checks", "type": "array", "description": "Required. Array of {keyword, appId, store, country}. store is \"apple\" or \"google\". country is ISO alpha-2 (e.g. us). For apple, appId may be numeric trackId or bundleId; for google, package id (com.example.app). Max 500 unique checks per run. Invalid items become type:error rows; the run still succeeds." }, "monitorId": { "title": "Monitor ID", "type": "string", "description": "Names the persistent snapshot in the aso-rank-delta-state key-value store. Separate monitorIds do not interact. Default: default.", "default": "default" }, "materialityThreshold": { "title": "Materiality threshold", "minimum": 1, "maximum": 100, "type": "integer", "description": "Minimum absolute rank change vs the last reported (committed) rank before a change row is emitted. Enter/exit (null↔rank) are always material. Default: 3.", "default": 3 }, "confirmationRuns": { "title": "Confirmation runs", "minimum": 1, "maximum": 2, "type": "integer", "description": "1 = emit change on first material observation. 2 = require the same direction on a second run before emitting (suppresses rank jitter). Default: 1.", "default": 1 }, "appleSearchDepth": { "title": "Apple search depth", "minimum": 10, "maximum": 200, "type": "integer", "description": "iTunes Search API limit (10–200). Apple may return fewer results than requested. Default: 100.", "default": 100 }, "emitBaselines": { "title": "Emit baseline rows", "type": "boolean", "description": "When true (default), first observation of a check emits a type:baseline row. Set false to seed state silently.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy (datacenter). Used for Google Play fetches and Apple retries. No residential group.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }