{ "openapi": "3.0.1", "info": { "title": "Google Play Top Charts Scraper", "description": "Collect visible public Google Play top-chart rankings by category, ranking type, and locale.", "version": "2.0", "x-build-id": "uzu8zxuCp58W6FJcY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/googleapi~google-play-top-charts-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-googleapi-google-play-top-charts-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-top-charts-scraper/runs": { "post": { "operationId": "runs-sync-googleapi-google-play-top-charts-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-top-charts-scraper/run-sync": { "post": { "operationId": "run-sync-googleapi-google-play-top-charts-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", "pattern": "^[A-Z0-9_]{2,80}$", "type": "string", "description": "Google Play category slug such as TRAVEL_AND_LOCAL.", "default": "TRAVEL_AND_LOCAL" }, "rankingType": { "title": "Ranking type", "enum": [ "top_free", "top_paid", "top_grossing" ], "type": "string", "description": "Ranking label attached to observations from the selected public listing.", "default": "top_free" }, "startUrls": { "title": "Start URLs", "maxItems": 50, "type": "array", "description": "Public Google Play category, search, or app pages.", "items": { "type": "object", "properties": { "url": { "title": "Public URL", "description": "HTTPS play.google.com/store URL.", "type": "string" } }, "required": [ "url" ], "additionalProperties": false } }, "sourceUrls": { "title": "Source URL aliases", "maxItems": 50, "type": "array", "description": "Compatibility alias for public source URLs.", "items": { "type": "string" } }, "urls": { "title": "URL aliases", "maxItems": 50, "type": "array", "description": "Compatibility alias for public source URLs.", "items": { "type": "string" } }, "url": { "title": "Single URL alias", "type": "string", "description": "Compatibility alias for one public source URL." }, "appId": { "title": "App ID", "pattern": "^[A-Za-z0-9_]+(?:[.-][A-Za-z0-9_]+)+$", "type": "string", "description": "Optional Google Play package ID to observe through its public detail page." }, "appIds": { "title": "App IDs", "maxItems": 50, "type": "array", "description": "Optional package IDs converted to public detail URLs.", "items": { "type": "string" } }, "searchTerm": { "title": "Search term", "maxLength": 200, "type": "string", "description": "Optional term converted to a public Google Play app search URL." }, "searchTerms": { "title": "Search terms", "maxItems": 20, "type": "array", "description": "Optional terms converted to public Google Play app search URLs.", "items": { "type": "string", "maxLength": 200 } }, "maxApps": { "title": "Maximum ranked apps", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum chart rows to keep after the selected chart page offset.", "default": 50 }, "maxPages": { "title": "Maximum source pages", "minimum": 1, "maximum": 5, "type": "integer", "description": "Maximum public source pages processed in this run.", "default": 1 }, "maxItems": { "title": "Maximum output records", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum normalized records written to the dataset.", "default": 50 }, "maxResults": { "title": "Maximum output alias", "minimum": 1, "maximum": 500, "type": "integer", "description": "Compatibility alias for maxItems." }, "locale": { "title": "Locale", "pattern": "^[a-z]{2}(?:[-_][A-Z]{2})?$", "type": "string", "description": "Language-country locale such as en-US.", "default": "en-US" }, "language": { "title": "Language", "pattern": "^[a-z]{2}$", "type": "string", "description": "Two-letter Google Play language code.", "default": "en" }, "country": { "title": "Country", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "Two-letter Google Play country code.", "default": "US" }, "location": { "title": "Country alias", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "Compatibility alias for country." }, "includeAppDetails": { "title": "Enrich with app details", "type": "boolean", "description": "Fetch public detail pages for top-ranked apps to add descriptions, ratings, safety, release, and developer fields. Disabled by default.", "default": false }, "maxAppDetails": { "title": "Maximum app detail pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum ranked app detail pages to fetch when enrichment is enabled.", "default": 10 }, "deduplicate": { "title": "Deduplicate apps", "type": "boolean", "description": "Keep only the first observed row for each app ID.", "default": true }, "requestTimeoutSecs": { "title": "Request timeout", "minimum": 5, "maximum": 120, "type": "integer", "description": "Maximum seconds per public request.", "default": 30 }, "requestTimeoutMs": { "title": "Timeout alias", "minimum": 5000, "maximum": 120000, "type": "integer", "description": "Compatibility timeout in milliseconds." }, "timeoutSecs": { "title": "Timeout alias", "minimum": 5, "maximum": 120, "type": "integer", "description": "Compatibility alias for requestTimeoutSecs." }, "maxRequestRetries": { "title": "Request retries", "minimum": 0, "maximum": 3, "type": "integer", "description": "Finite retries for transient public request failures.", "default": 1 }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 5, "type": "integer", "description": "Maximum number of public source pages processed concurrently.", "default": 1 }, "requestDelayMs": { "title": "Request delay", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Delay before later source requests.", "default": 0 }, "maxResponseBytes": { "title": "Maximum response bytes", "minimum": 100000, "maximum": 5000000, "type": "integer", "description": "Bound each public HTTP response and rendered browser page.", "default": 5000000 }, "userAgent": { "title": "User agent", "maxLength": 300, "type": "string", "description": "Optional ordinary browser user agent." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify Proxy configuration for permitted public requests." }, "page": { "title": "Ranked chart page", "minimum": 1, "maximum": 5, "type": "integer", "description": "One-based ten-rank window within the selected Google Play chart. Page 1 starts at rank 1.", "default": 1 } } }, "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 } } } } } } } } } }