{ "openapi": "3.0.1", "info": { "title": "✨ Keyword Research Pro - Bulk Volume & CPC | Launch 80% Off", "description": "Check Google search volume, CPC, competition, and keyword ideas for up to 10,000 keywords per run. Filters, competitor domains, and white-label reports. $0.50 per 1,000 at launch. 230+ countries. Official search data. No scraping. No broken runs.", "version": "1.0", "x-build-id": "1x4Cr7aibO7L1q9I1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/winningsolutions~keyword-research-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-winningsolutions-keyword-research-pro", "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/winningsolutions~keyword-research-pro/runs": { "post": { "operationId": "runs-sync-winningsolutions-keyword-research-pro", "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/winningsolutions~keyword-research-pro/run-sync": { "post": { "operationId": "run-sync-winningsolutions-keyword-research-pro", "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": { "mode": { "title": "Research mode", "enum": [ "suggestions", "ideas", "related", "overview", "competitor" ], "type": "string", "description": "Selects the discovery method and which seed field is required (keywords vs. domain).\n\nExample: Ideas: broad topic expansion from seed keywords", "default": "ideas" }, "seedKeywords": { "title": "Seed keywords", "type": "string", "description": "Starting keywords for Suggestions, Ideas, Related, and Overview. Enter one keyword per line (up to 1,000). Required for all modes except Competitor.\n\nExample: seo tools" }, "seedDomain": { "title": "Competitor domain", "type": "string", "description": "Domain whose organic rankings to analyze in Competitor mode. Required for Competitor; ignored otherwise. Use the bare hostname. Do not add https:// or www.\n\nExample: ahrefs.com" }, "location": { "title": "Location", "type": "string", "description": "Country or region used for search volume and competition data. Prefer the common English country name.\n\nExample: Germany", "default": "Germany" }, "language": { "title": "Language code", "type": "string", "description": "Two-letter ISO language code for the keyword language you want to research.\n\nExample: de", "default": "de" }, "limit": { "title": "Result limit", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of keywords returned for the whole run (1-10,000). Above 5,000, base keyword-result charges alone exceed about $2.52 at launch rates before enrichments.\n\nExample: 100", "default": 100 }, "maxTotalChargeUsd": { "title": "Maximum total charge (USD)", "minimum": 0.05, "type": "number", "description": "Stops the run once this amount has been charged. Already written dataset rows are kept.\n\nExample: 25", "default": 25 }, "limitPerSeed": { "title": "Limit per seed keyword", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Optional cap on how many expanded keywords each seed may contribute (Suggestions, Ideas, Related only). Ignored in Overview and Competitor. Leave empty to use only the global Result limit.\n\nExample: 50 (with 2 seeds and Result limit 100, each seed adds at most 50 keywords)" }, "minVolume": { "title": "Minimum search volume", "minimum": 0, "type": "integer", "description": "Drop keywords whose monthly search volume is below this value.\n\nExample: 100" }, "maxVolume": { "title": "Maximum search volume", "minimum": 0, "type": "integer", "description": "Drop keywords whose monthly search volume is above this value. Use this to skip ultra-competitive head terms.\n\nExample: 10000" }, "maxDifficulty": { "title": "Maximum keyword difficulty", "minimum": 0, "maximum": 100, "type": "integer", "description": "Drop keywords harder than this score (0 = easiest, 100 = hardest).\n\nExample: 40" }, "intentFilter": { "title": "Search intent", "enum": [ "informational", "commercial", "transactional", "navigational" ], "type": "string", "description": "Keep only keywords whose primary search intent matches this value.\n\nExample: Commercial" }, "includeWords": { "title": "Must include words", "type": "array", "description": "Keep only keywords that contain every listed word (case-insensitive).\n\nExample: free", "items": { "type": "string" } }, "excludeWords": { "title": "Exclude words", "type": "array", "description": "Drop keywords that contain any of these words (case-insensitive).\n\nExample: jobs", "items": { "type": "string" } }, "questionsOnly": { "title": "Questions only", "type": "boolean", "description": "Keep only question-style keywords that start with words like who, what, how, why, when, or where.\n\nExample: true → keeps \"how to do keyword research\", drops \"keyword research tools\"", "default": false }, "exactMatch": { "title": "Exact phrase match", "type": "boolean", "description": "Suggestions/Related only: returned keywords must contain the exact seed phrase as written.\n\nExample: seed \"seo tools\" → keeps \"best seo tools 2026\", drops \"seo software\"", "default": false }, "ignoreSynonyms": { "title": "Ignore synonym variants", "type": "boolean", "description": "Return core keywords only and skip highly similar synonym variants that add little new coverage.\n\nExample: true → keeps \"keyword research\", drops near-duplicates like \"keyword researches\"", "default": false }, "includeSeedKeyword": { "title": "Include seed keyword metrics", "type": "boolean", "description": "Also return metrics for the seed keyword itself alongside the expanded results (Suggestions, Ideas, Related).\n\nExample: true with seed \"seo tools\" → output includes a row for \"seo tools\" plus expansions", "default": false }, "includeSerpInfo": { "title": "Include SERP features (Labs)", "type": "boolean", "description": "Add SERP feature types (AI Overview, featured snippet, People Also Ask, and more) and result counts from the Labs discovery response. No extra enrichment call.\n\nExample: true → fields like serp_item_types and has_ai_overview appear on each row", "default": false }, "includeClickstreamData": { "title": "Include clickstream data", "type": "boolean", "description": "Add demographics plus clickstream- and Bing-normalized volumes. Extra charge per keyword with data.\n\nExample: true → fields like gender_distribution and clickstream_search_volume appear on each row", "default": false }, "includeSerpOverview": { "title": "Include SERP overview", "type": "boolean", "description": "Enrich each keyword with its top organic SERP competitors (extra charge).\n\nExample: true → serp_competitors lists domains ranking for that keyword", "default": false }, "includeAiSearchVolume": { "title": "Include AI search volume", "type": "boolean", "description": "Enrich each keyword with AI/LLM search volume and AI trend data (extra charge).\n\nExample: true → ai_search_volume and ai_share appear on each row", "default": false }, "includeTrends": { "title": "Include historical trends", "type": "boolean", "description": "Add extended monthly search-volume history for seasonality analysis (extra charge per keyword with trend data).\n\nExample: true → monthly_searches includes a longer month-by-month series", "default": false }, "htmlReport": { "title": "Generate HTML report", "type": "boolean", "description": "Write a white-label HTML (+ CSV) report to the run key-value store ($0.05 once when generated). Also auto-enabled when you set a custom report title or logo. Table includes at most the first 500 keywords.\n\nExample: true → download HTML_REPORT from the run's key-value store", "default": false }, "pdfReport": { "title": "Generate PDF report", "type": "boolean", "description": "Write a white-label PDF report using the same title, logo, subline, and domain options ($0.05 once when generated). Includes at most the first 500 keywords. Independent of the HTML toggle.\n\nExample: true → download PDF_REPORT from the run's key-value store", "default": false }, "reportTitle": { "title": "Report title", "type": "string", "description": "Headline shown at the top of HTML and PDF reports. Setting a non-default title auto-enables HTML report generation.\n\nExample: Acme SEO Q3 Keyword Map", "default": "Keyword Research Report" }, "reportLogoUrl": { "title": "Report logo URL", "type": "string", "description": "Public image URL for the report header logo. Setting a logo auto-enables HTML report generation.\n\nExample: https://cdn.example.com/brand/logo.png" }, "reportShowSubline": { "title": "Show report subline", "type": "boolean", "description": "Show the meta line under the title with keyword count, location, language, and mode.\n\nExample: true → \"288 keywords | Germany | de | mode: ideas\"", "default": true }, "reportShowDomain": { "title": "Show report domain line", "type": "boolean", "description": "Show a \"for domain: ...\" line under the title. Set the domain name in the field below.\n\nExample: true → \"for domain: acme.com\"", "default": true }, "reportDomain": { "title": "Report domain name", "type": "string", "description": "Domain label shown as \"for domain: ...\" on reports. Falls back to the competitor seed domain when empty.\n\nExample: acme.com" }, "disableMetrics": { "title": "Disable metrics fields", "type": "boolean", "description": "Omit volume, CPC, competition, and difficulty columns from the dataset output.\n\nExample: true → search_volume, cpc, and keyword_difficulty are left out", "default": false }, "disableIntent": { "title": "Disable intent fields", "type": "boolean", "description": "Omit search intent and intent-probability columns from the dataset output.\n\nExample: true → search_intent and search_intent_probabilities are left out", "default": false }, "disableBacklinkGap": { "title": "Disable backlink gap fields", "type": "boolean", "description": "Omit average backlinks, referring domains, and backlink-gap columns from the dataset output.\n\nExample: true → avg_backlinks and backlink_gap are left out", "default": false }, "disableAiVolume": { "title": "Disable AI volume fields", "type": "boolean", "description": "Omit AI search volume and AI trend columns from the dataset output (even if the enrichment ran).\n\nExample: true → ai_search_volume and ai_share are left out", "default": false }, "disableSerpOverview": { "title": "Disable SERP overview fields", "type": "boolean", "description": "Omit SERP competitor columns from the dataset output (even if the enrichment ran).\n\nExample: true → serp_competitors is left out", "default": false }, "minWords": { "title": "Minimum word count", "minimum": 1, "maximum": 32, "type": "integer", "description": "Keep only keywords with at least this many words. Use this as a longtail filter.\n\nExample: 3 → keeps \"best seo tools\", drops \"seo\"" }, "maxWords": { "title": "Maximum word count", "minimum": 1, "maximum": 32, "type": "integer", "description": "Keep only keywords with at most this many words.\n\nExample: 4 → keeps \"best seo tools\", drops \"best free seo tools online\"" }, "disableSerpInfo": { "title": "Disable SERP feature fields", "type": "boolean", "description": "Omit Labs SERP-feature columns from the dataset output.\n\nExample: true → serp_item_types, se_results_count, and has_ai_overview are left out", "default": false }, "disableClickstream": { "title": "Disable clickstream fields", "type": "boolean", "description": "Omit demographics and clickstream/Bing-normalized volume columns from the dataset output.\n\nExample: true → gender_distribution and clickstream_search_volume are left out", "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 } } } } } } } } } }