{ "openapi": "3.0.1", "info": { "title": "iPad App Store Scraper", "description": "Search iPad apps by keyword, App Store URL, or ID. Export prices, ratings, versions, screenshots, compatibility, genres, and developer metadata.", "version": "1.0", "x-build-id": "Z866qYhNAOuCbOP12" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/muhammadafzal~ipad-app-store-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-muhammadafzal-ipad-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/muhammadafzal~ipad-app-store-scraper/runs": { "post": { "operationId": "runs-sync-muhammadafzal-ipad-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/muhammadafzal~ipad-app-store-scraper/run-sync": { "post": { "operationId": "run-sync-muhammadafzal-ipad-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", "required": [ "mode", "country", "maxResults" ], "properties": { "mode": { "title": "Collection mode", "enum": [ "search", "lookup" ], "type": "string", "description": "Use Search to discover iPad apps by keyword. Use Lookup when you already have App Store URLs or numeric Apple app IDs. Search is the default.", "default": "search" }, "searchTerms": { "title": "Search terms", "minItems": 1, "maxItems": 20, "type": "array", "description": "Use this in Search mode. Enter 1–20 App Store keywords such as `productivity` or `drawing`. Results are de-duplicated across terms. This is not a web or developer-name search guarantee.", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "default": [ "productivity" ] }, "appUrls": { "title": "App Store URLs", "type": "array", "description": "Use this in Lookup mode for public Apple App Store app URLs, for example `https://apps.apple.com/us/app/procreate/id425073498`. Non-Apple URLs are rejected.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "appIds": { "title": "Apple app IDs", "maxItems": 200, "type": "array", "description": "Use this in Lookup mode for numeric Apple app IDs, for example `425073498`. IDs can be strings or integers and are de-duplicated with IDs found in App Store URLs.", "items": { "type": "string", "pattern": "^[0-9]{5,20}$" }, "default": [] }, "country": { "title": "App Store country", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "Use this to select the storefront for localized price, currency, ratings, and availability. Enter a two-letter ISO country code such as `US`, `GB`, `DE`, or `JP`. Default: `US`.", "default": "US" }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 200, "type": "integer", "description": "Use this to cap the total number of unique app records and PPE result charges across all inputs. Accepted range: 1–200. Default: 25.", "default": 25 }, "includeExplicit": { "title": "Include explicit results", "type": "boolean", "description": "Use this in Search mode to allow results Apple marks explicit. Default: false. This does not bypass age, region, or App Store availability restrictions.", "default": false }, "language": { "title": "Response language", "enum": [ "en_us", "ja_jp" ], "type": "string", "description": "Use this to request Apple's supported response language. `en_us` is English and `ja_jp` is Japanese. Default: `en_us`; app descriptions may still follow storefront availability.", "default": "en_us" }, "maxRequestRetries": { "title": "Request retries", "minimum": 0, "maximum": 3, "type": "integer", "description": "Use this to retry temporary Apple 429, 5xx, timeout, or network responses with bounded backoff. Accepted range: 0–3. Default: 2; permanent 4xx errors are not retried.", "default": 2 } } }, "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 } } } } } } } } } }