{ "openapi": "3.0.1", "info": { "title": "Keyword Research Scraper — Google, YouTube, Amazon", "description": "Turn one seed into hundreds of real keywords from Google, YouTube, Amazon, Bing, eBay and DuckDuckGo autocomplete at once. Grouped into questions and comparisons, with a count of how many engines agreed - so you can see which phrases carry buying intent. No API key.", "version": "0.0", "x-build-id": "U2T299ByLm1YUeVmX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/eiv~keyword-research-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-eiv-keyword-research-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/eiv~keyword-research-scraper/runs": { "post": { "operationId": "runs-sync-eiv-keyword-research-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/eiv~keyword-research-scraper/run-sync": { "post": { "operationId": "run-sync-eiv-keyword-research-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": "Seed keywords", "type": "array", "description": "One per line. Short phrases, not URLs — \"protein powder\", \"crm software\", \"running shoes\". Each seed is expanded into hundreds of real queries.", "items": { "type": "string" } }, "sourceDatasetId": { "title": "Source dataset ID", "type": "string", "description": "Read seeds from an existing dataset instead of typing them — for example the keywords found by a previous run." }, "sourceDatasetField": { "title": "Source dataset field", "type": "string", "description": "Which field on the source dataset holds the seed.", "default": "keyword" }, "sources": { "title": "Sources", "type": "array", "description": "Leave empty for all six. Valid values: google, youtube, amazon, bing, ebay, duckduckgo. Google and Bing show what people search; YouTube shows what they want to watch; Amazon and eBay show what they are ready to buy.", "items": { "type": "string" } }, "country": { "title": "Country", "type": "string", "description": "ISO code such as US, GB, DE, JP. Autocomplete is personalised on the address the request comes from, so the Apify Proxy is pointed at this country automatically — otherwise a US search run from Europe returns European keywords.", "default": "US" }, "language": { "title": "Language", "type": "string", "description": "Two-letter code. Left empty it follows the country: DE gives German, JP Japanese, BR Portuguese." }, "includeQuestions": { "title": "Questions (how, what, why…)", "type": "boolean", "description": "Prefix the seed with question words. These are the keywords that map directly onto articles and videos people are already looking for.", "default": true }, "includeComparisons": { "title": "Comparisons (vs, or, alternative)", "type": "boolean", "description": "Surfaces the competitors and substitutes people weigh against your term.", "default": true }, "includePrepositions": { "title": "Prepositions (for, with, near, best…)", "type": "boolean", "description": "Opens up qualified long-tail intent.", "default": true }, "includeAlphabet": { "title": "Alphabet (a-z)", "type": "boolean", "description": "Appends each letter. The widest net: one seed's alphabet pass returned 258 distinct keywords where the bare seed returned ten.", "default": true }, "includeDigits": { "title": "Digits (0-9)", "type": "boolean", "description": "Appends each digit. Useful for model numbers, sizes and years; noise for most other seeds, so it is off by default.", "default": false }, "maxKeywordsPerSeed": { "title": "Max keywords per seed", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stops a broad seed from running away. Seeds that hit it are flagged truncated.", "default": 1000 }, "includeSeedSummary": { "title": "Include a summary per seed", "type": "boolean", "description": "Add one rollup record per seed: counts by question, comparison and preposition, cross-source agreement, buyer-intent totals and per-source coverage. Not billed as a keyword.", "default": true }, "maxConcurrency": { "title": "Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Lookups in flight at once. These endpoints exist to answer a search box on every keystroke, so they tolerate this comfortably.", "default": 6 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Per-lookup timeout. Responses are a few hundred bytes, so this rarely matters.", "default": 30 }, "maxRetries": { "title": "Retries per lookup", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retries for connection resets and 5xx responses.", "default": 2 }, "flattenOutput": { "title": "Flatten output for CSV", "type": "boolean", "description": "Emit flat dot-notation columns. Mainly affects the sources list and the per-source position map.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Strongly recommended. Autocomplete is personalised on the exit address, so without a proxy your keywords describe wherever the run happens to execute rather than the country you asked for. The country is set for you to match.", "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 } } }, "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 } } } } } } } } } }