{ "openapi": "3.0.1", "info": { "title": "Google Autocomplete Scraper", "description": "Collect Google Autocomplete suggestions for seed keywords and return each suggestion with its query, position, relevance, type, country and language. Choose alphabet or question-word expansion to query related phrases, or use no expansion for suggestions on the seed alone.", "version": "0.1", "x-build-id": "5bUCfGBAx7LnDRPW7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axiomworks~google-autocomplete-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axiomworks-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/axiomworks~google-autocomplete-scraper/runs": { "post": { "operationId": "runs-sync-axiomworks-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/axiomworks~google-autocomplete-scraper/run-sync": { "post": { "operationId": "run-sync-axiomworks-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", "type": "array", "description": "Seed keywords to get Google Autocomplete suggestions for, one per line, e.g. 'coffee' or 'running shoes'. Any language or script works. Each seed returns up to 15 suggestions per request (more with expansion). Blank lines and repeated seeds are ignored. A keyword Google has no suggestions for returns 0 rows and a log warning, not an error.", "items": { "type": "string" } }, "country": { "title": "Country", "type": "string", "description": "Two-letter country code sent to Google as gl, e.g. 'us', 'gb', 'de', 'jp'. Default 'us'. Use together with language to get suggestions as an anonymous user in that market sees them.", "default": "us" }, "language": { "title": "Language", "type": "string", "description": "Language code sent to Google as hl, e.g. 'en', 'de', 'ja', 'pt-br'. Default 'en'. Pick the language your seeds are written in.", "default": "en" }, "expansion": { "title": "Keyword expansion", "enum": [ "none", "alphabet", "questions", "both", "digits", "prepositions", "all" ], "type": "string", "description": "Extra queries per seed. 'none' (default): seed only. 'alphabet': + '{seed} a..z'. 'questions': + 'who/what/how/can/is... {seed}' (12 words). 'digits': + '{seed} 0..9'. 'prepositions': + '{seed} for/with/near/vs...' (12). 'both': alphabet + questions. 'all': everything. Seed is always queried first; each row's expansion field names the letter or word used.", "default": "none" }, "dedupe": { "title": "Remove duplicate suggestions", "type": "boolean", "description": "If true, output each suggestion text only once per seed (first occurrence wins), even when several expansion queries return it. Default false keeps every row, because the position under each query matters for SEO.", "default": false }, "extraMarkets": { "title": "Extra markets", "type": "array", "description": "Optional additional markets to query every seed in, each as 'country:language', e.g. 'de:de', 'br:pt-br'. Empty (default) uses only country and language. Each market multiplies requests; rows carry their country and language, and all markets share the maxItems budget.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Maximum results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of suggestion rows to return across all seeds and expansions together, 1-10000, default 100. Seeds are processed in order, so a small limit may be used up by the first seed. The run stops as soon as this many rows are saved, and you are charged only for rows returned.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy used when Google rate-limits or blocks requests, default Apify Proxy (datacenter). Requests go direct first; after a 429/403 the run switches to this proxy and retries on fresh IPs. Pick a proxy country matching 'country' for the most local results.", "default": { "useApifyProxy": 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 }, "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 } } } } } } } } } }