{ "openapi": "3.0.1", "info": { "title": "Google Play Rankings Scraper", "description": "Extract explicitly ranked public Google Play apps and optionally enrich them with source-backed app details, install bands, update information, screenshots, and ratings.", "version": "1.0", "x-build-id": "LPzafIE9oeBHhBOsn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/googleapi~google-play-rankings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-googleapi-google-play-rankings-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/googleapi~google-play-rankings-scraper/runs": { "post": { "operationId": "runs-sync-googleapi-google-play-rankings-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/googleapi~google-play-rankings-scraper/run-sync": { "post": { "operationId": "run-sync-googleapi-google-play-rankings-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": { "category": { "title": "Category slug", "pattern": "^[A-Z0-9_]{2,80}$", "type": "string", "description": "Google Play category slug used when no custom URL or app ID is supplied, for example TRAVEL_AND_LOCAL.", "default": "TRAVEL_AND_LOCAL" }, "rankingType": { "title": "Ranking chart", "enum": [ "top_free" ], "type": "string", "description": "Read the displayed Top free ranks from the ordinarily rendered public category chart.", "default": "top_free" }, "startUrls": { "title": "Google Play category or app URLs", "maxItems": 20, "type": "array", "description": "Optional HTTPS play.google.com category or app details URLs. When supplied, these URLs replace the generated category URL.", "items": { "type": "object", "properties": { "url": { "title": "Public Google Play URL", "description": "A category URL or /store/apps/details URL with a package ID.", "type": "string" } }, "required": [ "url" ], "additionalProperties": false } }, "sourceUrls": { "title": "Source URL alias", "maxItems": 20, "type": "array", "description": "Compatibility alias for startUrls. Accepts HTTPS Google Play URL strings.", "items": { "type": "string" } }, "urls": { "title": "URL alias", "maxItems": 20, "type": "array", "description": "Compatibility alias for startUrls. Accepts HTTPS Google Play URL strings.", "items": { "type": "string" } }, "url": { "title": "Single URL alias", "type": "string", "description": "Compatibility alias for one category or app details URL." }, "appId": { "title": "App package ID", "pattern": "^[A-Za-z0-9_]+(?:[.-][A-Za-z0-9_]+)+$", "type": "string", "description": "Read one public app details page by its package ID, for example com.example.travel." }, "appIds": { "title": "App package IDs", "maxItems": 50, "type": "array", "description": "Read up to 50 public app details pages by package ID.", "items": { "type": "string", "pattern": "^[A-Za-z0-9_]+(?:[.-][A-Za-z0-9_]+)+$" } }, "maxApps": { "title": "Maximum ranked apps per category page", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum ranked app rows to consider from each category page.", "default": 20 }, "maxItems": { "title": "Maximum output records", "minimum": 1, "maximum": 500, "type": "integer", "description": "Global maximum across category URLs and app IDs.", "default": 20 }, "page": { "title": "Starting page", "minimum": 1, "maximum": 1, "type": "integer", "description": "Only the first rendered public ranking page is supported.", "default": 1 }, "maxPages": { "title": "Maximum pages per source", "minimum": 1, "maximum": 1, "type": "integer", "description": "One rendered public ranking page per source is supported.", "default": 1 }, "deduplicate": { "title": "Deduplicate apps", "type": "boolean", "description": "Deduplicate repeated package IDs across every supplied source.", "default": true }, "includeDetails": { "title": "Fetch app detail pages", "type": "boolean", "description": "Fetch public app pages for enrichment. Disabled by default to limit external requests.", "default": false }, "maxDetailItems": { "title": "Maximum detail pages", "minimum": 0, "maximum": 50, "type": "integer", "description": "Maximum ranked apps to enrich from public detail pages when includeDetails is enabled; 0 disables detail requests.", "default": 10 }, "locale": { "title": "Locale", "pattern": "^[a-z]{2}(?:[-_][A-Za-z]{2})?$", "type": "string", "description": "Language-country locale, such as en-US. Explicit locale values must agree with language and country inputs." }, "language": { "title": "Language", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "Two-letter Google Play language code." }, "country": { "title": "Country", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "Two-letter Google Play country code." }, "location": { "title": "Country alias", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "Compatibility alias for country." }, "requestTimeoutSecs": { "title": "Request timeout in seconds", "minimum": 5, "maximum": 120, "type": "integer", "description": "Maximum time for each public page request.", "default": 30 }, "requestDelayMs": { "title": "Delay between requests", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Wait this long between public page requests. Challenges and rate limits stop the run without retrying around them.", "default": 1000 }, "maxRequestRetries": { "title": "Retries for transient errors", "minimum": 0, "maximum": 2, "type": "integer", "description": "Bounded retries for network timeouts and server errors. HTTP 401, 403, 429, and verification pages are not retried.", "default": 1 }, "maxResponseBytes": { "title": "Maximum response size", "minimum": 100000, "maximum": 5000000, "type": "integer", "description": "Maximum bytes read from one page response.", "default": 2500000 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify Proxy configuration. The Actor does not solve CAPTCHAs or bypass Google Play access controls." } } }, "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 } } } } } } } } } }