{ "openapi": "3.0.1", "info": { "title": "Google Autocomplete Scraper", "description": "Collect Google autocomplete keyword suggestions by seed query, language, and country.", "version": "0.1", "x-build-id": "tS9WFal2WTCRRBBVV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fetch_cat~google-autocomplete-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fetch_cat-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/fetch_cat~google-autocomplete-scraper/runs": { "post": { "operationId": "runs-sync-fetch_cat-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/fetch_cat~google-autocomplete-scraper/run-sync": { "post": { "operationId": "run-sync-fetch_cat-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": [ "queries" ], "properties": { "queries": { "title": "Seed keywords", "minItems": 1, "maxItems": 1000, "type": "array", "description": "Enter seed words or phrases, up to 1,000 unique seeds. Blank entries are ignored; surrounding spaces and repeated seeds (ignoring capitalization) are removed. At least one non-empty seed is required.", "items": { "type": "string" } }, "language": { "title": "Language (hl)", "type": "string", "description": "Two-letter Google language code, for example en, es, de, fr, it, pt, or ja.", "default": "en" }, "country": { "title": "Country (gl)", "type": "string", "description": "Two-letter Google country code used to localize suggestions, for example us, gb, de, fr, br, or au.", "default": "us" }, "maxSuggestionsPerQuery": { "title": "Maximum suggestions per keyword", "minimum": 1, "maximum": 20, "type": "integer", "description": "Save at most this many suggestions per seed, in Google's returned order. Range 1–20; default 10. Google may return fewer or none. This does not request search-volume estimates or extra keyword expansion.", "default": 10 }, "client": { "title": "Autocomplete client", "enum": [ "firefox", "chrome", "toolbar" ], "type": "string", "description": "Google autocomplete response format. Firefox is compact JSON and recommended.", "default": "firefox" }, "requestDelayMs": { "title": "Delay between keyword requests (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Polite pause between seed keyword requests. Increase for very large batches.", "default": 250 }, "maxRetries": { "title": "Retries per keyword", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retry temporary rate-limit or server errors before skipping a keyword.", "default": 2 }, "useProxy": { "title": "Use Apify Proxy", "type": "boolean", "description": "Off by default: requests go directly to Google. Enable to use Apify Proxy for every seed request, with any groups specified below. Proxy use may incur charges according to your Apify account. There is no automatic switch to a proxy after a direct request fails, and this field does not configure customer-supplied proxy URLs.", "default": false }, "proxyGroups": { "title": "Proxy groups", "type": "array", "description": "Used only when Use Apify Proxy is enabled. Leave empty for your account's default Apify Proxy pool, or enter groups your account can access. Groups do not enable proxy routing on their own. No specific group is required; access and charges depend on your account.", "default": [], "items": { "type": "string" } } } }, "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 } } } } } } } } } }