{ "openapi": "3.0.1", "info": { "title": "Google Autocomplete Scraper", "description": "Scrapes Google Autocomplete suggestions for any seed query. Extracts the full set of autocomplete fields: suggestion text + HTML, vertical (web/people/products/news/...), highlighted flag, completion, replacement, locale, client, and more.", "version": "3.0", "x-build-id": "TkjCUnfMezjVwcqjS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/searchapi~google-autocomplete-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-searchapi-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/searchapi~google-autocomplete-scraper/runs": { "post": { "operationId": "runs-sync-searchapi-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/searchapi~google-autocomplete-scraper/run-sync": { "post": { "operationId": "run-sync-searchapi-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", "properties": { "query": { "title": "Query", "type": "string", "description": "A single seed phrase. Leave empty when using Queries." }, "queries": { "title": "Queries", "minItems": 1, "maxItems": 100, "type": "array", "description": "Multiple seed phrases processed with fair interleaving.", "items": { "type": "string", "minLength": 1 } }, "mode": { "title": "Expansion mode", "enum": [ "exact", "all", "questions", "prepositions", "comparisons", "alphabet" ], "type": "string", "description": "Exact queries only, or expand using question, preposition, comparison, alphabet, or every pattern.", "default": "exact" }, "maxItems": { "title": "Maximum total records", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Global dataset limit across every query.", "default": 50 }, "maxItemsPerQuery": { "title": "Maximum per query", "minimum": 1, "maximum": 500, "type": "integer", "description": "Fair per-seed cap before the global limit is applied.", "default": 50 }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 25, "type": "integer", "description": "Concurrent structured autocomplete requests.", "default": 10 }, "language": { "title": "Language", "pattern": "^[a-zA-Z]{2,3}(?:-[A-Z]{2})?$", "type": "string", "description": "Google hl language code.", "default": "en" }, "country": { "title": "Country", "pattern": "^(?:[A-Za-z]{2}|ALL)$", "type": "string", "description": "Google gl country code, or ALL to omit localization.", "default": "US" }, "minLength": { "title": "Minimum suggestion length", "minimum": 1, "maximum": 200, "type": "integer", "description": "Drop suggestions shorter than this many characters." }, "maxLength": { "title": "Maximum suggestion length", "minimum": 1, "maximum": 500, "type": "integer", "description": "Drop suggestions longer than this many characters." }, "containsKeyword": { "title": "Substring filter", "type": "string", "description": "Keep suggestions containing this text. Prefix with ! to exclude matching suggestions." }, "outputFormat": { "title": "Output format", "enum": [ "flat", "tree" ], "type": "string", "description": "Return one record per suggestion or one nested group per seed.", "default": "flat" }, "maxRequestRetries": { "title": "Request retries", "minimum": 0, "maximum": 3, "type": "integer", "description": "Retries only temporary network, rate-limit, and server failures.", "default": 1 }, "requestTimeoutSecs": { "title": "Request timeout", "minimum": 5, "maximum": 120, "type": "integer", "description": "Structured request timeout in seconds.", "default": 30 }, "navigationTimeoutSecs": { "title": "Browser navigation timeout", "minimum": 15, "maximum": 120, "type": "integer", "description": "Maximum seconds for browser fallback navigation.", "default": 45 }, "requestHandlerTimeoutSecs": { "title": "Browser handler timeout", "minimum": 30, "maximum": 180, "type": "integer", "description": "Maximum seconds for one browser fallback query.", "default": 90 }, "useBrowserFallback": { "title": "Use browser fallback", "type": "boolean", "description": "If every structured request fails, enter the seed in Google's homepage and read its autocomplete listbox.", "default": true }, "proxyConfiguration": { "title": "Browser fallback proxy", "type": "object", "description": "Optional Residential or custom proxy for browser fallback. GOOGLE_SERP is HTTP-only and is not compatible with a Playwright autocomplete session.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }