{ "openapi": "3.0.1", "info": { "title": "ASO Keyword Scraper: App Store Rank Tracker", "description": "Scrape App Store search results for any keyword and country storefront. Returns each app exact rank, plus name, developer, price, rating, rating count, genres, screenshots and description. Also resolves app metadata by ID, bundle ID or URL. Built for ASO and competitor tracking.", "version": "0.1", "x-build-id": "VxC1smEx3evXtfHca" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axiorasolutions~aso-keyword-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axiorasolutions-aso-keyword-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/axiorasolutions~aso-keyword-scraper/runs": { "post": { "operationId": "runs-sync-axiorasolutions-aso-keyword-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/axiorasolutions~aso-keyword-scraper/run-sync": { "post": { "operationId": "run-sync-axiorasolutions-aso-keyword-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", "required": [ "keywords", "countries" ], "properties": { "keywords": { "title": "Keywords to rank for", "minItems": 1, "uniqueItems": true, "type": "array", "description": "One search term per entry. These are searched exactly as written, so use the phrasing a real user would type: \"habit tracker\", \"budget app\", \"learn spanish\". Results come back in Apple's relevance order.", "items": { "type": "string" } }, "countries": { "title": "Country storefronts", "minItems": 1, "type": "array", "description": "Two-letter App Store country codes. Rankings are per storefront, so the same app can sit at position 3 in the US and 40 in Germany. Add every market you care about.", "items": { "type": "string" } }, "apps": { "title": "Apps to look up directly", "type": "array", "description": "Optional. Resolve app metadata without a keyword search. Rows written from this list have rank null and keyword null. Accepts a numeric App Store ID, a bundle ID, an App Store URL, or name:Search Term for the top match by name.", "items": { "type": "string" } }, "resultsPerKeyword": { "title": "Results per keyword", "minimum": 1, "maximum": 200, "type": "integer", "description": "How deep to rank each keyword. Top-10 is what most ASO work targets; 50 gives you the long tail and the competitive picture below the fold.", "default": 50 }, "includeAppDetails": { "title": "Also resolve apps in the apps list", "type": "boolean", "description": "Turn off to run a pure keyword-ranking pass and ignore the apps list.", "default": true }, "minRating": { "title": "Minimum average rating filter", "minimum": 0, "maximum": 5, "type": "integer", "description": "Drop ranking rows whose average rating is below this value. Leave at 0 to keep everything.", "default": 0 }, "freeOnly": { "title": "Free apps only", "type": "boolean", "description": "Keep only apps that cost nothing to download. In-app purchases are not covered by this filter.", "default": false }, "paidOnly": { "title": "Paid apps only", "type": "boolean", "description": "Keep only apps with a download price above zero.", "default": false }, "maxTotal": { "title": "Max rows for the whole run", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Hard ceiling across all keywords, storefronts and app lookups.", "default": 3000 } } }, "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 } } } } } } } } } }