{ "openapi": "3.0.1", "info": { "title": "App Store Scraper — App Details, Search & Top Charts (ASO)", "description": "Know exactly where you and your competitors rank on the Apple App Store. One actor pulls live top charts, keyword search rankings, and full 44-field app details — straight off Apple's public APIs, no login, no tokens to break. Built for ASO, competitive intel, and AI agents.", "version": "0.1", "x-build-id": "nuzIYbu5jl8hJh4Bn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apricot_blackberry~app-store-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apricot_blackberry-app-store-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/apricot_blackberry~app-store-scraper/runs": { "post": { "operationId": "runs-sync-apricot_blackberry-app-store-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/apricot_blackberry~app-store-scraper/run-sync": { "post": { "operationId": "run-sync-apricot_blackberry-app-store-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": { "mode": { "title": "Mode", "enum": [ "charts", "search", "details" ], "type": "string", "description": "What to scrape. Auto-detected from your input: app ids/URLs → details; search terms → search; nothing → top charts." }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Keywords to search the App Store for. Result order is the app's ranking for that keyword (ASO rank).", "items": { "type": "string" } }, "appIds": { "title": "App ids or URLs", "type": "array", "description": "Numeric App Store app ids (e.g. 324684580) or full URLs (e.g. https://apps.apple.com/us/app/id324684580).", "items": { "type": "string" } }, "chartType": { "title": "Chart type", "enum": [ "top-free", "top-paid", "top-grossing", "top-free-ipad", "top-paid-ipad", "new", "new-free", "new-paid" ], "type": "string", "description": "Which top chart to pull in charts mode.", "default": "top-free" }, "genreId": { "title": "Genre / category id (optional)", "type": "string", "description": "Apple genre id to scope charts to a category (e.g. 6014 = Games, 6017 = Education, 6015 = Finance). Leave blank for all categories." }, "entity": { "title": "Search entity", "enum": [ "software", "iPadSoftware", "macSoftware" ], "type": "string", "description": "What to search for in search mode.", "default": "software" }, "country": { "title": "Country store", "type": "string", "description": "Two-letter country code for the App Store storefront (e.g. us, gb, jp, cn, de).", "default": "us" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 200, "type": "integer", "description": "Cap on rows per run (per chart, per search term, or total apps). Apple caps charts/search at 200.", "default": 50 }, "delayBetweenRequests": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Pause between API calls.", "default": 300 }, "navigationTimeoutMs": { "title": "Request timeout (ms)", "minimum": 5000, "maximum": 120000, "type": "integer", "description": "Per-request timeout in milliseconds.", "default": 25000 }, "maxProxyRetries": { "title": "Max proxy retries on failure", "minimum": 0, "maximum": 8, "type": "integer", "description": "If a direct request fails or is rate-limited, retry through Apify residential proxy with a fresh rotating session, up to this many times, before giving up. 0 disables proxy fallback.", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration (optional)", "type": "object", "description": "Self-healing: requests go DIRECT first (free) against Apple’s public APIs, and only fall back to Apify residential proxy with a fresh rotating session if one fails — so you pay for proxy only when it’s actually needed. Set your own proxy here to override. Proxy data is billed to your Apify account." } } }, "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 } } } } } } } } } }