{ "openapi": "3.0.1", "info": { "title": "Google Keyword Data Scraper (Bulk)", "description": "Collect public Google autocomplete and search-result keyword signals in bulk for SEO research.", "version": "1.0", "x-build-id": "bq5FdlmGRfPuTbIRn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/googleapi~google-keyword-data-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-googleapi-google-keyword-data-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/googleapi~google-keyword-data-scraper/runs": { "post": { "operationId": "runs-sync-googleapi-google-keyword-data-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/googleapi~google-keyword-data-scraper/run-sync": { "post": { "operationId": "run-sync-googleapi-google-keyword-data-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", "properties": { "keywords": { "title": "Keywords", "maxItems": 1000, "type": "array", "description": "Keywords to analyze, one per line or item.", "items": { "type": "string", "minLength": 1, "maxLength": 300 }, "default": [] }, "queries": { "title": "Queries (alias)", "maxItems": 1000, "type": "array", "description": "Compatibility alias for keyword phrases.", "items": { "type": "string", "minLength": 1, "maxLength": 300 } }, "query": { "title": "Query (alias)", "maxLength": 300, "type": "string", "description": "Compatibility alias for one keyword phrase." }, "searchQuery": { "title": "Search query (alias)", "maxLength": 300, "type": "string", "description": "Compatibility alias for one keyword phrase." }, "country": { "title": "Country code", "minLength": 2, "maxLength": 2, "type": "string", "description": "Two-letter Google country code used for localized suggestions and results.", "default": "US" }, "language": { "title": "Language code", "minLength": 2, "maxLength": 20, "type": "string", "description": "Google language code, for example en or de.", "default": "en" }, "maxKeywords": { "title": "Maximum keywords", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of unique keyword phrases accepted from the supplied aliases before the output-record limit is applied.", "default": 1000 }, "includeSuggestions": { "title": "Include autocomplete suggestions", "type": "boolean", "description": "Keep public Google autocomplete suggestions.", "default": true }, "includeSearchSignals": { "title": "Include SERP signals", "type": "boolean", "description": "Keep visible Google Search result cards, related questions/searches, refinements, local/news/video modules, and public feature flags.", "default": true }, "requestDelayMs": { "title": "Delay between keywords (ms)", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Delay between sequential keyword requests.", "default": 200 }, "timeoutMs": { "title": "Request timeout (ms)", "minimum": 5000, "maximum": 120000, "type": "integer", "description": "Bounded timeout for each public endpoint request.", "default": 30000 }, "requestTimeoutSecs": { "title": "Request timeout (seconds, alias)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Compatibility alias for timeoutMs." }, "timeoutSecs": { "title": "Timeout (seconds, legacy alias)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Legacy alias for requestTimeoutSecs." }, "maxRetries": { "title": "Maximum retries", "minimum": 0, "maximum": 3, "type": "integer", "description": "Finite retries for ordinary network failures.", "default": 2 }, "maxResponseBytes": { "title": "Maximum response bytes", "minimum": 100000, "maximum": 10000000, "type": "integer", "description": "Bound the amount of public JSON/HTML retained per response.", "default": 4000000 }, "userAgent": { "title": "User agent", "maxLength": 300, "type": "string", "description": "Optional ordinary HTTP user-agent string; it is not used for evasion. Browser rendering always keeps Chrome's native user agent." }, "acceptLanguage": { "title": "Accept-Language", "maxLength": 120, "type": "string", "description": "Optional language preference for public requests.", "default": "en-US,en;q=0.8" }, "renderJavaScript": { "title": "Render JavaScript fallback", "type": "boolean", "description": "Use a standard Playwright browser when direct public HTML is a consent, JavaScript, or access-boundary shell; no stealth or CAPTCHA handling.", "default": true }, "browserWaitMs": { "title": "Browser wait (ms)", "minimum": 500, "maximum": 10000, "type": "integer", "description": "Bounded post-navigation wait for rendered public content.", "default": 2500 }, "browserScrolls": { "title": "Browser scrolls", "minimum": 0, "maximum": 3, "type": "integer", "description": "Bounded ordinary page scrolls used to reveal public SERP feature signals.", "default": 1 }, "searchProxyConfiguration": { "title": "Optional Search-only proxy", "type": "object", "description": "Default off: Search shares the main proxy. Explicitly enable this separate route for Search only; GOOGLE_SERP uses the documented HTTP-only, no-session protocol. Autocomplete stays on the main route. No automatic route switching or direct fallback.", "default": { "useApifyProxy": false } }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Applies to autocomplete HTTP, Search HTTP and standard browser navigation. Uses only account-enabled proxy groups or custom URLs. Residential routing requires account access. No silent direct fallback; omit or explicitly disable for direct access. Credentials are not logged." }, "page": { "title": "Page", "minimum": 1, "maximum": 100, "type": "integer", "description": "One-based first Google Search results page inspected for each keyword.", "default": 1 }, "maxItems": { "title": "Maximum items", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of keyword-analysis records to emit; each record contains bounded public suggestions and SERP result arrays.", "default": 25 }, "maxPages": { "title": "Maximum pages", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum number of sequential Google Search pages to inspect per keyword. Page offsets advance by 10 results and remain bounded.", "default": 1 } } }, "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 } } } } } } } } } }