{ "openapi": "3.0.1", "info": { "title": "Google Search Autocomplete Keyword Scraper", "description": null, "version": "0.0", "x-build-id": "01NnpdulHMiKM9Pvl" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/substantial_dizi~Google-Search-Autocomplete-Keyword-Scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-substantial_dizi-Google-Search-Autocomplete-Keyword-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/substantial_dizi~Google-Search-Autocomplete-Keyword-Scraper/runs": { "post": { "operationId": "runs-sync-substantial_dizi-Google-Search-Autocomplete-Keyword-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/substantial_dizi~Google-Search-Autocomplete-Keyword-Scraper/run-sync": { "post": { "operationId": "run-sync-substantial_dizi-Google-Search-Autocomplete-Keyword-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": "Keywords", "minItems": 1, "type": "array", "description": "List of keywords to get autocomplete suggestions for", "items": { "type": "string" } }, "language": { "title": "Language", "enum": [ "en", "zh-CN", "zh-TW", "ja", "ko", "es", "fr", "de" ], "type": "string", "description": "Google search interface language (e.g., en, zh-CN, ja, ko)", "default": "en" }, "region": { "title": "Region", "enum": [ "US", "CN", "GB", "JP", "KR", "DE", "FR", "ES" ], "type": "string", "description": "Target country/region code (e.g., US, CN, GB, JP)", "default": "US" }, "maxSuggestionsPerKeyword": { "title": "Max Suggestions Per Keyword", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of suggestions to return for each keyword", "default": 20 }, "usePrefix": { "title": "Enable Prefix Expansion", "type": "boolean", "description": "Add common prefixes (best, how to, top, etc.) to keywords", "default": false }, "useSuffix": { "title": "Enable Suffix Expansion", "type": "boolean", "description": "Add common suffixes (2025, tutorial, free, etc.) to keywords", "default": false }, "useAlphabetSuffix": { "title": "Enable Alphabet Suffix (a-z)", "type": "boolean", "description": "Add a-z letter suffixes to discover more long-tail keywords (e.g., 'seo a', 'seo b')", "default": false }, "useAlphabetPrefix": { "title": "Enable Alphabet Prefix (a-z)", "type": "boolean", "description": "Add a-z letter prefixes before keywords (e.g., 'a seo', 'b seo')", "default": false }, "useNumberSuffix": { "title": "Enable Number Suffix", "type": "boolean", "description": "Add number suffixes after keywords (e.g., 'seo 1', 'seo 2')", "default": false }, "useNumberPrefix": { "title": "Enable Number Prefix", "type": "boolean", "description": "Add number prefixes before keywords (e.g., '5 best seo', '10 top seo')", "default": false }, "useQuestionWords": { "title": "Enable Question Words", "type": "boolean", "description": "Add question words (how to, what is, etc.) based on language. Perfect for content creation and SEO.", "default": false }, "customPrefixes": { "title": "Custom Prefixes", "type": "array", "description": "Custom prefix list (leave empty to use defaults). Maximum 20 prefixes recommended.", "items": { "type": "string" } }, "customSuffixes": { "title": "Custom Suffixes", "type": "array", "description": "Custom suffix list (leave empty to use defaults). Maximum 20 suffixes recommended.", "items": { "type": "string" } }, "customQuestionWords": { "title": "Custom Question Words", "type": "array", "description": "Custom question words (leave empty to use language-specific defaults). Maximum 50 question words.", "items": { "type": "string" } }, "numberRange": { "title": "Number Range", "type": "object", "description": "Number range for number expansion (both prefix and suffix). Maximum range: 50 numbers." }, "alphabetPosition": { "title": "Alphabet Position", "enum": [ "prefix", "suffix" ], "type": "string", "description": "Where to place alphabet letters relative to keyword", "default": "suffix" }, "numberPosition": { "title": "Number Position", "enum": [ "prefix", "suffix" ], "type": "string", "description": "Where to place numbers relative to keyword", "default": "suffix" }, "questionWordPosition": { "title": "Question Word Position", "enum": [ "prefix", "suffix" ], "type": "string", "description": "Where to place question words relative to keyword", "default": "prefix" }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum number of concurrent requests", "default": 3 }, "requestDelayMs": { "title": "Request Delay (ms)", "minimum": 100, "maximum": 5000, "type": "integer", "description": "Delay between requests in milliseconds", "default": 500 }, "deduplicateResults": { "title": "Deduplicate Results", "type": "boolean", "description": "Remove duplicate suggestions from results", "default": true } } }, "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 } } } } } } } } } }