{ "openapi": "3.0.1", "info": { "title": "App Store Scraper - Apps, Reviews & Charts", "description": "Read the Apple App Store: search any storefront, look up apps by link or bundle id, list a developer's catalogue, or pull the top charts. Ratings, prices, versions, screenshots and customer reviews included.", "version": "0.1", "x-build-id": "DZYL77TiSElKur5Wq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s-r~app-store-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s-r-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/s-r~app-store-scraper/runs": { "post": { "operationId": "runs-sync-s-r-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/s-r~app-store-scraper/run-sync": { "post": { "operationId": "run-sync-s-r-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": [ "search" ], "properties": { "mode": { "title": "What to read", "enum": [ "search", "detail", "developer", "charts" ], "type": "string", "description": "Search a storefront, look up specific apps, list a developer's catalogue, or read a top chart.", "default": "search" }, "search": { "title": "Search terms", "type": "array", "description": "One term per line. Used in Search mode.", "items": { "type": "string" } }, "appIds": { "title": "Apps", "type": "array", "description": "App Store links, numeric ids or bundle ids, one per line. Used in Specific apps mode.", "items": { "type": "string" } }, "developerIds": { "title": "Developer ids", "type": "array", "description": "Numeric developer ids, one per line. A developer id is on every app row as developer_id. Used in Developer's apps mode.", "items": { "type": "string" } }, "chartFeed": { "title": "Chart", "enum": [ "topfreeapplications", "toppaidapplications", "topgrossingapplications", "newapplications" ], "type": "string", "description": "Which top chart to read. Used in Top charts mode.", "default": "topfreeapplications" }, "genreId": { "title": "Genre id", "type": "string", "description": "Optional App Store genre id to narrow a chart, for example 6014 for Games or 6008 for Photo & Video." }, "country": { "title": "Storefront", "type": "string", "description": "Two-letter country code. Apps, prices, ratings and reviews are all per storefront.", "default": "us" }, "entity": { "title": "Platform", "enum": [ "software", "iPadSoftware", "macSoftware" ], "type": "string", "description": "iPhone, iPad or Mac apps.", "default": "software" }, "maxItems": { "title": "Maximum apps", "minimum": 1, "maximum": 200, "type": "integer", "description": "Per search term, developer or chart. Apple caps a response at 200.", "default": 50 }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Attach customer reviews to every app. Slower and metered separately, because the reviews feed has to be retried before it serves.", "default": false }, "maxReviews": { "title": "Maximum reviews per app", "minimum": 1, "maximum": 100, "type": "integer", "description": "Apple serves at most 100 per app per storefront, in two pages of fifty. Asking for more returns the ceiling.", "default": 100 }, "reviewAttempts": { "title": "Review retry budget", "minimum": 1, "maximum": 30, "type": "integer", "description": "How many times to retry one page of reviews before giving up. The feed answers most requests with an empty page, so a low budget returns fewer reviews rather than failing.", "default": 10 } } }, "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 } } } } } } } } } }