{ "openapi": "3.0.1", "info": { "title": "Google Play Scraper", "description": "Scrape Google Play in one actor - app search, country-localized top charts, similar apps, developer portfolios, full app detail and reviews. Pick what you need with data types. Pay only per result.", "version": "1.0", "x-build-id": "TJ9sfYsN4CrE1mAna" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jdtpnjtp~google-play-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jdtpnjtp-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/jdtpnjtp~google-play-scraper/runs": { "post": { "operationId": "runs-sync-jdtpnjtp-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/jdtpnjtp~google-play-scraper/run-sync": { "post": { "operationId": "run-sync-jdtpnjtp-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": { "dataTypes": { "title": "What to scrape", "uniqueItems": true, "type": "array", "description": "Choose one or more data types. Each needs its matching input below: Search needs keywords, App detail / Reviews need app IDs, Similar needs app IDs, Developer needs developer IDs. Top charts needs only a country.", "items": { "type": "string", "enum": [ "search", "app", "reviews", "topcharts", "similar", "developer" ], "enumTitles": [ "🔎 Search apps", "📱 App detail (by ID/URL)", "⭐ App reviews", "🏆 Top charts", "🧩 Similar apps", "👤 Developer apps" ] }, "default": [ "search" ] }, "searchQueries": { "title": "Search keywords", "uniqueItems": true, "type": "array", "description": "Keywords to search the Play Store for (used by 🔎 Search). Example: `puzzle games`, `vpn`.", "items": { "type": "string" } }, "appIds": { "title": "Apps (name, ID or URL)", "uniqueItems": true, "type": "array", "description": "Apps to pull detail / reviews / similar for (used by 📱 App detail, ⭐ Reviews, 🧩 Similar). Accepts a package name (`com.spotify.music`), a Play Store URL, or just the app name (`Spotify`) - the top search match is used.", "items": { "type": "string" } }, "developerIds": { "title": "Developer names or IDs", "uniqueItems": true, "type": "array", "description": "Developers to pull the published app portfolio for (used by 👤 Developer apps). Example: `Google LLC`.", "items": { "type": "string" } }, "similarToAppIds": { "title": "Find apps similar to", "uniqueItems": true, "type": "array", "description": "Apps to find similar apps for (used by 🧩 Similar apps). Accepts a package name, Play URL, or just the app name.", "items": { "type": "string" } }, "maxResults": { "title": "Max results per input", "minimum": 1, "maximum": 500, "type": "integer", "description": "Upper bound of rows per search / chart / developer / similar input. Each row is one paid result. Store-side caps: search returns up to 250, developer portfolios up to 200.", "default": 30 }, "includeAppDetails": { "title": "Enrich listings with app detail ($)", "type": "boolean", "description": "When on, each search / chart / similar / developer row is enriched with a 60+ field app-detail call. Adds one app-detail result charge per enriched row.", "default": false }, "country": { "title": "Country", "enum": [ "us", "gb", "ca", "au", "in", "de", "fr", "es", "it", "nl", "br", "mx", "jp", "kr", "id", "ru", "tr", "sa", "ae", "ng" ], "type": "string", "description": "Store country. Top charts, rankings and prices are localized to it.", "default": "us" }, "lang": { "title": "Language", "enum": [ "en", "es", "pt", "de", "fr", "it", "nl", "ja", "ko", "ru", "id", "hi", "tr", "ar", "zh" ], "type": "string", "description": "Language for titles, descriptions and reviews.", "default": "en" }, "chartCollection": { "title": "Chart collection", "enum": [ "topselling_free", "topselling_paid", "topgrossing" ], "type": "string", "description": "Which top-chart list to pull (used by 🏆 Top charts).", "default": "topselling_free" }, "chartCategory": { "title": "Chart category", "enum": [ "APPLICATION", "GAME", "ART_AND_DESIGN", "BOOKS_AND_REFERENCE", "BUSINESS", "COMMUNICATION", "EDUCATION", "ENTERTAINMENT", "FINANCE", "FOOD_AND_DRINK", "HEALTH_AND_FITNESS", "LIFESTYLE", "MAPS_AND_NAVIGATION", "MEDICAL", "MUSIC_AND_AUDIO", "NEWS_AND_MAGAZINES", "PHOTOGRAPHY", "PRODUCTIVITY", "SHOPPING", "SOCIAL", "SPORTS", "TOOLS", "TRAVEL_AND_LOCAL", "VIDEO_PLAYERS", "WEATHER" ], "type": "string", "description": "Category to rank within (used by 🏆 Top charts).", "default": "APPLICATION" }, "chartDevice": { "title": "Chart device", "enum": [ "", "tablet", "watch", "tv", "car", "chromebook", "xr" ], "type": "string", "description": "Optional form-factor for the chart. Leave on Phone for the standard charts.", "default": "" }, "reviewsSort": { "title": "Reviews sort order", "enum": [ "newest", "rating", "most_relevant" ], "type": "string", "description": "Order reviews are pulled in (used by ⭐ Reviews).", "default": "newest" }, "maxReviewsPerApp": { "title": "Max reviews per app", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "How deep to go per app - 100, 10,000 or every review the app has (used by ⭐ Reviews). The Actor pulls reviews until it reaches this number or runs out.", "default": 100 }, "filterScore": { "title": "Keep only this star rating", "enum": [ "", "5", "4", "3", "2", "1" ], "type": "string", "description": "Optionally keep only reviews with this rating (used by ⭐ Reviews).", "default": "" } } }, "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 } } } } } } } } } }