{ "openapi": "3.0.1", "info": { "title": "App Store & Google Play Scraper: Details, Search & Top Charts", "description": "Get App Store and Google Play app data in one run: full app details (rating, installs, price, version, size, screenshots), keyword search results and top free / paid / grossing charts for any country and category.", "version": "0.1", "x-build-id": "LN2dYabpXecTy1qQt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zahidthani~app-store-google-play-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zahidthani-app-store-google-play-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/zahidthani~app-store-google-play-scraper/runs": { "post": { "operationId": "runs-sync-zahidthani-app-store-google-play-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/zahidthani~app-store-google-play-scraper/run-sync": { "post": { "operationId": "run-sync-zahidthani-app-store-google-play-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": { "apps": { "title": "Apps (full details)", "type": "array", "description": "One per line: an App Store URL or numeric ID, a Google Play URL or package name (com.example.app), or just an app name (looked up in both stores). Each app found gives one full-details item per store and country.", "items": { "type": "string" } }, "searchTerms": { "title": "Search keywords", "type": "array", "description": "Keywords to search in the stores, like 'habit tracker' or 'budget app'. Returns the apps in the order the store ranks them (keyword rank tracking for ASO). Google Play shows at most 30 results per search; the App Store up to 200.", "items": { "type": "string" } }, "charts": { "title": "Top charts", "type": "array", "description": "Top charts to download for each store and country. The App Store chart has up to 100 apps; Google Play up to 200.", "items": { "type": "string", "enum": [ "top-free", "top-paid", "top-grossing" ], "enumTitles": [ "Top free", "Top paid", "Top grossing" ] } }, "category": { "title": "Chart category", "enum": [ "all", "games", "books", "business", "education", "entertainment", "finance", "food-drink", "health-fitness", "lifestyle", "medical", "music", "navigation", "news", "photo-video", "productivity", "shopping", "social", "sports", "travel", "utilities", "weather" ], "type": "string", "description": "Category for the top charts (the same list works for both stores). 'All apps' is the overall chart.", "default": "all" }, "stores": { "title": "Stores", "type": "array", "description": "Which stores to query. Pick both to compare iPhone and Android in one dataset.", "items": { "type": "string", "enum": [ "apple", "google" ], "enumTitles": [ "Apple App Store", "Google Play" ] }, "default": [ "apple", "google" ] }, "countries": { "title": "Countries", "type": "array", "description": "Two-letter country codes (us, gb, de, in, br...). Charts, search ranks, prices and ratings differ per country, so each country is fetched separately.", "default": [ "us" ], "items": { "type": "string" } }, "maxResults": { "title": "Max results per search or chart", "minimum": 1, "maximum": 200, "type": "integer", "description": "How many apps to return for each search keyword and each chart, per store and country. Caps: App Store charts 100, Google Play search 30.", "default": 50 }, "includeDetails": { "title": "Full details for search and chart results", "type": "boolean", "description": "Off: search and chart rows have the essentials (rank, name, developer, rating, price, icon, URL) at the cheaper listing price. On: every row also gets the full app details (description, installs, ratings count, version, size, screenshots...) and is charged as an app-details item.", "default": false }, "language": { "title": "Language", "type": "string", "description": "Two-letter language code for Google Play text (descriptions, genres). The App Store uses the country's default language.", "default": "en" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Off by default: the stores' public endpoints answer direct requests and are about 20x faster that way. Turn on Apify Proxy only if you run very large jobs and see 'kept failing' errors.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }