{ "openapi": "3.0.1", "info": { "title": "App Store (iOS) App Metadata, Ratings & Top Charts Lookup", "description": "App Store lookup for iOS apps: ratings, price, version, update date, size, genres and description from any app id, bundle id, store URL or search term — plus Top Free and Top Paid charts.", "version": "0.1", "x-build-id": "4PA4bLejbH2nFt5rU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/webdatatools~app-store-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-webdatatools-app-store-lookup", "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/webdatatools~app-store-lookup/runs": { "post": { "operationId": "runs-sync-webdatatools-app-store-lookup", "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/webdatatools~app-store-lookup/run-sync": { "post": { "operationId": "run-sync-webdatatools-app-store-lookup", "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": [ "apps" ], "properties": { "mode": { "title": "Mode", "enum": [ "lookup", "topCharts" ], "type": "string", "description": "Choose lookup to resolve the apps you list below, or topCharts to download a storefront's Top Free or Top Paid chart. In topCharts mode the apps field is ignored and chart, chartLimit and country decide the output.", "default": "lookup" }, "apps": { "title": "Apps to look up", "type": "array", "description": "Enter one app per row in any of four forms: a numeric App Store id (324684580), a bundle id (com.spotify.client), an App Store URL (https://apps.apple.com/us/app/spotify-music/id324684580), or a search term prefixed with search: (search:meditation, which returns up to searchLimit apps). Used in lookup mode only.", "default": [ "324684580" ], "items": { "type": "string" } }, "country": { "title": "Storefront country", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "Enter the two-letter country code of the App Store storefront to read, e.g. us, gb, de, jp. Prices, ratings, descriptions and chart positions are all storefront-specific, so us and de can return different numbers for the same app.", "default": "us" }, "searchLimit": { "title": "Results per search term", "minimum": 1, "maximum": 200, "type": "integer", "description": "Enter how many apps each search: term should return, e.g. 25. Apple's Search API caps this at 200. Only affects rows starting with search: — an id or bundle id always returns exactly one row.", "default": 25 }, "chart": { "title": "Chart", "enum": [ "top-free", "top-paid" ], "type": "string", "description": "Pick which chart to download in topCharts mode. Apple's public RSS feed serves only these two for apps — there is no top-grossing feed (it returns HTTP 404).", "default": "top-free" }, "chartLimit": { "title": "Chart size", "minimum": 10, "maximum": 100, "type": "integer", "description": "Enter how many ranked apps to return in topCharts mode, e.g. 50. Apple's feed only serves 10, 25, 50 or 100 positions; any other number (including this field's own min/max) is rounded up to the nearest one of those four.", "default": 50 }, "enrichChartApps": { "title": "Enrich chart rows with full metadata", "type": "boolean", "description": "Keep this on so every charted app also gets its ratings, price, version, size and description from the iTunes lookup API. Apple's chart feed alone only carries name, developer, icon and release date. Turning it off makes a 100-app chart two requests cheaper but leaves those columns null.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Enter how many Apple API requests to run in parallel, e.g. 5. Apple throttles the iTunes Search API per IP and answers HTTP 403 when you push too hard; drop this to 1-2 if you see 403 errors in the log.", "default": 5 } } }, "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 } } } } } } } } } }