{
  "openapi": "3.0.1",
  "info": {
    "title": "Keyword Research Tool - Google, YouTube, TikTok & Amazon",
    "description": "Keyword research from real autocomplete: one seed becomes hundreds of long-tail keywords and questions across Google, YouTube, TikTok, Bing, Amazon, Walmart, eBay, DuckDuckGo, Yandex, Naver & Wikipedia, each with search intent, rank and cross-platform demand. Monitor mode returns only new keywords.",
    "version": "1.0",
    "x-build-id": "dF6tbId7H85SfBtAv"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapesage~keyword-research-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapesage-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/scrapesage~keyword-research-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapesage-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/scrapesage~keyword-research-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapesage-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 or more seed keywords or phrases to research. Each seed is expanded into hundreds of real autocomplete suggestions across every selected platform. Example: `coffee maker`, `crm software`, `running shoes`.",
            "items": {
              "type": "string"
            }
          },
          "platforms": {
            "title": "Platforms / search engines",
            "type": "array",
            "description": "Which autocomplete sources to query. Each platform reflects what real users type there: Google/Bing/DuckDuckGo/Yandex/Naver = web SEO, YouTube/TikTok = video and social SEO, Amazon/Walmart/eBay = e-commerce & product research, Wikipedia = entities/topics, Google Images/News/Shopping = vertical intent. Add several to see cross-platform demand for the same keyword. Amazon and eBay are read in the store of the chosen country, Walmart in its US store and Naver for Korea; when the country has no market on one of them, that platform is skipped and the run's status message says so.",
            "items": {
              "type": "string",
              "enum": [
                "google",
                "youtube",
                "bing",
                "amazon",
                "ebay",
                "duckduckgo",
                "wikipedia",
                "google_images",
                "google_news",
                "google_shopping",
                "tiktok",
                "walmart",
                "yandex",
                "naver"
              ],
              "enumTitles": [
                "Google (web search)",
                "YouTube",
                "Bing",
                "Amazon",
                "eBay",
                "DuckDuckGo",
                "Wikipedia",
                "Google Images",
                "Google News",
                "Google Shopping",
                "TikTok",
                "Walmart (US)",
                "Yandex",
                "Naver (Korea)"
              ]
            },
            "default": [
              "google"
            ]
          },
          "expansions": {
            "title": "Keyword expansion strategies",
            "type": "array",
            "description": "How aggressively to multiply each seed before querying. `alphabet` appends a–z, `numbers` appends 0–9, `questions` prepends who/what/why/how…, `prepositions` appends for/with/near…, `comparisons` appends vs/alternative…, `commercial` adds best/buy/price/review… Leave empty to only query the bare seed. More strategies = more long-tail keywords (and more autocomplete requests).",
            "items": {
              "type": "string",
              "enum": [
                "alphabet",
                "numbers",
                "questions",
                "prepositions",
                "comparisons",
                "commercial"
              ],
              "enumTitles": [
                "Alphabet (a–z)",
                "Numbers (0–9)",
                "Questions (how/what/why…)",
                "Prepositions (for/with/near…)",
                "Comparisons (vs/alternative…)",
                "Commercial (best/buy/price…)"
              ]
            },
            "default": [
              "alphabet",
              "questions",
              "prepositions"
            ]
          },
          "country": {
            "title": "Country",
            "type": "string",
            "description": "Country that localises the suggestions: a two-letter code in any case (`US`, `GB`, `UK`, `CA`, `AU`, `DE`, `FR`, `IN`) or a country name (`Germany`, `United Kingdom`). Controls Google and YouTube `gl`, the Amazon and eBay store, the Bing / DuckDuckGo region and TikTok's region; Walmart is read only for `US` and Naver only for `KR`. A value that is not a country stops the run before any keyword is billed, with a status message naming it.",
            "default": "US"
          },
          "language": {
            "title": "Language",
            "type": "string",
            "description": "Language of the suggestions: a language code (`en`, `es`, `fr`, `de`, `pt`, `hi`, or a regional one such as `pt-BR` or `zh-TW`) or a language name (`Spanish`). Controls Google and YouTube `hl`, the Bing market, the Wikipedia edition, Yandex's language and TikTok's language (TikTok suggestions in another language are left out).",
            "default": "en"
          },
          "recursiveDepth": {
            "title": "Recursive depth",
            "minimum": 0,
            "maximum": 3,
            "type": "integer",
            "description": "How many extra levels to dig: at depth 1+, the keywords discovered at the previous level are re-queried to surface even deeper long-tail terms. 0 = seeds only. Use 1 for a big jump in coverage; higher values multiply requests fast (bounded by Max keywords).",
            "default": 0
          },
          "recursionMaxTermsPerLevel": {
            "title": "Max terms to expand per recursion level",
            "minimum": 1,
            "type": "integer",
            "description": "When recursive depth > 0, cap how many newly discovered keywords are expanded at each deeper level (cost control). Values above 500 run as 500.",
            "default": 50
          },
          "maxResults": {
            "title": "Max keywords",
            "minimum": 1,
            "type": "integer",
            "description": "Hard cap on the number of unique keyword records delivered by the whole run (controls cost). Only keywords that pass your filters count toward it (and, in monitor mode, only keywords not delivered by an earlier run), so a filtered run still fills it when autocomplete has enough. The run stops searching once it is full. Several seeds share it: their searches run side by side, so every seed is represented.",
            "default": 1000
          },
          "maxKeywordsPerSeed": {
            "title": "Max keywords per seed",
            "minimum": 0,
            "type": "integer",
            "description": "Optional per-seed cap on delivered keywords (0 = no per-seed cap). Like Max keywords, it counts only keywords that pass your filters. Useful when researching many seeds at once to keep each one balanced.",
            "default": 0
          },
          "dedupeAcrossPlatforms": {
            "title": "Merge the same keyword across platforms",
            "type": "boolean",
            "description": "ON (recommended): output one row per unique keyword, with a `platforms`/`platformCount` field and a `sources` array showing every platform + rank it surfaced on - a strong demand signal. OFF: output one row per keyword PER platform.",
            "default": true
          },
          "includeQuestionsOnly": {
            "title": "Only question keywords",
            "type": "boolean",
            "description": "Keep only question-style keywords (how/what/why/where… or containing `?`) - perfect for FAQ pages, People-Also-Ask content and informational SEO. Applied before Max keywords counts, so you still get your full number of questions when autocomplete has them (add the `questions` expansion for the most).",
            "default": false
          },
          "minWordCount": {
            "title": "Minimum word count",
            "minimum": 0,
            "type": "integer",
            "description": "Drop keywords shorter than this many words. Set to 3+ to keep only long-tail keywords. Applied before Max keywords counts.",
            "default": 0
          },
          "mustIncludeTerms": {
            "title": "Must include any of these terms",
            "type": "array",
            "description": "Keep only keywords containing at least one of these words/phrases, case-insensitive and matched at the start of a word (`review` also keeps `reviews`; `tea` does not match `steam`). Applied before Max keywords counts.",
            "items": {
              "type": "string"
            }
          },
          "excludeTerms": {
            "title": "Exclude these terms",
            "type": "array",
            "description": "Drop keywords containing any of these words/phrases (case-insensitive, matched at the start of a word) - e.g. brand names, `free`, `jobs`.",
            "items": {
              "type": "string"
            }
          },
          "monitorMode": {
            "title": "Monitor mode - only new keywords",
            "type": "boolean",
            "description": "Remember which keywords were emitted in previous runs (in a named key-value store) and return ONLY keywords not seen before - ideal for tracking emerging long-tail terms and trends. Works with Apify Schedules: the schedule starts the run, monitor mode deduplicates against prior runs.",
            "default": false
          },
          "monitorKey": {
            "title": "Monitor key",
            "type": "string",
            "description": "Names the monitor store so you can keep separate watch-lists (e.g. one per topic or market). Lowercase letters, numbers and hyphens.",
            "default": "default"
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 25,
            "type": "integer",
            "description": "Maximum number of autocomplete requests fetched in parallel.",
            "default": 10
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Proxy settings. With the default (Apify proxy on, no group chosen), each request first tries a direct connection, which these autocomplete endpoints answer fastest, and falls back to the Apify proxy on any miss; a platform that misses 3 direct tries in a row uses the proxy for the rest of the run. Pick a proxy group or your own proxy URLs to send every request through them exactly as set.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}