{ "openapi": "3.0.1", "info": { "title": "Google Autocomplete Keyword Scraper", "description": "Scrape Google autocomplete suggestions for keyword research: alphabet, question and preposition expansions, any country and language. Pay per seed keyword.", "version": "0.1", "x-build-id": "4gVabrS0Nhp4egX2d" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/josh99smith~google-autocomplete-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-josh99smith-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/josh99smith~google-autocomplete-scraper/runs": { "post": { "operationId": "runs-sync-josh99smith-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/josh99smith~google-autocomplete-scraper/run-sync": { "post": { "operationId": "run-sync-josh99smith-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", "uniqueItems": true, "type": "array", "description": "One seed keyword per line (or a JSON array of strings). Google Autocomplete works best with partial phrases such as `best crm for` or `how to start a podcast`. Duplicates are removed automatically.", "items": { "type": "string" } }, "country": { "title": "Country", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "Two-letter country code (`gl` parameter) that controls which country's suggestions are returned, e.g. `us`, `gb`, `de`, `in`, `br`.", "default": "us" }, "language": { "title": "Language", "pattern": "^[A-Za-z]{2,3}(-[A-Za-z]{2,4})?$", "type": "string", "description": "Interface language code (`hl` parameter), e.g. `en`, `de`, `es`, `pt-BR`, `zh-CN`. Use the language your target audience searches in.", "default": "en" }, "expandAlphabet": { "title": "Expand with a-z", "type": "boolean", "description": "Also query ` a` to ` z` (26 extra requests per seed keyword). The most effective way to discover long-tail suggestions.", "default": false }, "expandQuestions": { "title": "Expand with question words", "type": "boolean", "description": "Also query `who `, `what `, `when`, `where`, `why`, `how`, `can`, `is`, `are`, `does`, `will` (11 extra requests per seed keyword). Great for mining question-style keywords.", "default": false }, "expandPrepositions": { "title": "Expand with prepositions", "type": "boolean", "description": "Also query ` for`, `with`, `without`, `near`, `to`, `vs`, `like`, `versus` (8 extra requests per seed keyword).", "default": false }, "expandNumbers": { "title": "Expand with numbers", "type": "boolean", "description": "Also query ` 0` to ` 9` (10 extra requests per seed keyword). Useful for years, versions and top-10 style queries.", "default": false }, "maxSuggestionsPerKeyword": { "title": "Max suggestions per keyword", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop collecting for a seed keyword once this many unique suggestions have been found. Remaining expansion and depth-2 requests for that keyword are skipped.", "default": 50 }, "depth": { "title": "Depth", "minimum": 1, "maximum": 2, "type": "integer", "description": "`1` queries only the seed keyword (plus enabled expansions). `2` additionally re-queries every suggestion found at depth 1 once, which multiplies the number of requests but uncovers many more long-tail phrases.", "default": 1 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many suggest requests to run in parallel for the current seed keyword. Keep it low (the default is 3) to avoid rate limiting; seed keywords are always processed one after another.", "default": 3 }, "maxRetries": { "title": "Retries per request", "minimum": 0, "maximum": 5, "type": "integer", "description": "How many times to retry a failed suggest request (with exponential back-off) before reporting it as failed.", "default": 2 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Route requests through Apify Proxy if Google starts rate-limiting the datacenter IP addresses used by the platform. Proxy usage is billed by Apify separately from this Actor's per-keyword price." } } }, "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 } } } } } } } } } }