{
  "openapi": "3.0.1",
  "info": {
    "title": "Keyword Autocomplete Scraper - Google, YouTube, Amazon, Bing",
    "description": "Keyword autocomplete scraper: the suggestions Google, YouTube, Amazon and Bing show for your seed keywords, by country and language. One row per suggestion with its rank and the text looked up. Add a to z, 0 to 9 or question words for longer phrases. $0.01 to $0.35 per 1,000 suggestions, by engine.",
    "version": "0.1",
    "x-build-id": "HmCbgJinGijkeAefx"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/dami_studio~keyword-autocomplete-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-dami_studio-keyword-autocomplete-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/dami_studio~keyword-autocomplete-scraper/runs": {
      "post": {
        "operationId": "runs-sync-dami_studio-keyword-autocomplete-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/dami_studio~keyword-autocomplete-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-dami_studio-keyword-autocomplete-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": {
          "seeds": {
            "title": "Seed keywords",
            "maxItems": 1000,
            "type": "array",
            "description": "One per line, the way you'd start typing a search. Each seed goes to every engine you pick. Repeats are dropped. Up to 1,000 per run.",
            "items": {
              "type": "string"
            }
          },
          "engines": {
            "title": "Engines",
            "type": "array",
            "description": "Where to ask. Every row names its engine, and a phrase two engines both suggest comes back once for each of them.",
            "items": {
              "type": "string",
              "enum": [
                "google",
                "youtube",
                "amazon",
                "bing"
              ],
              "enumTitles": [
                "Google",
                "YouTube",
                "Amazon",
                "Bing"
              ]
            },
            "default": [
              "google"
            ]
          },
          "country": {
            "title": "Country",
            "enum": [
              "AF",
              "AX",
              "AL",
              "DZ",
              "AS",
              "AD",
              "AO",
              "AI",
              "AG",
              "AR",
              "AM",
              "AW",
              "AU",
              "AT",
              "AZ",
              "BS",
              "BH",
              "BD",
              "BB",
              "BY",
              "BE",
              "BZ",
              "BJ",
              "BM",
              "BT",
              "BO",
              "BA",
              "BW",
              "BR",
              "VG",
              "BN",
              "BG",
              "BF",
              "BI",
              "KH",
              "CM",
              "CA",
              "CV",
              "BQ",
              "KY",
              "CF",
              "TD",
              "CL",
              "CN",
              "CO",
              "KM",
              "CG",
              "CD",
              "CK",
              "CR",
              "CI",
              "HR",
              "CU",
              "CW",
              "CY",
              "CZ",
              "DK",
              "DJ",
              "DM",
              "DO",
              "EC",
              "EG",
              "SV",
              "GQ",
              "ER",
              "EE",
              "SZ",
              "ET",
              "FK",
              "FO",
              "FJ",
              "FI",
              "FR",
              "GF",
              "PF",
              "GA",
              "GM",
              "GE",
              "DE",
              "GH",
              "GI",
              "GR",
              "GL",
              "GD",
              "GP",
              "GU",
              "GT",
              "GG",
              "GN",
              "GW",
              "GY",
              "HT",
              "HN",
              "HK",
              "HU",
              "IS",
              "IN",
              "ID",
              "IR",
              "IQ",
              "IE",
              "IM",
              "IL",
              "IT",
              "JM",
              "JP",
              "JE",
              "JO",
              "KZ",
              "KE",
              "KI",
              "KW",
              "KG",
              "LA",
              "LV",
              "LB",
              "LS",
              "LR",
              "LY",
              "LI",
              "LT",
              "LU",
              "MO",
              "MG",
              "MW",
              "MY",
              "MV",
              "ML",
              "MT",
              "MH",
              "MQ",
              "MR",
              "MU",
              "YT",
              "MX",
              "FM",
              "MD",
              "MC",
              "MN",
              "ME",
              "MS",
              "MA",
              "MZ",
              "MM",
              "NA",
              "NR",
              "NP",
              "NL",
              "NC",
              "NZ",
              "NI",
              "NE",
              "NG",
              "NU",
              "KP",
              "MK",
              "MP",
              "NO",
              "OM",
              "PK",
              "PW",
              "PS",
              "PA",
              "PG",
              "PY",
              "PE",
              "PH",
              "PL",
              "PT",
              "PR",
              "QA",
              "RE",
              "RO",
              "RU",
              "RW",
              "WS",
              "SM",
              "ST",
              "SA",
              "SN",
              "RS",
              "SC",
              "SL",
              "SG",
              "SX",
              "SK",
              "SI",
              "SB",
              "SO",
              "ZA",
              "KR",
              "SS",
              "ES",
              "LK",
              "BL",
              "SH",
              "KN",
              "LC",
              "MF",
              "PM",
              "VC",
              "SD",
              "SR",
              "SE",
              "CH",
              "SY",
              "TW",
              "TJ",
              "TZ",
              "TH",
              "TL",
              "TG",
              "TK",
              "TO",
              "TT",
              "TN",
              "TR",
              "TM",
              "TC",
              "TV",
              "VI",
              "UG",
              "UA",
              "AE",
              "GB",
              "US",
              "UY",
              "UZ",
              "VU",
              "VA",
              "VE",
              "VN",
              "WF",
              "EH",
              "YE",
              "ZM",
              "ZW"
            ],
            "type": "string",
            "description": "Google and YouTube lean their suggestions toward this country. Bing reads it together with the language below. Amazon goes by the marketplace instead.",
            "default": "US"
          },
          "language": {
            "title": "Language",
            "enum": [
              "en",
              "af",
              "sq",
              "am",
              "ar",
              "hy",
              "az",
              "eu",
              "be",
              "bn",
              "bs",
              "bg",
              "my",
              "ca",
              "zh-CN",
              "zh-TW",
              "hr",
              "cs",
              "da",
              "nl",
              "et",
              "fil",
              "fi",
              "fr",
              "gl",
              "ka",
              "de",
              "el",
              "gu",
              "ha",
              "he",
              "hi",
              "hu",
              "is",
              "ig",
              "id",
              "ga",
              "it",
              "ja",
              "jv",
              "kn",
              "kk",
              "km",
              "ko",
              "ku",
              "ky",
              "lo",
              "lv",
              "lt",
              "lb",
              "mk",
              "mg",
              "ms",
              "ml",
              "mt",
              "mi",
              "mr",
              "mn",
              "ne",
              "no",
              "ps",
              "fa",
              "pl",
              "pt-BR",
              "pt-PT",
              "pa",
              "ro",
              "ru",
              "sr",
              "si",
              "sk",
              "sl",
              "so",
              "es",
              "es-419",
              "sw",
              "sv",
              "tg",
              "ta",
              "te",
              "th",
              "tr",
              "uk",
              "ur",
              "uz",
              "vi",
              "cy",
              "xh",
              "yo",
              "zu"
            ],
            "type": "string",
            "description": "The language Google and YouTube suggest in. Google has no separate suggestions in some languages, Welsh, Irish and Urdu among them, and answers those exactly as in English; the README lists them. Bing needs a language it has a market for in that country; when it hasn't, the run uses the country's own Bing market and says so in the status. Amazon ignores this setting.",
            "default": "en"
          },
          "amazonMarketplace": {
            "title": "Amazon marketplace",
            "enum": [
              "auto",
              "AE",
              "CA",
              "JP",
              "GB",
              "ZA",
              "US",
              "AU",
              "BE",
              "BR",
              "MX",
              "TR",
              "DE",
              "EG",
              "ES",
              "FR",
              "IE",
              "IN",
              "IT",
              "NL",
              "PL",
              "SA",
              "SE",
              "SG"
            ],
            "type": "string",
            "description": "Which Amazon to ask. Match the country uses the country above, or amazon.com when that country has no Amazon of its own.",
            "default": "auto"
          },
          "amazonDepartment": {
            "title": "Amazon department",
            "pattern": "^$|^[A-Za-z0-9][A-Za-z0-9-]{0,39}$",
            "type": "string",
            "description": "Leave it empty for all of Amazon. Otherwise use Amazon's own short name for the department, the one in its search links: stripbooks for books, electronics, grocery. A name Amazon doesn't know gets no suggestions at all."
          },
          "googleSearchType": {
            "title": "Google suggestions from",
            "enum": [
              "web",
              "shopping",
              "images",
              "news"
            ],
            "type": "string",
            "description": "Web is what the Google search box suggests. Shopping leans toward products: for \"coffee\" it led with coffee table and coffee maker where web led with coffee near me. Images and News come out close to Web.",
            "default": "web"
          },
          "addTrailingSpace": {
            "title": "Seed followed by a space",
            "type": "boolean",
            "description": "Also asks for \"coffee grinder \" with the space typed. Engines often complete it differently.",
            "default": false
          },
          "expandAlphabet": {
            "title": "Seed followed by a to z",
            "type": "boolean",
            "description": "26 more lookups per seed and engine: \"coffee grinder a\", \"coffee grinder b\" and so on. Most of the long phrases come from here.",
            "default": false
          },
          "expandNumbers": {
            "title": "Seed followed by 0 to 9",
            "type": "boolean",
            "description": "10 more lookups per seed and engine. Good for model numbers, sizes and years.",
            "default": false
          },
          "expandQuestions": {
            "title": "Question words in front of the seed",
            "type": "boolean",
            "description": "One more lookup per question word below: \"how coffee grinder\", \"why coffee grinder\". Engines finish these as the questions people ask.",
            "default": false
          },
          "questionWords": {
            "title": "Question words",
            "maxItems": 30,
            "type": "array",
            "description": "Used when question words are on. Add words of your own, such as best or cheap, or words in the language you picked. Up to 30.",
            "default": [
              "how",
              "what",
              "why",
              "where",
              "when",
              "who",
              "which",
              "can",
              "is",
              "are",
              "does",
              "will",
              "should"
            ],
            "items": {
              "type": "string"
            }
          },
          "expansionDepth": {
            "title": "Levels of suggestions to follow",
            "minimum": 1,
            "maximum": 3,
            "type": "integer",
            "description": "1 asks your seeds and the variations switched on above. 2 also asks each new suggestion as if you had typed it, which is where the longer phrases come from. 3 goes one level further. Every level adds lookups, and Maximum suggestions still stops the run.",
            "default": 1
          },
          "maxSuggestionsPerQuery": {
            "title": "Most suggestions per lookup",
            "minimum": 1,
            "maximum": 25,
            "type": "integer",
            "description": "Keep only the top of each list. Leave it empty to keep all of it: up to 15 from Google, 14 from YouTube, 10 from Amazon and 25 from Bing."
          },
          "maxSuggestions": {
            "title": "Maximum suggestions",
            "minimum": 1,
            "maximum": 50000,
            "type": "integer",
            "description": "The most suggestions one run returns, all engines together, up to 50,000. Each one returned is one charge.",
            "default": 5000
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}