{ "openapi": "3.0.1", "info": { "title": "Google Play Store Scraper - Apps, Reviews & ASO Ranks", "description": "Scrape Google Play apps: metadata, reviews, keyword search, ASO keyword ranks, charts, similar apps, permissions, and Data safety. Multi-locale runs and monitor mode with webhooks. Fast HTTP — no browser.", "version": "0.2", "x-build-id": "aHAc6YPOWdYfXQRd4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawloop~google-play-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawloop-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/crawloop~google-play-scraper/runs": { "post": { "operationId": "runs-sync-crawloop-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/crawloop~google-play-scraper/run-sync": { "post": { "operationId": "run-sync-crawloop-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "app_details", "app_reviews", "search_and_charts", "developer_apps", "monitor", "keyword_ranks" ], "type": "string", "description": "What to scrape from Google Play Store.", "default": "app_details" }, "appIds": { "title": "App IDs", "type": "array", "description": "Package names (e.g. com.spotify.music). Used by details, reviews, and monitor.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Google Play app, search, developer, or category URLs. App IDs are extracted from details links.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchKeywords": { "title": "Search keywords", "type": "array", "description": "Keywords for search_and_charts / keyword_ranks. Also used for soft ASO title/summary hints on app_details.", "items": { "type": "string" } }, "trackAppIds": { "title": "Track app IDs (keyword ranks)", "type": "array", "description": "Package names to locate in search results (keyword_ranks / search_and_charts). Emits keyword_rank rows with position or found=false.", "items": { "type": "string" } }, "languages": { "title": "Languages (multi-locale)", "type": "array", "description": "Optional hl codes. Combined with countries (cartesian, capped). Empty = use language.", "items": { "type": "string" } }, "countries": { "title": "Countries (multi-locale)", "type": "array", "description": "Optional gl codes. Combined with languages (cartesian, capped). Empty = use country.", "items": { "type": "string" } }, "includeSimilarApps": { "title": "Include similar apps", "type": "boolean", "description": "In app_details, also emit similar_app rows from the details page cluster.", "default": false }, "similarLimit": { "title": "Similar apps limit", "minimum": 1, "maximum": 100, "type": "integer", "description": "Max similar_app rows per source app.", "default": 40 }, "includePermissions": { "title": "Include permissions", "type": "boolean", "description": "In app_details, fetch and emit permission rows.", "default": false }, "includeDataSafety": { "title": "Include data safety", "type": "boolean", "description": "In app_details, fetch Data safety page and emit a data_safety row.", "default": false }, "enrichListings": { "title": "Enrich search/chart listings", "type": "boolean", "description": "Fetch full app details for each search/chart hit (like enrichDeveloperApps).", "default": false }, "maxSearchPages": { "title": "Max search pages", "minimum": 1, "maximum": 10, "type": "integer", "description": "Paginate search when Play returns a continuation token (1–10).", "default": 3 }, "rankHistoryStoreName": { "title": "Keyword rank history KV store", "type": "string", "description": "Named Key-Value Store for keyword_ranks snapshots. Default google-play-rank-history when mode is keyword_ranks.", "default": "" }, "chartType": { "title": "Chart type", "enum": [ "", "topselling_free", "topselling_paid", "topgrossing" ], "type": "string", "description": "Top chart collection when no search keywords (or in addition to category).", "default": "" }, "category": { "title": "Category", "type": "string", "description": "Play category id for charts/category browse (e.g. GAME_ACTION, MUSIC_AND_AUDIO).", "default": "" }, "developerId": { "title": "Developer ID / name", "type": "string", "description": "Developer page id (e.g. Spotify+AB or Spotify AB). Used by developer_apps.", "default": "" }, "developerUrl": { "title": "Developer URL", "type": "string", "description": "Full developer page URL. Overrides developerId when set.", "default": "" }, "enrichDeveloperApps": { "title": "Enrich developer apps", "type": "boolean", "description": "When true, fetch full app details for each developer listing.", "default": false }, "language": { "title": "Language (hl)", "type": "string", "description": "Play UI / content language code.", "default": "en" }, "country": { "title": "Country (gl)", "type": "string", "description": "Store country code (affects prices, charts, availability).", "default": "us" }, "maxReviewsPerApp": { "title": "Max reviews per app", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Maximum reviews to fetch per app (reviews / monitor).", "default": 100 }, "reviewSort": { "title": "Review sort", "enum": [ "NEWEST", "HELPFULNESS", "RATING" ], "type": "string", "description": "Sort order for reviews.", "default": "NEWEST" }, "reviewScoreFilter": { "title": "Review score filter", "minimum": 0, "maximum": 5, "type": "integer", "description": "0 = all scores; 1–5 = only that star rating.", "default": 0 }, "reviewAfterDate": { "title": "Reviews after date", "type": "string", "description": "ISO date/time (e.g. 2026-01-01 or 2026-01-01T00:00:00Z). Skip older reviews when sorting NEWEST.", "default": "" }, "maxItems": { "title": "Max items", "minimum": 0, "type": "integer", "description": "Hard cap on dataset rows pushed this run (0 = unlimited).", "default": 0 }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 16, "type": "integer", "description": "Parallel HTTP workers for multi-app fetches.", "default": 4 }, "monitorStoreName": { "title": "Monitor KV store name", "type": "string", "description": "Named Apify Key-Value Store for monitor state. Use a distinct name per watchlist/schedule.", "default": "google-play-monitor-store" }, "monitorBaselineOnly": { "title": "Monitor baseline only", "type": "boolean", "description": "First/seed monitor run: save state without emitting deltas or charging.", "default": false }, "resetMonitorState": { "title": "Reset monitor state", "type": "boolean", "description": "Clear MONITOR_STATE in the named store before this run.", "default": false }, "monitorFetchReviews": { "title": "Monitor: fetch new reviews", "type": "boolean", "description": "In monitor mode, also pull newest reviews and emit only new ones.", "default": true }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Optional HTTPS endpoint (Slack/Discord Incoming Webhook or custom). Receives JSON POSTs on configured monitor events.", "default": "" }, "notifyOnNewVersion": { "title": "Notify on new version / update", "type": "boolean", "description": "Fire webhook when version or updated timestamp changes.", "default": true }, "notifyOnRatingDrop": { "title": "Notify on rating drop", "type": "boolean", "description": "Fire webhook when score drops by ratingDropThreshold or more.", "default": true }, "notifyOnPriceChange": { "title": "Notify on price change", "type": "boolean", "description": "Fire webhook when price or currency changes.", "default": true }, "notifyOnNegativeReviews": { "title": "Notify on negative reviews", "type": "boolean", "description": "Fire webhook for new reviews with score <= 2.", "default": true }, "notifyOnListingChange": { "title": "Notify on listing change", "type": "boolean", "description": "Fire webhook when title, short description (summary), or icon changes.", "default": true }, "ratingDropThreshold": { "title": "Rating drop threshold", "minimum": 0, "type": "number", "description": "Minimum score drop to emit rating_drop (e.g. 0.2).", "default": 0.2 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy recommended. When enabled without groups, the Actor defaults to RESIDENTIAL. On proxy 407/auth failures it falls back to direct egress.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }