{ "openapi": "3.0.1", "info": { "title": "Keyword Suggestions Scraper", "description": "Scrape keyword suggestions and autocomplete data from multiple search engines and e-commerce platforms including Google, Amazon, YouTube, Pinterest, and more. Perfect for SEO research and content optimization.", "version": "2.0", "x-build-id": "0bhU5SB7wUzsOESnJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/searchapi~keyword-suggestions-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-searchapi-keyword-suggestions-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/searchapi~keyword-suggestions-scraper/runs": { "post": { "operationId": "runs-sync-searchapi-keyword-suggestions-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/searchapi~keyword-suggestions-scraper/run-sync": { "post": { "operationId": "run-sync-searchapi-keyword-suggestions-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, "maxItems": 100, "uniqueItems": true, "type": "array", "description": "One to 100 keywords to enter into each selected public autocomplete surface.", "items": { "type": "string", "minLength": 1, "maxLength": 200 }, "default": [ "software" ] }, "platforms": { "title": "Platforms", "uniqueItems": true, "type": "array", "description": "Public autocomplete sources to query. Answers is retained for compatibility but its former suggestion surface is currently unavailable.", "items": { "type": "string", "enum": [ "google", "bing", "yahoo", "amazon", "etsy", "youtube", "pinterest", "wiki", "answers" ], "enumTitles": [ "Google", "Bing", "Yahoo", "Amazon", "Etsy", "YouTube", "Pinterest", "Wikipedia", "Answers" ] }, "default": [ "google", "bing", "yahoo", "amazon", "etsy", "youtube", "pinterest", "wiki", "answers" ] }, "language": { "title": "Language", "type": "string", "description": "Language code sent to sources that support locale selection.", "default": "en" }, "countryCode": { "title": "Country", "type": "string", "description": "Two-letter country code sent to sources that support market selection.", "default": "US" }, "maxItems": { "title": "Maximum suggestions per source", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum suggestions retained for every keyword/platform pair.", "default": 20 }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 9, "type": "integer", "description": "Maximum keyword/platform requests processed at once.", "default": 3 }, "maxRequestRetries": { "title": "Maximum request retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retries for temporary network, rate-limit, and server failures.", "default": 2 }, "requestTimeoutSecs": { "title": "Request timeout", "minimum": 5, "maximum": 120, "type": "integer", "description": "Timeout in seconds for each API or browser operation.", "default": 30 }, "useApifyProxy": { "title": "Use Apify Proxy", "type": "boolean", "description": "Route requests through an authorized Apify Proxy session.", "default": false }, "proxyGroups": { "title": "Apify Proxy groups", "type": "array", "description": "Optional Apify Proxy groups. Used only when Apify Proxy is enabled.", "items": { "type": "string" } }, "proxyCountryCode": { "title": "Proxy country", "type": "string", "description": "Optional two-letter Apify Proxy country code." }, "proxyUrls": { "title": "Custom proxy URLs", "type": "array", "description": "Authorized HTTP(S) proxy URLs. These take precedence over Apify Proxy.", "items": { "type": "string" } }, "debug": { "title": "Debug logging", "type": "boolean", "description": "Enable additional non-sensitive diagnostics.", "default": false } } }, "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 } } } } } } } } } }