{ "openapi": "3.0.1", "info": { "title": "Google Autocomplete Scraper", "description": "Collect live Google Search Autocomplete suggestions for seed keywords with language, country, expansion and run summary details.", "version": "0.1", "x-build-id": "Uplv0RU7oGgdKv7Kd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cliqtomedia~google-autocomplete-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cliqtomedia-google-autocomplete-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/cliqtomedia~google-autocomplete-scraper/runs": { "post": { "operationId": "runs-sync-cliqtomedia-google-autocomplete-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/cliqtomedia~google-autocomplete-scraper/run-sync": { "post": { "operationId": "run-sync-cliqtomedia-google-autocomplete-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": [ "keywords" ], "properties": { "keywords": { "title": "Seed keywords", "minItems": 1, "maxItems": 100, "type": "array", "description": "One or more keywords. The Actor trims spaces and keeps Unicode text such as cafe accents or Japanese keywords.", "items": { "type": "string", "minLength": 1, "maxLength": 120 } }, "language": { "title": "Language", "minLength": 2, "maxLength": 12, "type": "string", "description": "Google hl parameter, such as en, fr or ja.", "default": "en" }, "country": { "title": "Country", "minLength": 2, "maxLength": 2, "type": "string", "description": "Google gl parameter, such as us, fr or jp. This is not a promise of exact IP location.", "default": "us" }, "client": { "title": "Google client", "enum": [ "chrome", "firefox" ], "type": "string", "description": "Chrome usually returns more metadata. Firefox is kept as a simple fallback shape.", "default": "chrome" }, "expansionModes": { "title": "Expansion modes", "uniqueItems": true, "type": "array", "description": "Exact uses each seed as-is. Alphabet, numbers and questions create extra visible Google requests.", "items": { "type": "string", "enum": [ "exact", "alphabet", "numbers", "questions" ] }, "default": [ "exact" ] }, "questionPrefixes": { "title": "Question prefixes", "minItems": 1, "maxItems": 20, "type": "array", "description": "Used only when questions expansion is enabled.", "items": { "type": "string", "minLength": 1, "maxLength": 40 }, "default": [ "how", "what", "where", "why", "when", "which" ] }, "maxGeneratedQueries": { "title": "Maximum Google requests", "minimum": 1, "maximum": 500, "type": "integer", "description": "Stops expansion before too many Google Autocomplete requests are planned.", "default": 50 }, "maxResults": { "title": "Maximum saved suggestions", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stops writing new chargeable suggestion rows at this limit.", "default": 500 }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 8, "type": "integer", "description": "Number of Google requests allowed at the same time.", "default": 4 }, "requestTimeoutMillis": { "title": "Request timeout", "minimum": 1000, "maximum": 30000, "type": "integer", "description": "Timeout for one Google request in milliseconds.", "default": 8000 }, "maxRetries": { "title": "Maximum retries", "minimum": 0, "maximum": 2, "type": "integer", "description": "Retries for transient network or server errors. Blocks and bad requests are not retried.", "default": 1 }, "maxResponseBytes": { "title": "Maximum response size", "minimum": 1024, "maximum": 262144, "type": "integer", "description": "Stops parsing if one Google response is larger than this byte limit.", "default": 65536 }, "maxRunTimeSeconds": { "title": "Maximum run time", "minimum": 5, "maximum": 300, "type": "integer", "description": "Stops starting new requests after this many seconds.", "default": 240 }, "includeRawMetadata": { "title": "Include Google metadata", "type": "boolean", "description": "Adds safe per-suggestion metadata returned by the selected Google client when available.", "default": true }, "maxChargeUsd": { "title": "Maximum estimated charge", "minimum": 0.00005, "maximum": 1.5, "type": "number", "description": "Optional safety stop based on the estimated per-suggestion charge before more rows are saved." } } }, "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 } } } } } } } } } }