SerpApi CLI SEO Keyword Generator Tool. Generates keyword ideas from Google Autocomplete, Google People Also Search and People Also Ask
npm install js-seo-keywords-generatorbash
npm i -g js-seo-keywords-generator
`
If you want to get results from SEO Keywords generator in your Node.js app, you need to add it to your project dependency:
`bash
npm i js-seo-keywords-generator
`
CLI Usage
Before use, you must add an environment variable API_KEY with your API key from SerpApi. Read more how to add it in different systems.
Usage example:
`bash
seo get
`
Usage options:
`bash
seo help get
`
Available arguments
`lang-none
-e, --engine Parameter defines the engine(s) of use. It can be set to "paa" (People Also Ask),
"rs" (Related Searches), "ac" (Autocomplete), or in any combination, e.g.
"paa,rs,ac" (default). (default: ["paa","rs","ac"])
-d, --domain Parameter defines the Google domain to use. It defaults to google.com. Head to the
https://serpapi.com/google-domains for a full list of supported Google domains.
(default: "google.com")
-gl, --country Parameter defines the country to use for the Google search. Head to the
https://serpapi.com/google-countries for a full list of supported Google countries.
(default: "us")
-hl, --language Parameter defines the language to use for the Google search. Head to the
https://serpapi.com/google-languages for a full list of supported Google languages.
(default: "en")
-dl, --depth Parameter defines the depth of disclosure of questions for People Also Ask (default:
"1")
-ft, --type Parameter defines the type of file to save. (choices: "json", "txt", "csv", default:
"json")
-h, --help display help for command
`
📌Note: The depth limit parameter for People Also Ask can be set from 1 to 3. This limit is set because for each depth value, the number of results returned grows exponentially, for example, if the number of results is 5 at each level, for a depth of 3, the total number of results will be equals 125.
In code usage
Import SEO to your file:
`javascript
import SEO from "seo-keywords";
`
Before use, you need to define your API key from SerpApi. There are several ways to do this:
- Add an environment variable API_KEY with your key. Read more how to add it in different systems;
- Add your key directly in code: SEO.api_key = "your_api_key".
Usage example:
`javascript
(async () => {
console.log(await SEO.getAll("minecraft"));
})();
`
Awailable methods:
`javascript
getAll(query[, domain[, country[, language[, depthlimit]]]])
getCustom(engines, query[, domain[, country[, language[, depthlimit]]]])
getPeopleAlsoAsk(query[, domain[, country[, language[, depthlimit]]]])
getRelatedSearch(query[, domain[, country[, language]]])
getAutocomplete(query[, domain[, country[, language]]])
`
- query - search query.
- engines - parameter defines the engine(s) of use:
- paa (People Also Ask)
- rs (Related Searches)
- ac (Autocomplete)
- could be combined: paa, ac
- domain - parameter defines the Google domain to use. Head to the Google domains page for a full list of supported Google domains. Default is google.com.
- country - parameter defines the country to use for the Google search. Head to the Google countries page for a full list of supported Google countries. Default is us.
- language - parameter defines the language to use for the Google search. Head to the Google languages page for a full list of supported Google languages. Default is en.
- depthlimit - parameter defines the depth of disclosure of questions for People Also Ask. Default is 1 (Only for People Also Ask engine).
📌Note: The depth limit parameter for People Also Ask can be set from 1 to 3. This limit is set because for each depth value, the number of results returned grows exponentially, for example, if the number of results is 5 at each level, for a depth of 3, the total number of results will be equals 125`.