{ "openapi": "3.0.1", "info": { "title": "Google Autocomplete Scraper - Keyword Suggestions", "description": "Scrape Google autocomplete keyword suggestions from Google Search, YouTube and Google Shopping. Get long-tail keywords, questions and modifiers with Google's relevance score, position and suggestion type for every phrase, across any country and language.", "version": "0.1", "x-build-id": "RtrMnhpaaDaYz7zv1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cirkit~google-autocomplete-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cirkit-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/cirkit~google-autocomplete-scraper/runs": { "post": { "operationId": "runs-sync-cirkit-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/cirkit~google-autocomplete-scraper/run-sync": { "post": { "operationId": "run-sync-cirkit-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", "minItems": 1, "type": "array", "description": "Keywords to expand, one per line, for example \"running shoes\" or \"crm software\". Each keyword is expanded separately and its suggestions are deduped.", "items": { "type": "string" } }, "sources": { "title": "Autocomplete sources", "type": "array", "description": "Which autocomplete to read. Google Search is the classic search box, YouTube is the YouTube search box, and Google Shopping is the product search box. Each source is billed and deduped on its own.", "items": { "type": "string", "enum": [ "google", "youtube", "shopping" ], "enumTitles": [ "Google Search", "YouTube", "Google Shopping" ] }, "default": [ "google" ] }, "expandAlphabet": { "title": "Alphabet expansion (a to z, 0 to 9)", "type": "boolean", "description": "Also query the keyword followed by each letter and digit (\"running shoes a\", \"running shoes b\" and so on). Turns 15 suggestions into several hundred long-tail keywords.", "default": true }, "expandQuestions": { "title": "Question expansion", "type": "boolean", "description": "Also query question words in front of the keyword (how, what, why, when, where, who, which, can, is, are, does, will, should). Surfaces the questions people ask, for FAQ and content planning.", "default": false }, "expandModifiers": { "title": "Modifier expansion", "type": "boolean", "description": "Also query common modifiers: \"keyword for\", \"with\", \"without\", \"vs\", \"near\", \"to\", \"like\", \"and\", \"or\", plus \"best\", \"cheap\", \"free\" and \"top\" in front. Surfaces comparisons, use cases and buyer intent.", "default": false }, "depth": { "title": "Recursive depth", "minimum": 0, "maximum": 3, "type": "integer", "description": "Feed every new suggestion back into autocomplete this many times. 0 reads only the expansions above. 1 also expands each suggestion found, which multiplies results (and cost) roughly tenfold, so pair it with a per keyword cap.", "default": 0 }, "country": { "title": "Country", "type": "string", "description": "Two letter country code Google tailors suggestions to, for example us, gb, de, in or br.", "default": "us" }, "language": { "title": "Language", "type": "string", "description": "Two letter language code for the suggestions, for example en, de, es, fr or ja. Match it to the language of your keywords.", "default": "en" }, "maxSuggestionsPerKeyword": { "title": "Max suggestions per keyword", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Upper limit of unique suggestions for each keyword and source. Alphabet expansion alone yields about 300 to 450 per keyword.", "default": 500 }, "maxItems": { "title": "Max suggestions in total", "minimum": 0, "type": "integer", "description": "Hard cap on rows across every keyword and source, and therefore on what the run can cost. Leave empty for no cap." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy is used by default and works with the standard datacenter pool. You normally do not need to change this.", "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 } } } } } } } } } }