@mirage-cli/dataforseo-cli 0.1.1 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/bin.js +687 -0
- package/dist/dfs.js +13 -15
- package/dist/index.js +18 -19
- package/package.json +4 -6
package/dist/bin.js
ADDED
|
@@ -0,0 +1,687 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import{createRequire as st}from"node:module";var Zo=Object.create;var{getPrototypeOf:et,defineProperty:we,getOwnPropertyNames:ot}=Object;var tt=Object.prototype.hasOwnProperty;var at=(e,o,t)=>{t=e!=null?Zo(et(e)):{};let a=o||!e||!e.__esModule?we(t,"default",{value:e,enumerable:!0}):t;for(let s of ot(e))if(!tt.call(a,s))we(a,s,{get:()=>e[s],enumerable:!0});return a};var O=(e,o)=>()=>(o||e((o={exports:{}}).exports,o),o.exports);var K=st(import.meta.url);var C=O((it)=>{class re extends Error{constructor(e,o,t){super(t);Error.captureStackTrace(this,this.constructor),this.name=this.constructor.name,this.code=o,this.exitCode=e,this.nestedError=void 0}}class be extends re{constructor(e){super(1,"commander.invalidArgument",e);Error.captureStackTrace(this,this.constructor),this.name=this.constructor.name}}it.CommanderError=re;it.InvalidArgumentError=be});var $=O((lt)=>{var{InvalidArgumentError:dt}=C();class Te{constructor(e,o){switch(this.description=o||"",this.variadic=!1,this.parseArg=void 0,this.defaultValue=void 0,this.defaultValueDescription=void 0,this.argChoices=void 0,e[0]){case"<":this.required=!0,this._name=e.slice(1,-1);break;case"[":this.required=!1,this._name=e.slice(1,-1);break;default:this.required=!0,this._name=e;break}if(this._name.length>3&&this._name.slice(-3)==="...")this.variadic=!0,this._name=this._name.slice(0,-3)}name(){return this._name}_concatValue(e,o){if(o===this.defaultValue||!Array.isArray(o))return[e];return o.concat(e)}default(e,o){return this.defaultValue=e,this.defaultValueDescription=o,this}argParser(e){return this.parseArg=e,this}choices(e){return this.argChoices=e.slice(),this.parseArg=(o,t)=>{if(!this.argChoices.includes(o))throw new dt(`Allowed choices are ${this.argChoices.join(", ")}.`);if(this.variadic)return this._concatValue(o,t);return o},this}argRequired(){return this.required=!0,this}argOptional(){return this.required=!1,this}}function ct(e){let o=e.name()+(e.variadic===!0?"...":"");return e.required?"<"+o+">":"["+o+"]"}lt.Argument=Te;lt.humanReadableArgName=ct});var ne=O((mt)=>{var{humanReadableArgName:gt}=$();class Ie{constructor(){this.helpWidth=void 0,this.sortSubcommands=!1,this.sortOptions=!1,this.showGlobalOptions=!1}visibleCommands(e){let o=e.commands.filter((a)=>!a._hidden),t=e._getHelpCommand();if(t&&!t._hidden)o.push(t);if(this.sortSubcommands)o.sort((a,s)=>{return a.name().localeCompare(s.name())});return o}compareOptions(e,o){let t=(a)=>{return a.short?a.short.replace(/^-/,""):a.long.replace(/^--/,"")};return t(e).localeCompare(t(o))}visibleOptions(e){let o=e.options.filter((a)=>!a.hidden),t=e._getHelpOption();if(t&&!t.hidden){let a=t.short&&e._findOption(t.short),s=t.long&&e._findOption(t.long);if(!a&&!s)o.push(t);else if(t.long&&!s)o.push(e.createOption(t.long,t.description));else if(t.short&&!a)o.push(e.createOption(t.short,t.description))}if(this.sortOptions)o.sort(this.compareOptions);return o}visibleGlobalOptions(e){if(!this.showGlobalOptions)return[];let o=[];for(let t=e.parent;t;t=t.parent){let a=t.options.filter((s)=>!s.hidden);o.push(...a)}if(this.sortOptions)o.sort(this.compareOptions);return o}visibleArguments(e){if(e._argsDescription)e.registeredArguments.forEach((o)=>{o.description=o.description||e._argsDescription[o.name()]||""});if(e.registeredArguments.find((o)=>o.description))return e.registeredArguments;return[]}subcommandTerm(e){let o=e.registeredArguments.map((t)=>gt(t)).join(" ");return e._name+(e._aliases[0]?"|"+e._aliases[0]:"")+(e.options.length?" [options]":"")+(o?" "+o:"")}optionTerm(e){return e.flags}argumentTerm(e){return e.name()}longestSubcommandTermLength(e,o){return o.visibleCommands(e).reduce((t,a)=>{return Math.max(t,o.subcommandTerm(a).length)},0)}longestOptionTermLength(e,o){return o.visibleOptions(e).reduce((t,a)=>{return Math.max(t,o.optionTerm(a).length)},0)}longestGlobalOptionTermLength(e,o){return o.visibleGlobalOptions(e).reduce((t,a)=>{return Math.max(t,o.optionTerm(a).length)},0)}longestArgumentTermLength(e,o){return o.visibleArguments(e).reduce((t,a)=>{return Math.max(t,o.argumentTerm(a).length)},0)}commandUsage(e){let o=e._name;if(e._aliases[0])o=o+"|"+e._aliases[0];let t="";for(let a=e.parent;a;a=a.parent)t=a.name()+" "+t;return t+o+" "+e.usage()}commandDescription(e){return e.description()}subcommandDescription(e){return e.summary()||e.description()}optionDescription(e){let o=[];if(e.argChoices)o.push(`choices: ${e.argChoices.map((t)=>JSON.stringify(t)).join(", ")}`);if(e.defaultValue!==void 0){if(e.required||e.optional||e.isBoolean()&&typeof e.defaultValue==="boolean")o.push(`default: ${e.defaultValueDescription||JSON.stringify(e.defaultValue)}`)}if(e.presetArg!==void 0&&e.optional)o.push(`preset: ${JSON.stringify(e.presetArg)}`);if(e.envVar!==void 0)o.push(`env: ${e.envVar}`);if(o.length>0)return`${e.description} (${o.join(", ")})`;return e.description}argumentDescription(e){let o=[];if(e.argChoices)o.push(`choices: ${e.argChoices.map((t)=>JSON.stringify(t)).join(", ")}`);if(e.defaultValue!==void 0)o.push(`default: ${e.defaultValueDescription||JSON.stringify(e.defaultValue)}`);if(o.length>0){let t=`(${o.join(", ")})`;if(e.description)return`${e.description} ${t}`;return t}return e.description}formatHelp(e,o){let t=o.padWidth(e,o),a=o.helpWidth||80,s=2,i=2;function n(S,B){if(B){let ie=`${S.padEnd(t+2)}${B}`;return o.wrap(ie,a-2,t+2)}return S}function r(S){return S.join(`
|
|
3
|
+
`).replace(/^/gm," ".repeat(2))}let d=[`Usage: ${o.commandUsage(e)}`,""],l=o.commandDescription(e);if(l.length>0)d=d.concat([o.wrap(l,a,0),""]);let _=o.visibleArguments(e).map((S)=>{return n(o.argumentTerm(S),o.argumentDescription(S))});if(_.length>0)d=d.concat(["Arguments:",r(_),""]);let b=o.visibleOptions(e).map((S)=>{return n(o.optionTerm(S),o.optionDescription(S))});if(b.length>0)d=d.concat(["Options:",r(b),""]);if(this.showGlobalOptions){let S=o.visibleGlobalOptions(e).map((B)=>{return n(o.optionTerm(B),o.optionDescription(B))});if(S.length>0)d=d.concat(["Global Options:",r(S),""])}let U=o.visibleCommands(e).map((S)=>{return n(o.subcommandTerm(S),o.subcommandDescription(S))});if(U.length>0)d=d.concat(["Commands:",r(U),""]);return d.join(`
|
|
4
|
+
`)}padWidth(e,o){return Math.max(o.longestOptionTermLength(e,o),o.longestGlobalOptionTermLength(e,o),o.longestSubcommandTermLength(e,o),o.longestArgumentTermLength(e,o))}wrap(e,o,t,a=40){let i=new RegExp(`[\\n][${" \\f\\t\\v - \uFEFF"}]+`);if(e.match(i))return e;let n=o-t;if(n<a)return e;let r=e.slice(0,t),d=e.slice(t).replace(`\r
|
|
5
|
+
`,`
|
|
6
|
+
`),l=" ".repeat(t),b=`\\s${""}`,U=new RegExp(`
|
|
7
|
+
|.{1,${n-1}}([${b}]|$)|[^${b}]+?([${b}]|$)`,"g"),S=d.match(U)||[];return r+S.map((B,ie)=>{if(B===`
|
|
8
|
+
`)return"";return(ie>0?l:"")+B.trimEnd()}).join(`
|
|
9
|
+
`)}}mt.Help=Ie});var de=O((yt)=>{var{InvalidArgumentError:ut}=C();class Se{constructor(e,o){this.flags=e,this.description=o||"",this.required=e.includes("<"),this.optional=e.includes("["),this.variadic=/\w\.\.\.[>\]]$/.test(e),this.mandatory=!1;let t=_t(e);if(this.short=t.shortFlag,this.long=t.longFlag,this.negate=!1,this.long)this.negate=this.long.startsWith("--no-");this.defaultValue=void 0,this.defaultValueDescription=void 0,this.presetArg=void 0,this.envVar=void 0,this.parseArg=void 0,this.hidden=!1,this.argChoices=void 0,this.conflictsWith=[],this.implied=void 0}default(e,o){return this.defaultValue=e,this.defaultValueDescription=o,this}preset(e){return this.presetArg=e,this}conflicts(e){return this.conflictsWith=this.conflictsWith.concat(e),this}implies(e){let o=e;if(typeof e==="string")o={[e]:!0};return this.implied=Object.assign(this.implied||{},o),this}env(e){return this.envVar=e,this}argParser(e){return this.parseArg=e,this}makeOptionMandatory(e=!0){return this.mandatory=!!e,this}hideHelp(e=!0){return this.hidden=!!e,this}_concatValue(e,o){if(o===this.defaultValue||!Array.isArray(o))return[e];return o.concat(e)}choices(e){return this.argChoices=e.slice(),this.parseArg=(o,t)=>{if(!this.argChoices.includes(o))throw new ut(`Allowed choices are ${this.argChoices.join(", ")}.`);if(this.variadic)return this._concatValue(o,t);return o},this}name(){if(this.long)return this.long.replace(/^--/,"");return this.short.replace(/^-/,"")}attributeName(){return vt(this.name().replace(/^no-/,""))}is(e){return this.short===e||this.long===e}isBoolean(){return!this.required&&!this.optional&&!this.negate}}class Le{constructor(e){this.positiveOptions=new Map,this.negativeOptions=new Map,this.dualOptions=new Set,e.forEach((o)=>{if(o.negate)this.negativeOptions.set(o.attributeName(),o);else this.positiveOptions.set(o.attributeName(),o)}),this.negativeOptions.forEach((o,t)=>{if(this.positiveOptions.has(t))this.dualOptions.add(t)})}valueFromOption(e,o){let t=o.attributeName();if(!this.dualOptions.has(t))return!0;let a=this.negativeOptions.get(t).presetArg,s=a!==void 0?a:!1;return o.negate===(s===e)}}function vt(e){return e.split("-").reduce((o,t)=>{return o+t[0].toUpperCase()+t.slice(1)})}function _t(e){let o,t,a=e.split(/[ |,]+/);if(a.length>1&&!/^[[<]/.test(a[1]))o=a.shift();if(t=a.shift(),!o&&/^-[^-]$/.test(t))o=t,t=void 0;return{shortFlag:o,longFlag:t}}yt.Option=Se;yt.DualOptions=Le});var Ae=O((It)=>{function bt(e,o){if(Math.abs(e.length-o.length)>3)return Math.max(e.length,o.length);let t=[];for(let a=0;a<=e.length;a++)t[a]=[a];for(let a=0;a<=o.length;a++)t[0][a]=a;for(let a=1;a<=o.length;a++)for(let s=1;s<=e.length;s++){let i=1;if(e[s-1]===o[a-1])i=0;else i=1;if(t[s][a]=Math.min(t[s-1][a]+1,t[s][a-1]+1,t[s-1][a-1]+i),s>1&&a>1&&e[s-1]===o[a-2]&&e[s-2]===o[a-1])t[s][a]=Math.min(t[s][a],t[s-2][a-2]+1)}return t[e.length][o.length]}function Tt(e,o){if(!o||o.length===0)return"";o=Array.from(new Set(o));let t=e.startsWith("--");if(t)e=e.slice(2),o=o.map((n)=>n.slice(2));let a=[],s=3,i=0.4;if(o.forEach((n)=>{if(n.length<=1)return;let r=bt(e,n),d=Math.max(e.length,n.length);if((d-r)/d>i){if(r<s)s=r,a=[n];else if(r===s)a.push(n)}}),a.sort((n,r)=>n.localeCompare(r)),t)a=a.map((n)=>`--${n}`);if(a.length>1)return`
|
|
10
|
+
(Did you mean one of ${a.join(", ")}?)`;if(a.length===1)return`
|
|
11
|
+
(Did you mean ${a[0]}?)`;return""}It.suggestSimilar=Tt});var De=O((Dt)=>{var Lt=K("node:events").EventEmitter,ce=K("node:child_process"),D=K("node:path"),le=K("node:fs"),T=K("node:process"),{Argument:At,humanReadableArgName:Gt}=$(),{CommanderError:pe}=C(),{Help:Ut}=ne(),{Option:Ge,DualOptions:Pt}=de(),{suggestSimilar:Ue}=Ae();class he extends Lt{constructor(e){super();this.commands=[],this.options=[],this.parent=null,this._allowUnknownOption=!1,this._allowExcessArguments=!0,this.registeredArguments=[],this._args=this.registeredArguments,this.args=[],this.rawArgs=[],this.processedArgs=[],this._scriptPath=null,this._name=e||"",this._optionValues={},this._optionValueSources={},this._storeOptionsAsProperties=!1,this._actionHandler=null,this._executableHandler=!1,this._executableFile=null,this._executableDir=null,this._defaultCommandName=null,this._exitCallback=null,this._aliases=[],this._combineFlagAndOptionalValue=!0,this._description="",this._summary="",this._argsDescription=void 0,this._enablePositionalOptions=!1,this._passThroughOptions=!1,this._lifeCycleHooks={},this._showHelpAfterError=!1,this._showSuggestionAfterError=!0,this._outputConfiguration={writeOut:(o)=>T.stdout.write(o),writeErr:(o)=>T.stderr.write(o),getOutHelpWidth:()=>T.stdout.isTTY?T.stdout.columns:void 0,getErrHelpWidth:()=>T.stderr.isTTY?T.stderr.columns:void 0,outputError:(o,t)=>t(o)},this._hidden=!1,this._helpOption=void 0,this._addImplicitHelpCommand=void 0,this._helpCommand=void 0,this._helpConfiguration={}}copyInheritedSettings(e){return this._outputConfiguration=e._outputConfiguration,this._helpOption=e._helpOption,this._helpCommand=e._helpCommand,this._helpConfiguration=e._helpConfiguration,this._exitCallback=e._exitCallback,this._storeOptionsAsProperties=e._storeOptionsAsProperties,this._combineFlagAndOptionalValue=e._combineFlagAndOptionalValue,this._allowExcessArguments=e._allowExcessArguments,this._enablePositionalOptions=e._enablePositionalOptions,this._showHelpAfterError=e._showHelpAfterError,this._showSuggestionAfterError=e._showSuggestionAfterError,this}_getCommandAndAncestors(){let e=[];for(let o=this;o;o=o.parent)e.push(o);return e}command(e,o,t){let a=o,s=t;if(typeof a==="object"&&a!==null)s=a,a=null;s=s||{};let[,i,n]=e.match(/([^ ]+) *(.*)/),r=this.createCommand(i);if(a)r.description(a),r._executableHandler=!0;if(s.isDefault)this._defaultCommandName=r._name;if(r._hidden=!!(s.noHelp||s.hidden),r._executableFile=s.executableFile||null,n)r.arguments(n);if(this._registerCommand(r),r.parent=this,r.copyInheritedSettings(this),a)return this;return r}createCommand(e){return new he(e)}createHelp(){return Object.assign(new Ut,this.configureHelp())}configureHelp(e){if(e===void 0)return this._helpConfiguration;return this._helpConfiguration=e,this}configureOutput(e){if(e===void 0)return this._outputConfiguration;return Object.assign(this._outputConfiguration,e),this}showHelpAfterError(e=!0){if(typeof e!=="string")e=!!e;return this._showHelpAfterError=e,this}showSuggestionAfterError(e=!0){return this._showSuggestionAfterError=!!e,this}addCommand(e,o){if(!e._name)throw Error(`Command passed to .addCommand() must have a name
|
|
12
|
+
- specify the name in Command constructor or using .name()`);if(o=o||{},o.isDefault)this._defaultCommandName=e._name;if(o.noHelp||o.hidden)e._hidden=!0;return this._registerCommand(e),e.parent=this,e._checkForBrokenPassThrough(),this}createArgument(e,o){return new At(e,o)}argument(e,o,t,a){let s=this.createArgument(e,o);if(typeof t==="function")s.default(a).argParser(t);else s.default(t);return this.addArgument(s),this}arguments(e){return e.trim().split(/ +/).forEach((o)=>{this.argument(o)}),this}addArgument(e){let o=this.registeredArguments.slice(-1)[0];if(o&&o.variadic)throw Error(`only the last argument can be variadic '${o.name()}'`);if(e.required&&e.defaultValue!==void 0&&e.parseArg===void 0)throw Error(`a default value for a required argument is never used: '${e.name()}'`);return this.registeredArguments.push(e),this}helpCommand(e,o){if(typeof e==="boolean")return this._addImplicitHelpCommand=e,this;e=e??"help [command]";let[,t,a]=e.match(/([^ ]+) *(.*)/),s=o??"display help for command",i=this.createCommand(t);if(i.helpOption(!1),a)i.arguments(a);if(s)i.description(s);return this._addImplicitHelpCommand=!0,this._helpCommand=i,this}addHelpCommand(e,o){if(typeof e!=="object")return this.helpCommand(e,o),this;return this._addImplicitHelpCommand=!0,this._helpCommand=e,this}_getHelpCommand(){if(this._addImplicitHelpCommand??(this.commands.length&&!this._actionHandler&&!this._findCommand("help"))){if(this._helpCommand===void 0)this.helpCommand(void 0,void 0);return this._helpCommand}return null}hook(e,o){let t=["preSubcommand","preAction","postAction"];if(!t.includes(e))throw Error(`Unexpected value for event passed to hook : '${e}'.
|
|
13
|
+
Expecting one of '${t.join("', '")}'`);if(this._lifeCycleHooks[e])this._lifeCycleHooks[e].push(o);else this._lifeCycleHooks[e]=[o];return this}exitOverride(e){if(e)this._exitCallback=e;else this._exitCallback=(o)=>{if(o.code!=="commander.executeSubCommandAsync")throw o};return this}_exit(e,o,t){if(this._exitCallback)this._exitCallback(new pe(e,o,t));T.exit(e)}action(e){let o=(t)=>{let a=this.registeredArguments.length,s=t.slice(0,a);if(this._storeOptionsAsProperties)s[a]=this;else s[a]=this.opts();return s.push(this),e.apply(this,s)};return this._actionHandler=o,this}createOption(e,o){return new Ge(e,o)}_callParseArg(e,o,t,a){try{return e.parseArg(o,t)}catch(s){if(s.code==="commander.invalidArgument"){let i=`${a} ${s.message}`;this.error(i,{exitCode:s.exitCode,code:s.code})}throw s}}_registerOption(e){let o=e.short&&this._findOption(e.short)||e.long&&this._findOption(e.long);if(o){let t=e.long&&this._findOption(e.long)?e.long:e.short;throw Error(`Cannot add option '${e.flags}'${this._name&&` to command '${this._name}'`} due to conflicting flag '${t}'
|
|
14
|
+
- already used by option '${o.flags}'`)}this.options.push(e)}_registerCommand(e){let o=(a)=>{return[a.name()].concat(a.aliases())},t=o(e).find((a)=>this._findCommand(a));if(t){let a=o(this._findCommand(t)).join("|"),s=o(e).join("|");throw Error(`cannot add command '${s}' as already have command '${a}'`)}this.commands.push(e)}addOption(e){this._registerOption(e);let o=e.name(),t=e.attributeName();if(e.negate){let s=e.long.replace(/^--no-/,"--");if(!this._findOption(s))this.setOptionValueWithSource(t,e.defaultValue===void 0?!0:e.defaultValue,"default")}else if(e.defaultValue!==void 0)this.setOptionValueWithSource(t,e.defaultValue,"default");let a=(s,i,n)=>{if(s==null&&e.presetArg!==void 0)s=e.presetArg;let r=this.getOptionValue(t);if(s!==null&&e.parseArg)s=this._callParseArg(e,s,r,i);else if(s!==null&&e.variadic)s=e._concatValue(s,r);if(s==null)if(e.negate)s=!1;else if(e.isBoolean()||e.optional)s=!0;else s="";this.setOptionValueWithSource(t,s,n)};if(this.on("option:"+o,(s)=>{let i=`error: option '${e.flags}' argument '${s}' is invalid.`;a(s,i,"cli")}),e.envVar)this.on("optionEnv:"+o,(s)=>{let i=`error: option '${e.flags}' value '${s}' from env '${e.envVar}' is invalid.`;a(s,i,"env")});return this}_optionEx(e,o,t,a,s){if(typeof o==="object"&&o instanceof Ge)throw Error("To add an Option object use addOption() instead of option() or requiredOption()");let i=this.createOption(o,t);if(i.makeOptionMandatory(!!e.mandatory),typeof a==="function")i.default(s).argParser(a);else if(a instanceof RegExp){let n=a;a=(r,d)=>{let l=n.exec(r);return l?l[0]:d},i.default(s).argParser(a)}else i.default(a);return this.addOption(i)}option(e,o,t,a){return this._optionEx({},e,o,t,a)}requiredOption(e,o,t,a){return this._optionEx({mandatory:!0},e,o,t,a)}combineFlagAndOptionalValue(e=!0){return this._combineFlagAndOptionalValue=!!e,this}allowUnknownOption(e=!0){return this._allowUnknownOption=!!e,this}allowExcessArguments(e=!0){return this._allowExcessArguments=!!e,this}enablePositionalOptions(e=!0){return this._enablePositionalOptions=!!e,this}passThroughOptions(e=!0){return this._passThroughOptions=!!e,this._checkForBrokenPassThrough(),this}_checkForBrokenPassThrough(){if(this.parent&&this._passThroughOptions&&!this.parent._enablePositionalOptions)throw Error(`passThroughOptions cannot be used for '${this._name}' without turning on enablePositionalOptions for parent command(s)`)}storeOptionsAsProperties(e=!0){if(this.options.length)throw Error("call .storeOptionsAsProperties() before adding options");if(Object.keys(this._optionValues).length)throw Error("call .storeOptionsAsProperties() before setting option values");return this._storeOptionsAsProperties=!!e,this}getOptionValue(e){if(this._storeOptionsAsProperties)return this[e];return this._optionValues[e]}setOptionValue(e,o){return this.setOptionValueWithSource(e,o,void 0)}setOptionValueWithSource(e,o,t){if(this._storeOptionsAsProperties)this[e]=o;else this._optionValues[e]=o;return this._optionValueSources[e]=t,this}getOptionValueSource(e){return this._optionValueSources[e]}getOptionValueSourceWithGlobals(e){let o;return this._getCommandAndAncestors().forEach((t)=>{if(t.getOptionValueSource(e)!==void 0)o=t.getOptionValueSource(e)}),o}_prepareUserArgs(e,o){if(e!==void 0&&!Array.isArray(e))throw Error("first parameter to parse must be array or undefined");if(o=o||{},e===void 0&&o.from===void 0){if(T.versions?.electron)o.from="electron";let a=T.execArgv??[];if(a.includes("-e")||a.includes("--eval")||a.includes("-p")||a.includes("--print"))o.from="eval"}if(e===void 0)e=T.argv;this.rawArgs=e.slice();let t;switch(o.from){case void 0:case"node":this._scriptPath=e[1],t=e.slice(2);break;case"electron":if(T.defaultApp)this._scriptPath=e[1],t=e.slice(2);else t=e.slice(1);break;case"user":t=e.slice(0);break;case"eval":t=e.slice(1);break;default:throw Error(`unexpected parse option { from: '${o.from}' }`)}if(!this._name&&this._scriptPath)this.nameFromFilename(this._scriptPath);return this._name=this._name||"program",t}parse(e,o){let t=this._prepareUserArgs(e,o);return this._parseCommand([],t),this}async parseAsync(e,o){let t=this._prepareUserArgs(e,o);return await this._parseCommand([],t),this}_executeSubCommand(e,o){o=o.slice();let t=!1,a=[".js",".ts",".tsx",".mjs",".cjs"];function s(l,_){let b=D.resolve(l,_);if(le.existsSync(b))return b;if(a.includes(D.extname(_)))return;let U=a.find((S)=>le.existsSync(`${b}${S}`));if(U)return`${b}${U}`;return}this._checkForMissingMandatoryOptions(),this._checkForConflictingOptions();let i=e._executableFile||`${this._name}-${e._name}`,n=this._executableDir||"";if(this._scriptPath){let l;try{l=le.realpathSync(this._scriptPath)}catch(_){l=this._scriptPath}n=D.resolve(D.dirname(l),n)}if(n){let l=s(n,i);if(!l&&!e._executableFile&&this._scriptPath){let _=D.basename(this._scriptPath,D.extname(this._scriptPath));if(_!==this._name)l=s(n,`${_}-${e._name}`)}i=l||i}t=a.includes(D.extname(i));let r;if(T.platform!=="win32")if(t)o.unshift(i),o=Pe(T.execArgv).concat(o),r=ce.spawn(T.argv[0],o,{stdio:"inherit"});else r=ce.spawn(i,o,{stdio:"inherit"});else o.unshift(i),o=Pe(T.execArgv).concat(o),r=ce.spawn(T.execPath,o,{stdio:"inherit"});if(!r.killed)["SIGUSR1","SIGUSR2","SIGTERM","SIGINT","SIGHUP"].forEach((_)=>{T.on(_,()=>{if(r.killed===!1&&r.exitCode===null)r.kill(_)})});let d=this._exitCallback;r.on("close",(l)=>{if(l=l??1,!d)T.exit(l);else d(new pe(l,"commander.executeSubCommandAsync","(close)"))}),r.on("error",(l)=>{if(l.code==="ENOENT"){let _=n?`searched for local subcommand relative to directory '${n}'`:"no directory for search for local subcommand, use .executableDir() to supply a custom directory",b=`'${i}' does not exist
|
|
15
|
+
- if '${e._name}' is not meant to be an executable command, remove description parameter from '.command()' and use '.description()' instead
|
|
16
|
+
- if the default executable name is not suitable, use the executableFile option to supply a custom name or path
|
|
17
|
+
- ${_}`;throw Error(b)}else if(l.code==="EACCES")throw Error(`'${i}' not executable`);if(!d)T.exit(1);else{let _=new pe(1,"commander.executeSubCommandAsync","(error)");_.nestedError=l,d(_)}}),this.runningCommand=r}_dispatchSubcommand(e,o,t){let a=this._findCommand(e);if(!a)this.help({error:!0});let s;return s=this._chainOrCallSubCommandHook(s,a,"preSubcommand"),s=this._chainOrCall(s,()=>{if(a._executableHandler)this._executeSubCommand(a,o.concat(t));else return a._parseCommand(o,t)}),s}_dispatchHelpCommand(e){if(!e)this.help();let o=this._findCommand(e);if(o&&!o._executableHandler)o.help();return this._dispatchSubcommand(e,[],[this._getHelpOption()?.long??this._getHelpOption()?.short??"--help"])}_checkNumberOfArguments(){if(this.registeredArguments.forEach((e,o)=>{if(e.required&&this.args[o]==null)this.missingArgument(e.name())}),this.registeredArguments.length>0&&this.registeredArguments[this.registeredArguments.length-1].variadic)return;if(this.args.length>this.registeredArguments.length)this._excessArguments(this.args)}_processArguments(){let e=(t,a,s)=>{let i=a;if(a!==null&&t.parseArg){let n=`error: command-argument value '${a}' is invalid for argument '${t.name()}'.`;i=this._callParseArg(t,a,s,n)}return i};this._checkNumberOfArguments();let o=[];this.registeredArguments.forEach((t,a)=>{let s=t.defaultValue;if(t.variadic){if(a<this.args.length){if(s=this.args.slice(a),t.parseArg)s=s.reduce((i,n)=>{return e(t,n,i)},t.defaultValue)}else if(s===void 0)s=[]}else if(a<this.args.length){if(s=this.args[a],t.parseArg)s=e(t,s,t.defaultValue)}o[a]=s}),this.processedArgs=o}_chainOrCall(e,o){if(e&&e.then&&typeof e.then==="function")return e.then(()=>o());return o()}_chainOrCallHooks(e,o){let t=e,a=[];if(this._getCommandAndAncestors().reverse().filter((s)=>s._lifeCycleHooks[o]!==void 0).forEach((s)=>{s._lifeCycleHooks[o].forEach((i)=>{a.push({hookedCommand:s,callback:i})})}),o==="postAction")a.reverse();return a.forEach((s)=>{t=this._chainOrCall(t,()=>{return s.callback(s.hookedCommand,this)})}),t}_chainOrCallSubCommandHook(e,o,t){let a=e;if(this._lifeCycleHooks[t]!==void 0)this._lifeCycleHooks[t].forEach((s)=>{a=this._chainOrCall(a,()=>{return s(this,o)})});return a}_parseCommand(e,o){let t=this.parseOptions(o);if(this._parseOptionsEnv(),this._parseOptionsImplied(),e=e.concat(t.operands),o=t.unknown,this.args=e.concat(o),e&&this._findCommand(e[0]))return this._dispatchSubcommand(e[0],e.slice(1),o);if(this._getHelpCommand()&&e[0]===this._getHelpCommand().name())return this._dispatchHelpCommand(e[1]);if(this._defaultCommandName)return this._outputHelpIfRequested(o),this._dispatchSubcommand(this._defaultCommandName,e,o);if(this.commands.length&&this.args.length===0&&!this._actionHandler&&!this._defaultCommandName)this.help({error:!0});this._outputHelpIfRequested(t.unknown),this._checkForMissingMandatoryOptions(),this._checkForConflictingOptions();let a=()=>{if(t.unknown.length>0)this.unknownOption(t.unknown[0])},s=`command:${this.name()}`;if(this._actionHandler){a(),this._processArguments();let i;if(i=this._chainOrCallHooks(i,"preAction"),i=this._chainOrCall(i,()=>this._actionHandler(this.processedArgs)),this.parent)i=this._chainOrCall(i,()=>{this.parent.emit(s,e,o)});return i=this._chainOrCallHooks(i,"postAction"),i}if(this.parent&&this.parent.listenerCount(s))a(),this._processArguments(),this.parent.emit(s,e,o);else if(e.length){if(this._findCommand("*"))return this._dispatchSubcommand("*",e,o);if(this.listenerCount("command:*"))this.emit("command:*",e,o);else if(this.commands.length)this.unknownCommand();else a(),this._processArguments()}else if(this.commands.length)a(),this.help({error:!0});else a(),this._processArguments()}_findCommand(e){if(!e)return;return this.commands.find((o)=>o._name===e||o._aliases.includes(e))}_findOption(e){return this.options.find((o)=>o.is(e))}_checkForMissingMandatoryOptions(){this._getCommandAndAncestors().forEach((e)=>{e.options.forEach((o)=>{if(o.mandatory&&e.getOptionValue(o.attributeName())===void 0)e.missingMandatoryOptionValue(o)})})}_checkForConflictingLocalOptions(){let e=this.options.filter((t)=>{let a=t.attributeName();if(this.getOptionValue(a)===void 0)return!1;return this.getOptionValueSource(a)!=="default"});e.filter((t)=>t.conflictsWith.length>0).forEach((t)=>{let a=e.find((s)=>t.conflictsWith.includes(s.attributeName()));if(a)this._conflictingOption(t,a)})}_checkForConflictingOptions(){this._getCommandAndAncestors().forEach((e)=>{e._checkForConflictingLocalOptions()})}parseOptions(e){let o=[],t=[],a=o,s=e.slice();function i(r){return r.length>1&&r[0]==="-"}let n=null;while(s.length){let r=s.shift();if(r==="--"){if(a===t)a.push(r);a.push(...s);break}if(n&&!i(r)){this.emit(`option:${n.name()}`,r);continue}if(n=null,i(r)){let d=this._findOption(r);if(d){if(d.required){let l=s.shift();if(l===void 0)this.optionMissingArgument(d);this.emit(`option:${d.name()}`,l)}else if(d.optional){let l=null;if(s.length>0&&!i(s[0]))l=s.shift();this.emit(`option:${d.name()}`,l)}else this.emit(`option:${d.name()}`);n=d.variadic?d:null;continue}}if(r.length>2&&r[0]==="-"&&r[1]!=="-"){let d=this._findOption(`-${r[1]}`);if(d){if(d.required||d.optional&&this._combineFlagAndOptionalValue)this.emit(`option:${d.name()}`,r.slice(2));else this.emit(`option:${d.name()}`),s.unshift(`-${r.slice(2)}`);continue}}if(/^--[^=]+=/.test(r)){let d=r.indexOf("="),l=this._findOption(r.slice(0,d));if(l&&(l.required||l.optional)){this.emit(`option:${l.name()}`,r.slice(d+1));continue}}if(i(r))a=t;if((this._enablePositionalOptions||this._passThroughOptions)&&o.length===0&&t.length===0){if(this._findCommand(r)){if(o.push(r),s.length>0)t.push(...s);break}else if(this._getHelpCommand()&&r===this._getHelpCommand().name()){if(o.push(r),s.length>0)o.push(...s);break}else if(this._defaultCommandName){if(t.push(r),s.length>0)t.push(...s);break}}if(this._passThroughOptions){if(a.push(r),s.length>0)a.push(...s);break}a.push(r)}return{operands:o,unknown:t}}opts(){if(this._storeOptionsAsProperties){let e={},o=this.options.length;for(let t=0;t<o;t++){let a=this.options[t].attributeName();e[a]=a===this._versionOptionName?this._version:this[a]}return e}return this._optionValues}optsWithGlobals(){return this._getCommandAndAncestors().reduce((e,o)=>Object.assign(e,o.opts()),{})}error(e,o){if(this._outputConfiguration.outputError(`${e}
|
|
18
|
+
`,this._outputConfiguration.writeErr),typeof this._showHelpAfterError==="string")this._outputConfiguration.writeErr(`${this._showHelpAfterError}
|
|
19
|
+
`);else if(this._showHelpAfterError)this._outputConfiguration.writeErr(`
|
|
20
|
+
`),this.outputHelp({error:!0});let t=o||{},a=t.exitCode||1,s=t.code||"commander.error";this._exit(a,s,e)}_parseOptionsEnv(){this.options.forEach((e)=>{if(e.envVar&&e.envVar in T.env){let o=e.attributeName();if(this.getOptionValue(o)===void 0||["default","config","env"].includes(this.getOptionValueSource(o)))if(e.required||e.optional)this.emit(`optionEnv:${e.name()}`,T.env[e.envVar]);else this.emit(`optionEnv:${e.name()}`)}})}_parseOptionsImplied(){let e=new Pt(this.options),o=(t)=>{return this.getOptionValue(t)!==void 0&&!["default","implied"].includes(this.getOptionValueSource(t))};this.options.filter((t)=>t.implied!==void 0&&o(t.attributeName())&&e.valueFromOption(this.getOptionValue(t.attributeName()),t)).forEach((t)=>{Object.keys(t.implied).filter((a)=>!o(a)).forEach((a)=>{this.setOptionValueWithSource(a,t.implied[a],"implied")})})}missingArgument(e){let o=`error: missing required argument '${e}'`;this.error(o,{code:"commander.missingArgument"})}optionMissingArgument(e){let o=`error: option '${e.flags}' argument missing`;this.error(o,{code:"commander.optionMissingArgument"})}missingMandatoryOptionValue(e){let o=`error: required option '${e.flags}' not specified`;this.error(o,{code:"commander.missingMandatoryOptionValue"})}_conflictingOption(e,o){let t=(i)=>{let n=i.attributeName(),r=this.getOptionValue(n),d=this.options.find((_)=>_.negate&&n===_.attributeName()),l=this.options.find((_)=>!_.negate&&n===_.attributeName());if(d&&(d.presetArg===void 0&&r===!1||d.presetArg!==void 0&&r===d.presetArg))return d;return l||i},a=(i)=>{let n=t(i),r=n.attributeName();if(this.getOptionValueSource(r)==="env")return`environment variable '${n.envVar}'`;return`option '${n.flags}'`},s=`error: ${a(e)} cannot be used with ${a(o)}`;this.error(s,{code:"commander.conflictingOption"})}unknownOption(e){if(this._allowUnknownOption)return;let o="";if(e.startsWith("--")&&this._showSuggestionAfterError){let a=[],s=this;do{let i=s.createHelp().visibleOptions(s).filter((n)=>n.long).map((n)=>n.long);a=a.concat(i),s=s.parent}while(s&&!s._enablePositionalOptions);o=Ue(e,a)}let t=`error: unknown option '${e}'${o}`;this.error(t,{code:"commander.unknownOption"})}_excessArguments(e){if(this._allowExcessArguments)return;let o=this.registeredArguments.length,t=o===1?"":"s",s=`error: too many arguments${this.parent?` for '${this.name()}'`:""}. Expected ${o} argument${t} but got ${e.length}.`;this.error(s,{code:"commander.excessArguments"})}unknownCommand(){let e=this.args[0],o="";if(this._showSuggestionAfterError){let a=[];this.createHelp().visibleCommands(this).forEach((s)=>{if(a.push(s.name()),s.alias())a.push(s.alias())}),o=Ue(e,a)}let t=`error: unknown command '${e}'${o}`;this.error(t,{code:"commander.unknownCommand"})}version(e,o,t){if(e===void 0)return this._version;this._version=e,o=o||"-V, --version",t=t||"output the version number";let a=this.createOption(o,t);return this._versionOptionName=a.attributeName(),this._registerOption(a),this.on("option:"+a.name(),()=>{this._outputConfiguration.writeOut(`${e}
|
|
21
|
+
`),this._exit(0,"commander.version",e)}),this}description(e,o){if(e===void 0&&o===void 0)return this._description;if(this._description=e,o)this._argsDescription=o;return this}summary(e){if(e===void 0)return this._summary;return this._summary=e,this}alias(e){if(e===void 0)return this._aliases[0];let o=this;if(this.commands.length!==0&&this.commands[this.commands.length-1]._executableHandler)o=this.commands[this.commands.length-1];if(e===o._name)throw Error("Command alias can't be the same as its name");let t=this.parent?._findCommand(e);if(t){let a=[t.name()].concat(t.aliases()).join("|");throw Error(`cannot add alias '${e}' to command '${this.name()}' as already have command '${a}'`)}return o._aliases.push(e),this}aliases(e){if(e===void 0)return this._aliases;return e.forEach((o)=>this.alias(o)),this}usage(e){if(e===void 0){if(this._usage)return this._usage;let o=this.registeredArguments.map((t)=>{return Gt(t)});return[].concat(this.options.length||this._helpOption!==null?"[options]":[],this.commands.length?"[command]":[],this.registeredArguments.length?o:[]).join(" ")}return this._usage=e,this}name(e){if(e===void 0)return this._name;return this._name=e,this}nameFromFilename(e){return this._name=D.basename(e,D.extname(e)),this}executableDir(e){if(e===void 0)return this._executableDir;return this._executableDir=e,this}helpInformation(e){let o=this.createHelp();if(o.helpWidth===void 0)o.helpWidth=e&&e.error?this._outputConfiguration.getErrHelpWidth():this._outputConfiguration.getOutHelpWidth();return o.formatHelp(this,o)}_getHelpContext(e){e=e||{};let o={error:!!e.error},t;if(o.error)t=(a)=>this._outputConfiguration.writeErr(a);else t=(a)=>this._outputConfiguration.writeOut(a);return o.write=e.write||t,o.command=this,o}outputHelp(e){let o;if(typeof e==="function")o=e,e=void 0;let t=this._getHelpContext(e);this._getCommandAndAncestors().reverse().forEach((s)=>s.emit("beforeAllHelp",t)),this.emit("beforeHelp",t);let a=this.helpInformation(t);if(o){if(a=o(a),typeof a!=="string"&&!Buffer.isBuffer(a))throw Error("outputHelp callback must return a string or a Buffer")}if(t.write(a),this._getHelpOption()?.long)this.emit(this._getHelpOption().long);this.emit("afterHelp",t),this._getCommandAndAncestors().forEach((s)=>s.emit("afterAllHelp",t))}helpOption(e,o){if(typeof e==="boolean"){if(e)this._helpOption=this._helpOption??void 0;else this._helpOption=null;return this}return e=e??"-h, --help",o=o??"display help for command",this._helpOption=this.createOption(e,o),this}_getHelpOption(){if(this._helpOption===void 0)this.helpOption(void 0,void 0);return this._helpOption}addHelpOption(e){return this._helpOption=e,this}help(e){this.outputHelp(e);let o=T.exitCode||0;if(o===0&&e&&typeof e!=="function"&&e.error)o=1;this._exit(o,"commander.help","(outputHelp)")}addHelpText(e,o){let t=["beforeAll","before","after","afterAll"];if(!t.includes(e))throw Error(`Unexpected value for position to addHelpText.
|
|
22
|
+
Expecting one of '${t.join("', '")}'`);let a=`${e}Help`;return this.on(a,(s)=>{let i;if(typeof o==="function")i=o({error:s.error,command:s.command});else i=o;if(i)s.write(`${i}
|
|
23
|
+
`)}),this}_outputHelpIfRequested(e){let o=this._getHelpOption();if(o&&e.find((a)=>o.is(a)))this.outputHelp(),this._exit(0,"commander.helpDisplayed","(outputHelp)")}}function Pe(e){return e.map((o)=>{if(!o.startsWith("--inspect"))return o;let t,a="127.0.0.1",s="9229",i;if((i=o.match(/^(--inspect(-brk)?)$/))!==null)t=i[1];else if((i=o.match(/^(--inspect(-brk|-port)?)=([^:]+)$/))!==null)if(t=i[1],/^\d+$/.test(i[3]))s=i[3];else a=i[3];else if((i=o.match(/^(--inspect(-brk|-port)?)=([^:]+):(\d+)$/))!==null)t=i[1],a=i[3],s=i[4];if(t&&s!=="0")return`${t}=${a}:${parseInt(s)+1}`;return o})}Dt.Command=he});var ze=O((zt)=>{var{Argument:xe}=$(),{Command:ge}=De(),{CommanderError:Rt,InvalidArgumentError:Re}=C(),{Help:Et}=ne(),{Option:Ee}=de();zt.program=new ge;zt.createCommand=(e)=>new ge(e);zt.createOption=(e,o)=>new Ee(e,o);zt.createArgument=(e,o)=>new xe(e,o);zt.Command=ge;zt.Option=Ee;zt.Argument=xe;zt.Help=Et;zt.CommanderError=Rt;zt.InvalidArgumentError=Re;zt.InvalidOptionArgumentError=Re});var Be=at(ze(),1),{program:_s,createCommand:ys,createArgument:ks,createOption:ws,CommanderError:bs,InvalidArgumentError:Ts,InvalidOptionArgumentError:Is,Command:N,Argument:Ss,Option:Oe,Help:Ls}=Be.default;var c=Object.freeze({NONE:"none",PATH:"path",TEXT:"text"});class p{short;long;valueKind;numericShorthand;description;defaultValue;required;constructor(e={}){this.short=e.short??null,this.long=e.long??null,this.valueKind=e.valueKind??c.NONE,this.numericShorthand=e.numericShorthand??!1,this.description=e.description??null,this.defaultValue=e.defaultValue??null,this.required=e.required??!1,Object.freeze(this)}get name(){return this.long??this.short??""}}class q{kind;name;variadic;required;constructor(e={}){this.kind=e.kind??c.PATH,this.name=e.name??"arg",this.variadic=e.variadic??!1,this.required=e.required??!0,Object.freeze(this)}}class h{options;positional;rest;ignoreTokens;description;constructor(e={}){this.options=Object.freeze([...e.options??[]]),this.positional=Object.freeze([...e.positional??[]]),this.rest=e.rest??null,this.ignoreTokens=new Set(e.ignoreTokens??[]),this.description=e.description??null,Object.freeze(this)}}class qe{flags;args;cachePaths;pathFlagValues;constructor(e){this.flags=e.flags,this.args=e.args,this.cachePaths=e.cachePaths??[],this.pathFlagValues=e.pathFlagValues??[]}paths(){return this.args.filter(([,e])=>e===c.PATH).map(([e])=>e)}routingPaths(){return[...this.paths(),...this.pathFlagValues]}texts(){return this.args.filter(([,e])=>e===c.TEXT).map(([e])=>e)}flag(e,o=null){return this.flags[e]??o}}class L{stdout;stderr;exitCode;reads;writes;cache;streamSource;constructor(e={}){this.stdout=Ye(e.stdout??null),this.stderr=Ye(e.stderr??null),this.exitCode=e.exitCode??0,this.reads=e.reads??{},this.writes=e.writes??{},this.cache=e.cache??[],this.streamSource=null}}function Ye(e){if(e===null||e===void 0)return null;if(e instanceof Uint8Array)return e;if(typeof e==="string")return new TextEncoder().encode(e);return null}function g(e){return Object.freeze({name:e.name,resource:e.resource??null,spec:e.spec,fn:e.fn,description:e.description??e.spec.description??null})}function A(e){return Object.freeze({name:e.name,description:e.description??null,commands:Object.freeze([...e.commands??[]]),groups:Object.freeze([...e.groups??[]])})}var Wt=new TextDecoder;async function Jt(e,o={}){let t=Array.isArray(o)?Me(e.spec,o):o,a={flags:t.flags??{},stdin:t.stdin??null},s=await e.fn({},t.paths??[],t.texts??[],a),[i,n]=jt(s),r=await Fe(i??n.stdout);return{bytes:r,text:Wt.decode(r),result:n}}function jt(e){if(!e)return[null,new L];return e}async function Fe(e){if(e===null)return new Uint8Array;if(e instanceof Uint8Array)return e;let o=[];for await(let i of e)o.push(i);let t=0;for(let i of o)t+=i.byteLength;let a=new Uint8Array(t),s=0;for(let i of o)a.set(i,s),s+=i.byteLength;return a}function Me(e,o){let t={},a=[];for(let r of e.options)if(r.defaultValue!==null&&r.defaultValue!==void 0)t[r.name]=r.defaultValue;else if(r.valueKind===c.NONE)t[r.name]=!1;let s=0;while(s<o.length){let r=o[s]??"";if(r==="--"){a.push(...o.slice(s+1));break}let d=$t(e,r);if(d){s+=Qt(d,r,o,s,t);continue}a.push(r),s+=1}let{paths:i,texts:n}=Vt(e,a);return{paths:i,texts:n,flags:t}}function $t(e,o){if(o.startsWith("--")){let t=o.slice(2).split("=")[0];return e.options.find((a)=>a.long===t)}if(o.startsWith("-")&&o.length>1){let t=o[1];return e.options.find((a)=>a.short===t)}return}function Qt(e,o,t,a,s){if(e.valueKind===c.NONE)return s[e.name]=!0,1;if(o.includes("="))return s[e.name]=o.slice(o.indexOf("=")+1),1;return s[e.name]=t[a+1]??"",2}function Vt(e,o){let t=[],a=[],s=0;for(let i of e.positional){if(s>=o.length)break;if(i.variadic){Q(i.kind,o.slice(s),t,a),s=o.length;break}Q(i.kind,[o[s]],t,a),s+=1}if(s<o.length&&e.rest)Q(e.rest.kind,o.slice(s),t,a);return{paths:t,texts:a}}function Q(e,o,t,a){if(e===c.PATH)t.push(...o);else if(e===c.TEXT)a.push(...o)}function x(e){let o=new N(e.name);if(e.description)o.description(e.description);return Zt(o,e.spec),o.action(async(...t)=>{let a=t[t.length-1],s=t[t.length-2],i=t.slice(0,-2),{paths:n,texts:r,flags:d}=ta(e.spec,i,s),l=await e.fn({},n,r,{flags:d}),[_,b]=l??[null,new L],U=await Fe(_??b.stdout);if(U.byteLength>0)process.stdout.write(U);if(b.stderr)process.stderr.write(b.stderr);if(b.exitCode!==0)process.exit(b.exitCode)}),o}function P(e,o){let t=new N(o.name);if(o.description)t.description(o.description);for(let a of o.groups)P(t,a);for(let a of o.commands)t.addCommand(x(a));return e.addCommand(t),t}function Zt(e,o){for(let t of o.positional){let a=t.variadic?`<${t.name}...>`:t.required?`<${t.name}>`:`[${t.name}]`;e.argument(a)}if(o.rest)e.argument(`[${o.rest.name}...]`);for(let t of o.options)e.addOption(ea(t))}function ea(e){let o=new Oe(oa(e),e.description??void 0);if(e.defaultValue!==null)o.default(e.defaultValue);if(e.required)o.makeOptionMandatory(!0);return o}function oa(e){let o=[];if(e.short)o.push(`-${e.short}`);if(e.long)o.push(`--${e.long}`);let t=o.join(", ");if(e.valueKind!==c.NONE)t+=` <${e.long??e.short}>`;return t}function ta(e,o,t){let a=[],s=[];e.positional.forEach((n,r)=>{let d=o[r];if(d===void 0||d===null)return;let l=Array.isArray(d)?d:[String(d)];Q(n.kind,l,a,s)});let i={};for(let n of e.options){let r=aa(n.long??n.short??"");if(r in t){let d=t[r];if(typeof d==="string"||typeof d==="boolean")i[n.name]=d}}return{paths:a,texts:s,flags:i}}function aa(e){return e.replace(/-([a-z])/g,(o,t)=>t.toUpperCase())}function sa(e,o={}){return[typeof e==="string"?new TextEncoder().encode(e):e,new L({exitCode:o.exitCode??0,stderr:o.stderr??null})]}import{existsSync as ia,mkdirSync as ra,readFileSync as na,writeFileSync as da,chmodSync as ca}from"node:fs";import{homedir as la}from"node:os";import{dirname as pa,join as ha}from"node:path";var Y=ha(la(),".config","dataforseo","config.json");function Ke(){return Y}function H(){let e=ga();if(e)return e;if(ia(Y)){let o=na(Y,"utf8"),t=JSON.parse(o);if(t.login&&t.password)return{login:t.login,password:t.password}}throw Error(`No DataForSEO credentials found.
|
|
24
|
+
Either set DATAFORSEO_LOGIN and DATAFORSEO_PASSWORD env vars, or run: dfs login --login <email> --password <api_password>`)}function Ce(e){return ra(pa(Y),{recursive:!0}),da(Y,JSON.stringify(e,null,2)),ca(Y,384),Y}function me({login:e,password:o}){return"Basic "+Buffer.from(`${e}:${o}`).toString("base64")}function ga(){let e=process.env.DATAFORSEO_LOGIN,o=process.env.DATAFORSEO_PASSWORD;if(e&&o)return{login:e,password:o};return null}var ma="https://api.dataforseo.com";async function v(e,o,t={}){let a=H(),s=Ne(e,t.baseUrl),i=fa(o,t.wrapAsTaskArray??!0),n=new AbortController,r=setTimeout(()=>n.abort(),t.timeoutMs??120000),d;try{d=await fetch(s,{method:"POST",headers:{Authorization:me(a),"Content-Type":"application/json","User-Agent":"dataforseo-cli/0.1.0"},body:i===void 0?void 0:JSON.stringify(i),signal:n.signal})}finally{clearTimeout(r)}let l=await d.text(),_;try{_=l?JSON.parse(l):{}}catch{throw Error(`HTTP ${d.status}: non-JSON response: ${l.slice(0,500)}`)}if(!d.ok){let b=_.status_message??`HTTP ${d.status}`;throw Error(`DataForSEO error: ${b}`)}return _}async function R(e,o={}){let t=H(),a=Ne(e,o.baseUrl),s=new AbortController,i=setTimeout(()=>s.abort(),o.timeoutMs??60000),n;try{n=await fetch(a,{method:"GET",headers:{Authorization:me(t),"User-Agent":"dataforseo-cli/0.1.0"},signal:s.signal})}finally{clearTimeout(i)}let r=await n.text(),d=r?JSON.parse(r):{};if(!n.ok)throw Error(`DataForSEO error: ${d.status_message??`HTTP ${n.status}`}`);return d}function Ne(e,o){let t=e.trim();if(!t.startsWith("/"))t="/"+t;if(!t.startsWith("/v3/"))t="/v3"+t;return(o??ma)+t}function fa(e,o){if(e===void 0||e===null)return;if(Array.isArray(e))return e;if(o&&typeof e==="object")return[e];return e}function He(e){let o=e.tasks??[],t=[];for(let a of o){let s=a.result;if(!Array.isArray(s))continue;for(let i of s)if(i&&typeof i==="object"&&Array.isArray(i.items))t.push(...i.items);else t.push(i)}return t}function Je(e,o){if(o.format==="raw")return JSON.stringify(e,null,2);let t=o.full?e:He(e);switch(o.format){case"json":return JSON.stringify(t,null,2);case"ndjson":return Array.isArray(t)?t.map((a)=>JSON.stringify(a)).join(`
|
|
25
|
+
`):JSON.stringify(t);case"table":return ua(Xe(t),o.columns);case"csv":return va(Xe(t),o.columns)}}function Xe(e){if(Array.isArray(e))return e.filter((o)=>o!==null&&typeof o==="object"&&!Array.isArray(o));if(e&&typeof e==="object")return[e];return[]}function ua(e,o){if(e.length===0)return"(no rows)";let t=o??je(e),a=t.map((i)=>Math.max(i.length,...e.map((n)=>fe(n[i]).length))),s=[];s.push(t.map((i,n)=>i.padEnd(a[n]??i.length)).join(" ")),s.push(a.map((i)=>"-".repeat(i)).join(" "));for(let i of e)s.push(t.map((n,r)=>fe(i[n]).padEnd(a[r]??0)).join(" "));return s.join(`
|
|
26
|
+
`)}function va(e,o){if(e.length===0)return"";let t=o??je(e),a=[t.map(We).join(",")];for(let s of e)a.push(t.map((i)=>We(fe(s[i]))).join(","));return a.join(`
|
|
27
|
+
`)}function je(e){let o=new Set;for(let t of e)for(let a of Object.keys(t))o.add(a);return[...o]}function fe(e){if(e===null||e===void 0)return"";if(typeof e==="string")return e;if(typeof e==="number"||typeof e==="boolean")return String(e);return JSON.stringify(e)}function We(e){if(/[",\n\r]/.test(e))return`"${e.replace(/"/g,'""')}"`;return e}var _a=new TextEncoder,m=Object.freeze([new p({short:"o",long:"output",valueKind:c.TEXT,description:"Output format: json|ndjson|table|csv|raw (default json).",defaultValue:"json"}),new p({long:"columns",valueKind:c.TEXT,description:"Comma-separated columns for table/csv output."}),new p({long:"full",valueKind:c.NONE,description:"Emit the full response (skip the items extraction)."}),new p({long:"no-cost",valueKind:c.NONE,description:"Don't print the response cost on stderr."})]);function f(e,o){let t=o.flags??{},a=t.output??"json",s=t.full===!0,i=t["no-cost"]===!0,n=t.columns,r=typeof n==="string"?n.split(",").map((b)=>b.trim()).filter(Boolean):void 0,d=Je(e,{format:a,full:s,columns:r}),l=_a.encode(d.endsWith(`
|
|
28
|
+
`)?d:d+`
|
|
29
|
+
`),_=!i&&typeof e.cost==="number"&&e.cost>0?`[cost] $${e.cost.toFixed(4)}
|
|
30
|
+
`:null;return[l,new L({exitCode:0,stderr:_})]}var w=Object.freeze([new p({long:"location",valueKind:c.TEXT,description:'Location name (default "United States").',defaultValue:"United States"}),new p({long:"location-code",valueKind:c.TEXT,description:"Location code, overrides --location."}),new p({long:"language",valueKind:c.TEXT,description:'Language name (default "English").',defaultValue:"English"}),new p({long:"language-code",valueKind:c.TEXT,description:"Language code, overrides --language."})]);function k(e){let o=e.flags??{},t={},a=o["location-code"];if(typeof a==="string"&&a)t.locationCode=Number(a);else t.locationName=o.location??"United States";let s=o["language-code"];if(typeof s==="string"&&s)t.languageCode=s;else t.languageName=o.language??"English";return t}function u(e,o={}){return new q({kind:c.TEXT,name:e,...o})}function y(e,o,t){let a=e.flags?.[o];return typeof a==="string"?a:t??""}function G(e,o){return e.flags?.[o]===!0}function I(e,o,t){let a=e.flags?.[o];if(typeof a==="string"&&a)return Number(a);return t}function X(e){let o={};if(e.locationCode!==void 0)o.location_code=e.locationCode;else o.location_name=e.locationName??"United States";if(e.languageCode!==void 0)o.language_code=e.languageCode;else o.language_name=e.languageName??"English";return o}var ya={chatgpt:"ai_optimization/chat_gpt/llm_responses/live",claude:"ai_optimization/claude/llm_responses/live",gemini:"ai_optimization/gemini/llm_responses/live",perplexity:"ai_optimization/perplexity/llm_responses/live"};async function $e(e){return v("ai_optimization/ai_keyword_data/keywords_search_volume/live",{...X(e),keywords:e.keywords})}async function Qe(e){return v("ai_optimization/llm_mentions/search/live",{...X(e),target:e.keywords.map((o)=>({keyword:o}))})}async function Ve(e){return v("ai_optimization/llm_mentions/top_pages/live",{...X(e),target:e.keywords.map((o)=>({keyword:o}))})}async function Ze(e){return v("ai_optimization/llm_mentions/top_domains/live",{...X(e),target:e.keywords.map((o)=>({keyword:o}))})}async function eo(e){return v("ai_optimization/llm_mentions/aggregated_metrics/live",{...X(e),target:e.keywords.map((o)=>({keyword:o}))})}async function oo(e){return v(ya[e.model],{system_message:e.systemMessage,message_chain:[{role:"user",message:e.message}],max_output_tokens:e.maxOutputTokens??512,temperature:e.temperature??0.3,top_p:e.topP??0.5})}var F="ram",ka=g({name:"search-volume",resource:F,spec:new h({description:"AI-tool search volume — how often a keyword is typed at LLMs.",positional:[u("keywords",{variadic:!0})],options:[...w,...m]}),fn:async(e,o,t,a)=>{let s=await $e({...k(a),keywords:[...t]});return f(s,a)}}),wa=g({name:"mentions",resource:F,spec:new h({description:"Search LLM mentions for one or more keyword targets.",positional:[u("keywords",{variadic:!0})],options:[...w,...m]}),fn:async(e,o,t,a)=>{let s=await Qe({...k(a),keywords:[...t]});return f(s,a)}}),ba=g({name:"top-pages",resource:F,spec:new h({description:"Top pages cited by AI for the given keyword targets.",positional:[u("keywords",{variadic:!0})],options:[...w,...m]}),fn:async(e,o,t,a)=>{let s=await Ve({...k(a),keywords:[...t]});return f(s,a)}}),Ta=g({name:"top-domains",resource:F,spec:new h({description:"Top domains cited by AI for the given keyword targets.",positional:[u("keywords",{variadic:!0})],options:[...w,...m]}),fn:async(e,o,t,a)=>{let s=await Ze({...k(a),keywords:[...t]});return f(s,a)}}),Ia=g({name:"metrics",resource:F,spec:new h({description:"Aggregated LLM mention metrics (volume, sentiment) for keyword targets.",positional:[u("keywords",{variadic:!0})],options:[...w,...m]}),fn:async(e,o,t,a)=>{let s=await eo({...k(a),keywords:[...t]});return f(s,a)}}),Sa=g({name:"ask",resource:F,spec:new h({description:"Ask a specific LLM via DataForSEO's metered proxy.",positional:[u("message")],options:[new p({long:"model",valueKind:c.TEXT,description:"chatgpt | claude | gemini | perplexity.",defaultValue:"chatgpt"}),new p({long:"system",valueKind:c.TEXT,description:"Optional system message."}),new p({long:"max-tokens",valueKind:c.TEXT,description:"Max output tokens (default 512).",defaultValue:"512"}),new p({long:"temperature",valueKind:c.TEXT,description:"Sampling temperature (default 0.3).",defaultValue:"0.3"}),...m]}),fn:async(e,o,t,a)=>{let s=y(a,"model","chatgpt"),i=y(a,"system")||void 0,n=await oo({model:s,message:t[0]??"",systemMessage:i,maxOutputTokens:I(a,"max-tokens",512),temperature:Number(y(a,"temperature","0.3"))});return f(n,a)}}),to=A({name:"ai",description:"AI Optimization: LLM mentions, top pages/domains, AI search volume, LLM proxy.",commands:[ka,wa,ba,Ta,Ia,Sa]});async function ao(e){return v("backlinks/summary/live",{target:e})}async function so(e){return v("backlinks/backlinks/live",{target:e.target,limit:e.limit??100,mode:e.mode??"as_is"})}async function io(e){return v("backlinks/referring_domains/live",{target:e.target,limit:e.limit??100})}async function ro(e){return v("backlinks/anchors/live",{target:e.target,limit:e.limit??100})}async function no(e){return v("backlinks/competitors/live",{target:e.target,limit:e.limit??100})}async function co(e){return v("backlinks/bulk_ranks/live",{targets:e})}var M="ram",V=new p({long:"limit",valueKind:c.TEXT,description:"Max results.",defaultValue:"100"}),La=g({name:"summary",resource:M,spec:new h({description:"High-level backlink summary for a target.",positional:[u("target")],options:[...m]}),fn:async(e,o,t,a)=>{let s=await ao(t[0]??"");return f(s,a)}}),Aa=g({name:"list",resource:M,spec:new h({description:"List individual backlinks.",positional:[u("target")],options:[V,new p({long:"mode",valueKind:c.TEXT,description:"as_is | one_per_domain | one_per_anchor.",defaultValue:"as_is"}),...m]}),fn:async(e,o,t,a)=>{let s=await so({target:t[0]??"",limit:I(a,"limit",100),mode:y(a,"mode","as_is")});return f(s,a)}}),Ga=g({name:"referring-domains",resource:M,spec:new h({description:"Referring domains pointing to a target.",positional:[u("target")],options:[V,...m]}),fn:async(e,o,t,a)=>{let s=await io({target:t[0]??"",limit:I(a,"limit",100)});return f(s,a)}}),Ua=g({name:"anchors",resource:M,spec:new h({description:"Anchor text distribution for a target.",positional:[u("target")],options:[V,...m]}),fn:async(e,o,t,a)=>{let s=await ro({target:t[0]??"",limit:I(a,"limit",100)});return f(s,a)}}),Pa=g({name:"competitors",resource:M,spec:new h({description:"Domains with similar backlink profiles.",positional:[u("target")],options:[V,...m]}),fn:async(e,o,t,a)=>{let s=await no({target:t[0]??"",limit:I(a,"limit",100)});return f(s,a)}}),Da=g({name:"ranks",resource:M,spec:new h({description:"Bulk DataForSEO domain rank for up to 1000 targets.",positional:[u("targets",{variadic:!0})],options:[...m]}),fn:async(e,o,t,a)=>{let s=await co([...t]);return f(s,a)}}),lo=A({name:"backlinks",description:"Backlink profiles, referring domains, anchors.",commands:[La,Aa,Ga,Ua,Pa,Da]});var po=[{path:"/v3/serp/id_list",method:"post",operationId:"IdList",tag:"Serp",description:`This endpoint is designed to provide you with a list of IDs and metadata for all SERP tasks created within the specified time period, including both successful and uncompleted tasks.
|
|
31
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/id_list/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/id_list/",example:[{datetime_from:"2026-04-12 04:39:39 +00:00",datetime_to:"2026-04-14 04:39:39 +00:00",limit:100,offset:0,sort:"desc",include_metadata:!0}]},{path:"/v3/serp/errors",method:"post",operationId:"Errors",tag:"Serp",description:`By calling this endpoint you will receive information about the SERP API tasks that returned an error within the past 7 days.
|
|
32
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/errors/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/errors/",example:[{limit:10,offset:0,filtered_function:"pingback_url"}]},{path:"/v3/serp/screenshot",method:"post",operationId:"Screenshot",tag:"Serp",description:`Using the Live Page Screenshot endpoint, you can capture a screenshot of any SERP page.
|
|
33
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/screenshot/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/screenshot/",example:[{task_id:"06211235-0696-0139-1000-36727fbd3c90",browser_screen_scale_factor:0.5}]},{path:"/v3/serp/ai_summary",method:"post",operationId:"AiSummary",tag:"Serp",description:`The purpose of the Live SERP API AI Summary endpoint is to provide a summary of the content found on any SERP and generate a response based on the user’s specified prompt.
|
|
34
|
+
To obtain results, you have to specify task_id, which you can find in the response to the POST request.
|
|
35
|
+
Learn more in our Help Center.
|
|
36
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/ai_summary/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/ai_summary/",example:[{task_id:"07031739-1535-0139-0000-9d1e639a5b7d",prompt:"explain what DataForSEO is",include_links:!0,fetch_content:!0}]},{path:"/v3/serp/google/locations",method:"get",operationId:"GoogleLocations",tag:"Serp",description:`You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
|
|
37
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/locations/"},{path:"/v3/serp/google/locations/{country}",method:"get",operationId:"GoogleLocationsCountry",tag:"Serp",description:`You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
|
|
38
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/locations/"},{path:"/v3/serp/google/languages",method:"get",operationId:"GoogleLanguages",tag:"Serp",description:`You will receive the list of languages by calling this API.
|
|
39
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/languages/"},{path:"/v3/serp/google/organic/task_post",method:"post",operationId:"GoogleOrganicTaskPost",tag:"Serp",description:`SERP API provides top 10 search engine results by default. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
|
|
40
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/organic/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/organic/task_post/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein"},{language_name:"English",location_name:"United States",keyword:"albert einstein",priority:2,tag:"some_string_123",pingback_url:"https://your-server.com/pingscript?id=$id&tag=$tag"},{url:"https://www.google.co.uk/search?q=albert%20einstein&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS",postback_data:"html",postback_url:"https://your-server.com/postbackscript"}]},{path:"/v3/serp/google/organic/tasks_ready",method:"get",operationId:"GoogleOrganicTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
41
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
42
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/organic/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/organic/tasks_ready/"},{path:"/v3/serp/tasks_ready",method:"get",operationId:"TasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
43
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
44
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/organic/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/organic/tasks_ready/"},{path:"/v3/serp/google/organic/tasks_fixed",method:"get",operationId:"GoogleOrganicTasksFixed",tag:"Serp",description:`The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.
|
|
45
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/organic/tasks_fixed/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/organic/tasks_fixed/"},{path:"/v3/serp/google/organic/task_get/regular/{id}",method:"get",operationId:"GoogleOrganicTaskGetRegular",tag:"Serp",description:`Description of the fields for sending a request:
|
|
46
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/organic/task_get/regular/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/organic/task_get/regular/"},{path:"/v3/serp/google/organic/task_get/advanced/{id}",method:"get",operationId:"GoogleOrganicTaskGetAdvanced",tag:"Serp",description:`Description of the fields for sending a request:
|
|
47
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/organic/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/organic/task_get/advanced/"},{path:"/v3/serp/google/organic/task_get/html/{id}",method:"get",operationId:"GoogleOrganicTaskGetHtml",tag:"Serp",description:`Description of the fields for sending a request:
|
|
48
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/organic/task_get/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/organic/task_get/html/"},{path:"/v3/serp/google/organic/live/regular",method:"post",operationId:"GoogleOrganicLiveRegular",tag:"Serp",description:`Live SERP provides real-time data on search engine results for the specified keyword, search engine, and location.
|
|
49
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/organic/live/regular/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/organic/live/regular/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein"}]},{path:"/v3/serp/google/organic/live/advanced",method:"post",operationId:"GoogleOrganicLiveAdvanced",tag:"Serp",description:`Live SERP provides real-time data on top search engine results for the specified keyword, search engine, and location. This endpoint will supply a complete overview of featured snippets and other extra elements of SERPs.
|
|
50
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/organic/live/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/organic/live/advanced/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein",calculate_rectangles:!0}]},{path:"/v3/serp/google/organic/live/html",method:"post",operationId:"GoogleOrganicLiveHtml",tag:"Serp",description:`Live SERP HTML provides a raw HTML page of search engine results for the specified keyword, search engine, and location.
|
|
51
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/organic/live/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/organic/live/html/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein"}]},{path:"/v3/serp/google/ai_mode/languages",method:"get",operationId:"GoogleAiModeLanguages",tag:"Serp",description:`You will receive the list of languages by calling this API.
|
|
52
|
+
|
|
53
|
+
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
|
|
54
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/ai_mode/languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/ai_mode/languages/"},{path:"/v3/serp/google/ai_mode/task_post",method:"post",operationId:"GoogleAiModeTaskPost",tag:"Serp",description:`Google AI Mode SERP API provides search results from the AI Mode feature of Google Search.
|
|
55
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/ai_mode/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/ai_mode/task_post/",example:[{language_code:"en",location_code:2840,keyword:"what is google ai mode"}]},{path:"/v3/serp/google/ai_mode/tasks_ready",method:"get",operationId:"GoogleAiModeTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
56
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
57
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/ai_mode/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/ai_mode/tasks_ready/"},{path:"/v3/serp/google/ai_mode/tasks_fixed",method:"get",operationId:"GoogleAiModeTasksFixed",tag:"Serp",description:`The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.
|
|
58
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/ai_mode/tasks_fixed/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/ai_mode/tasks_fixed/"},{path:"/v3/serp/google/ai_mode/task_get/advanced/{id}",method:"get",operationId:"GoogleAiModeTaskGetAdvanced",tag:"Serp",description:`Description of the fields for sending a request:
|
|
59
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/ai_mode/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/ai_mode/task_get/advanced/"},{path:"/v3/serp/google/ai_mode/task_get/html/{id}",method:"get",operationId:"GoogleAiModeTaskGetHtml",tag:"Serp",description:`Description of the fields for sending a request:
|
|
60
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/ai_mode/task_get/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/ai_mode/task_get/html/"},{path:"/v3/serp/google/ai_mode/live/advanced",method:"post",operationId:"GoogleAiModeLiveAdvanced",tag:"Serp",description:`Google AI Mode SERP API provides search results from the AI Mode feature of Google Search.
|
|
61
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/ai_mode/live/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/ai_mode/live/advanced/",example:[{language_code:"en",location_code:2840,keyword:"what is google ai mode"}]},{path:"/v3/serp/google/ai_mode/live/html",method:"post",operationId:"GoogleAiModeLiveHtml",tag:"Serp",description:`Live SERP HTML provides a raw HTML page of 100 search engine results for the specified keyword, search engine, and location.
|
|
62
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/ai_mode/live/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/ai_mode/live/html/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein"}]},{path:"/v3/serp/google/maps/task_post",method:"post",operationId:"GoogleMapsTaskPost",tag:"Serp",description:`SERP API provides top 100 search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
|
|
63
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/maps/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/maps/task_post/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein"}]},{path:"/v3/serp/google/maps/tasks_ready",method:"get",operationId:"GoogleMapsTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
64
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
65
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/maps/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/maps/tasks_ready/"},{path:"/v3/serp/google/maps/tasks_fixed",method:"get",operationId:"GoogleMapsTasksFixed",tag:"Serp",description:`The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.
|
|
66
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/maps/tasks_fixed/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/maps/tasks_fixed/"},{path:"/v3/serp/google/maps/task_get/advanced/{id}",method:"get",operationId:"GoogleMapsTaskGetAdvanced",tag:"Serp",description:`Description of the fields for sending a request:
|
|
67
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/maps/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/maps/task_get/advanced/"},{path:"/v3/serp/google/maps/live/advanced",method:"post",operationId:"GoogleMapsLiveAdvanced",tag:"Serp",description:`Live Google Maps SERP provides real-time data on top 100 search engine results for the specified keyword, search engine, and location.
|
|
68
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/maps/live/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/maps/live/advanced/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein"}]},{path:"/v3/serp/google/local_finder/task_post",method:"post",operationId:"GoogleLocalFinderTaskPost",tag:"Serp",description:`Google Local Finder SERP API provides top search engine results specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
|
|
69
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/local_finder/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/local_finder/task_post/",example:[{language_code:"en",location_code:2840,keyword:"local nail services",min_rating:4.5,time_filter:"monday"}]},{path:"/v3/serp/google/local_finder/tasks_ready",method:"get",operationId:"GoogleLocalFinderTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
70
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
71
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/local_finder/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/local_finder/tasks_ready/"},{path:"/v3/serp/google/local_finder/tasks_fixed",method:"get",operationId:"GoogleLocalFinderTasksFixed",tag:"Serp",description:`The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.
|
|
72
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/local_finder/tasks_fixed/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/local_finder/tasks_fixed/"},{path:"/v3/serp/google/local_finder/task_get/advanced/{id}",method:"get",operationId:"GoogleLocalFinderTaskGetAdvanced",tag:"Serp",description:`Description of the fields for sending a request:
|
|
73
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/local_finder/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/local_finder/task_get/advanced/"},{path:"/v3/serp/google/local_finder/task_get/html/{id}",method:"get",operationId:"GoogleLocalFinderTaskGetHtml",tag:"Serp",description:`Description of the fields for sending a request:
|
|
74
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/local_finder/task_get/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/local_finder/task_get/html/"},{path:"/v3/serp/google/local_finder/live/advanced",method:"post",operationId:"GoogleLocalFinderLiveAdvanced",tag:"Serp",description:`Live Google Local_finder SERP provides real-time search engine results for the specified keyword and location. By default, you can get up to 20 results for desktop and up to 10 results for mobile.
|
|
75
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/local_finder/live/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/local_finder/live/advanced/",example:[{language_code:"en",location_code:2840,keyword:"local nail services",min_rating:4.5,time_filter:"monday"}]},{path:"/v3/serp/google/local_finder/live/html",method:"post",operationId:"GoogleLocalFinderLiveHtml",tag:"Serp",description:`Live Google Local Finder SERP HTML provides a raw HTML page of the search engine results for the specified keyword, search engine, and location.
|
|
76
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/local_finder/live/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/local_finder/live/html/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein"}]},{path:"/v3/serp/google/news/task_post",method:"post",operationId:"GoogleNewsTaskPost",tag:"Serp",description:`SERP API provides top search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
|
|
77
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/news/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/news/task_post/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein"}]},{path:"/v3/serp/google/news/tasks_ready",method:"get",operationId:"GoogleNewsTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
78
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
79
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/news/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/news/tasks_ready/"},{path:"/v3/serp/google/news/tasks_fixed",method:"get",operationId:"GoogleNewsTasksFixed",tag:"Serp",description:`The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.
|
|
80
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/news/tasks_fixed/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/news/tasks_fixed/"},{path:"/v3/serp/google/news/task_get/advanced/{id}",method:"get",operationId:"GoogleNewsTaskGetAdvanced",tag:"Serp",description:`Description of the fields for sending a request:
|
|
81
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/news/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/news/task_get/advanced/"},{path:"/v3/serp/google/news/task_get/html/{id}",method:"get",operationId:"GoogleNewsTaskGetHtml",tag:"Serp",description:`Description of the fields for sending a request:
|
|
82
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/news/task_get/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/news/task_get/html/"},{path:"/v3/serp/google/news/live/advanced",method:"post",operationId:"GoogleNewsLiveAdvanced",tag:"Serp",description:`Live Google News SERP provides real-time data on top search engine results for the specified keyword, search engine, and location.
|
|
83
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/news/live/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/news/live/advanced/",example:[{language_code:"en",location_code:2840,keyword:"android"}]},{path:"/v3/serp/google/news/live/html",method:"post",operationId:"GoogleNewsLiveHtml",tag:"Serp",description:`Live SERP HTML provides a raw HTML page of 10 search engine results for the specified keyword, search engine, and location.
|
|
84
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/news/live/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/news/live/html/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein"}]},{path:"/v3/serp/google/events/task_post",method:"post",operationId:"GoogleEventsTaskPost",tag:"Serp",description:`Google Events SERP provides data from Google Events Search for the specified keyword and location (see the List of Locations). Note that Google Events SERP API works for the English language only.
|
|
85
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/events/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/events/task_post/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein"}]},{path:"/v3/serp/google/events/tasks_ready",method:"get",operationId:"GoogleEventsTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
86
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
87
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/events/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/events/tasks_ready/"},{path:"/v3/serp/google/events/tasks_fixed",method:"get",operationId:"GoogleEventsTasksFixed",tag:"Serp",description:`The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.
|
|
88
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/events/tasks_fixed/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/events/tasks_fixed/"},{path:"/v3/serp/google/events/task_get/advanced/{id}",method:"get",operationId:"GoogleEventsTaskGetAdvanced",tag:"Serp",description:`Description of the fields for sending a request:
|
|
89
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/events/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/events/task_get/advanced/"},{path:"/v3/serp/google/events/live/advanced",method:"post",operationId:"GoogleEventsLiveAdvanced",tag:"Serp",description:`Live Google Events SERP provides real-time data from Google Events Search for the specified keyword and location. Note that Google Events SERP API works for the English language only.
|
|
90
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/events/live/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/events/live/advanced/",example:[{keyword:"concerts",location_name:"Los Angeles,California,United States",date_range:"today"}]},{path:"/v3/serp/google/images/task_post",method:"post",operationId:"GoogleImagesTaskPost",tag:"Serp",description:`SERP API provides top 100 search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
|
|
91
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/images/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/images/task_post/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein"}]},{path:"/v3/serp/google/images/tasks_ready",method:"get",operationId:"GoogleImagesTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
92
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
93
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/images/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/images/tasks_ready/"},{path:"/v3/serp/google/images/tasks_fixed",method:"get",operationId:"GoogleImagesTasksFixed",tag:"Serp",description:`The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.
|
|
94
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/images/tasks_fixed/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/images/tasks_fixed/"},{path:"/v3/serp/google/images/task_get/advanced/{id}",method:"get",operationId:"GoogleImagesTaskGetAdvanced",tag:"Serp",description:`Description of the fields for sending a request:
|
|
95
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/images/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/images/task_get/advanced/"},{path:"/v3/serp/google/images/task_get/html/{id}",method:"get",operationId:"GoogleImagesTaskGetHtml",tag:"Serp",description:`Description of the fields for sending a request:
|
|
96
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/images/task_get/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/images/task_get/html/"},{path:"/v3/serp/google/images/live/advanced",method:"post",operationId:"GoogleImagesLiveAdvanced",tag:"Serp",description:`Live Google Images SERP provides real-time data on top 100 images results for the specified keyword, search engine, and location.
|
|
97
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/images/live/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/images/live/advanced/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein"}]},{path:"/v3/serp/google/images/live/html",method:"post",operationId:"GoogleImagesLiveHtml",tag:"Serp",description:`Live SERP HTML provides a raw HTML page of 100 search engine results for the specified keyword, search engine, and location.
|
|
98
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/images/live/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/images/live/html/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein"}]},{path:"/v3/serp/google/search_by_image/task_post",method:"post",operationId:"GoogleSearchByImageTaskPost",tag:"Serp",description:`Google Search By Image SERP API provides up to top 100 search engine results based on the image you specified. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
|
|
99
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/search_by_image/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/search_by_image/task_post/",example:[{language_code:"en",location_code:2840,image_url:"https://dataforseo.com/wp-content/uploads/2016/11/data_for_seo_light_429.png"}]},{path:"/v3/serp/google/search_by_image/tasks_ready",method:"get",operationId:"GoogleSearchByImageTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
100
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/search_by_image/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/search_by_image/tasks_ready/"},{path:"/v3/serp/google/search_by_image/tasks_fixed",method:"get",operationId:"GoogleSearchByImageTasksFixed",tag:"Serp",description:`The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.
|
|
101
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/search_by_image/tasks_fixed/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/search_by_image/tasks_fixed/"},{path:"/v3/serp/google/search_by_image/task_get/advanced/{id}",method:"get",operationId:"GoogleSearchByImageTaskGetAdvanced",tag:"Serp",description:`Description of the fields for sending a request:
|
|
102
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/search_by_image/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/search_by_image/task_get/advanced/"},{path:"/v3/serp/google/jobs/task_post",method:"post",operationId:"GoogleJobsTaskPost",tag:"Serp",description:`This endpoint will provide you with SERP data from the Google Jobs search engine. The returned results are specific to the keyword as well as the language and location parameters of the POST request.
|
|
103
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/jobs/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/jobs/task_post/",example:[{language_code:"en",location_code:2840,keyword:".net developer"},{language_name:"English",location_name:"United States",keyword:".net developer",tag:"some_string_123",pingback_url:"https://your-server.com/pingscript?id=$id&tag=$tag"}]},{path:"/v3/serp/google/jobs/tasks_ready",method:"get",operationId:"GoogleJobsTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
104
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
105
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/jobs/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/jobs/tasks_ready/"},{path:"/v3/serp/google/jobs/tasks_fixed",method:"get",operationId:"GoogleJobsTasksFixed",tag:"Serp",description:`The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.
|
|
106
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/jobs/tasks_fixed/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/jobs/tasks_fixed/"},{path:"/v3/serp/google/jobs/task_get/advanced/{id}",method:"get",operationId:"GoogleJobsTaskGetAdvanced",tag:"Serp",description:`Description of the fields for sending a request:
|
|
107
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/jobs/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/jobs/task_get/advanced/"},{path:"/v3/serp/google/jobs/task_get/html/{id}",method:"get",operationId:"GoogleJobsTaskGetHtml",tag:"Serp",description:`Description of the fields for sending a request:
|
|
108
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/jobs/task_get/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/jobs/task_get/html/"},{path:"/v3/serp/google/autocomplete/task_post",method:"post",operationId:"GoogleAutocompleteTaskPost",tag:"Serp",description:`Google Autocomplete is a feature within Google Search that improves the search experience by allowing users to complete searches they started to type. DataForSEO SERP API will provide you with all the suggestions Google Autocomplete offers for a particular keyword, the position of the cursor pointer, and the search client.
|
|
109
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/autocomplete/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/autocomplete/task_post/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein",cursor_pointer:6}]},{path:"/v3/serp/google/autocomplete/tasks_ready",method:"get",operationId:"GoogleAutocompleteTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
110
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
111
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/autocomplete/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/autocomplete/tasks_ready/"},{path:"/v3/serp/google/autocomplete/tasks_fixed",method:"get",operationId:"GoogleAutocompleteTasksFixed",tag:"Serp",description:`The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.
|
|
112
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/autocomplete/tasks_fixed/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/autocomplete/tasks_fixed/"},{path:"/v3/serp/google/autocomplete/task_get/advanced/{id}",method:"get",operationId:"GoogleAutocompleteTaskGetAdvanced",tag:"Serp",description:`Description of the fields for sending a request:
|
|
113
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/autocomplete/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/autocomplete/task_get/advanced/"},{path:"/v3/serp/google/autocomplete/live/advanced",method:"post",operationId:"GoogleAutocompleteLiveAdvanced",tag:"Serp",description:`Google Autocomplete is a feature within Google Search that improves the search experience by allowing users to complete searches they started to type. DataForSEO SERP API will provide you with all the suggestions Google Autocomplete offers for a particular keyword, the position of the cursor pointer, and the search client.
|
|
114
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/autocomplete/live/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/autocomplete/live/advanced/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein",client:"gws-wiz-serp"}]},{path:"/v3/serp/google/dataset_search/task_post",method:"post",operationId:"GoogleDatasetSearchTaskPost",tag:"Serp",description:`Google Dataset Search API provides top 20 Google Dataset search engine results. These results are specific to the indicated keyword. You can specify other parameters optionally.
|
|
115
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/dataset_search/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/dataset_search/task_post/",example:[{keyword:"water quality",last_updated:"1m",file_formats:["archive","image"],usage_rights:"noncommercial",is_free:!0,topics:["natural_sciences","geo"]}]},{path:"/v3/serp/google/dataset_search/tasks_ready",method:"get",operationId:"GoogleDatasetSearchTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
116
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
117
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/dataset_search/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/dataset_search/tasks_ready/"},{path:"/v3/serp/google/dataset_search/tasks_fixed",method:"get",operationId:"GoogleDatasetSearchTasksFixed",tag:"Serp",description:`The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.
|
|
118
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/dataset_search/tasks_fixed/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/dataset_search/tasks_fixed/"},{path:"/v3/serp/google/dataset_search/task_get/advanced/{id}",method:"get",operationId:"GoogleDatasetSearchTaskGetAdvanced",tag:"Serp",description:`Description of the fields for sending a request:
|
|
119
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/dataset_search/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/dataset_search/task_get/advanced/"},{path:"/v3/serp/google/dataset_search/live/advanced",method:"post",operationId:"GoogleDatasetSearchLiveAdvanced",tag:"Serp",description:`Live Google Dataset Search provides real-time data on the top 20 Google Dataset search engine results. These results are specific to the indicated keyword. You can specify other parameters optionally.
|
|
120
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/dataset_search/live/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/dataset_search/live/advanced/",example:[{keyword:"water quality",last_updated:"1m",file_formats:["archive","image"],usage_rights:"noncommercial",is_free:!0,topics:["natural_sciences","geo"]}]},{path:"/v3/serp/google/dataset_info/task_post",method:"post",operationId:"GoogleDatasetInfoTaskPost",tag:"Serp",description:`Google Dataset Info API provides detailed information about the dataset you specify in the POST request. You will get data from a page of the dataset displayed separately from the SERP. It contains information about dataset content, authors, licenses, and description on the SERP.
|
|
121
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/dataset_info/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/dataset_info/task_post/",example:[{dataset_id:"L2cvMTFqbl85ZHN6MQ=="}]},{path:"/v3/serp/google/dataset_info/tasks_ready",method:"get",operationId:"GoogleDatasetInfoTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
122
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
123
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/dataset_info/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/dataset_info/tasks_ready/"},{path:"/v3/serp/google/dataset_info/tasks_fixed",method:"get",operationId:"GoogleDatasetInfoTasksFixed",tag:"Serp",description:`The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.
|
|
124
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/dataset_info/tasks_fixed/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/dataset_info/tasks_fixed/"},{path:"/v3/serp/google/dataset_info/task_get/advanced/{id}",method:"get",operationId:"GoogleDatasetInfoTaskGetAdvanced",tag:"Serp",description:`Description of the fields for sending a request:
|
|
125
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/dataset_info/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/dataset_info/task_get/advanced/"},{path:"/v3/serp/google/dataset_info/live/advanced",method:"post",operationId:"GoogleDatasetInfoLiveAdvanced",tag:"Serp",description:`Live Google Dataset Info provides real-time data on the dataset you specify in the request. You will get data from a page of the dataset displayed separately from the SERP. It contains information about dataset content, authors, licenses, and description on the SERP.
|
|
126
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/dataset_info/live/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/dataset_info/live/advanced/",example:[{dataset_id:"L2cvMTFqbl85ZHN6MQ=="}]},{path:"/v3/serp/google/ads_advertisers/locations",method:"get",operationId:"GoogleAdsAdvertisersLocations",tag:"Serp",description:`As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
|
|
127
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/ads_advertisers/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/ads_advertisers/locations/"},{path:"/v3/serp/google/ads_advertisers/task_post",method:"post",operationId:"GoogleAdsAdvertisersTaskPost",tag:"Serp",description:`Google Ads Advertisers provides information on advertisers that run campaigns on Google Ads based on the Ads Transparency platform.
|
|
128
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/ads_advertisers/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/ads_advertisers/task_post/",example:[{location_code:2840,keyword:"apple"}]},{path:"/v3/serp/google/ads_advertisers/tasks_ready",method:"get",operationId:"GoogleAdsAdvertisersTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
129
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
130
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/ads_advertisers/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/ads_advertisers/tasks_ready/"},{path:"/v3/serp/google/ads_advertisers/task_get/advanced/{id}",method:"get",operationId:"GoogleAdsAdvertisersTaskGetAdvanced",tag:"Serp",description:`Description of the fields for sending a request:
|
|
131
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/ads_advertisers/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/ads_advertisers/task_get/advanced/"},{path:"/v3/serp/google/ads_search/locations",method:"get",operationId:"GoogleAdsSearchLocations",tag:"Serp",description:"for more info please visit 'https://docs.dataforseo.com/v3/serp/google/ads_search/locations/?bash'",docUrl:"https://docs.dataforseo.com/v3/serp/google/ads_search/locations/"},{path:"/v3/serp/google/ads_search/task_post",method:"post",operationId:"GoogleAdsSearchTaskPost",tag:"Serp",description:`Google Ads Search provides information on ads that are run by advertisers on Google Ads. Information is based on the Ads Transparency platform and adapted for the convenience of DataForSEO users.
|
|
132
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/ads_search/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/ads_search/task_post/",example:[{location_code:2840,platform:"google_search",advertiser_ids:["AR13752565271262920705","AR02439908557932462081"]}]},{path:"/v3/serp/google/ads_search/tasks_ready",method:"get",operationId:"GoogleAdsSearchTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
133
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
134
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/ads_search/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/ads_search/tasks_ready/"},{path:"/v3/serp/google/ads_search/task_get/advanced/{id}",method:"get",operationId:"GoogleAdsSearchTaskGetAdvanced",tag:"Serp",description:`Description of the fields for sending a request:
|
|
135
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/ads_search/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/ads_search/task_get/advanced/"},{path:"/v3/serp/bing/locations",method:"get",operationId:"BingLocations",tag:"Serp",description:`You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
|
|
136
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/bing/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/bing/locations/"},{path:"/v3/serp/bing/locations/{country}",method:"get",operationId:"BingLocationsCountry",tag:"Serp",description:`You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
|
|
137
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/bing/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/bing/locations/"},{path:"/v3/serp/bing/languages",method:"get",operationId:"BingLanguages",tag:"Serp",description:`You will receive the list of languages by calling this API.
|
|
138
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/bing/languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/bing/languages/"},{path:"/v3/serp/bing/organic/task_post",method:"post",operationId:"BingOrganicTaskPost",tag:"Serp",description:`SERP API provides search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
|
|
139
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/bing/organic/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/bing/organic/task_post/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein"}]},{path:"/v3/serp/bing/organic/tasks_ready",method:"get",operationId:"BingOrganicTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
140
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
141
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/bing/organic/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/bing/organic/tasks_ready/"},{path:"/v3/serp/bing/organic/tasks_fixed",method:"get",operationId:"BingOrganicTasksFixed",tag:"Serp",description:`The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.
|
|
142
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/bing/organic/tasks_fixed/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/bing/organic/tasks_fixed/"},{path:"/v3/serp/bing/organic/task_get/regular/{id}",method:"get",operationId:"BingOrganicTaskGetRegular",tag:"Serp",description:`Description of the fields for sending a request:
|
|
143
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/bing/organic/task_get/regular/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/bing/organic/task_get/regular/"},{path:"/v3/serp/bing/organic/task_get/advanced/{id}",method:"get",operationId:"BingOrganicTaskGetAdvanced",tag:"Serp",description:`Description of the fields for sending a request:
|
|
144
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/bing/organic/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/bing/organic/task_get/advanced/"},{path:"/v3/serp/bing/organic/task_get/html/{id}",method:"get",operationId:"BingOrganicTaskGetHtml",tag:"Serp",description:`Description of the fields for sending a request:
|
|
145
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/bing/organic/task_get/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/bing/organic/task_get/html/"},{path:"/v3/serp/bing/organic/live/regular",method:"post",operationId:"BingOrganicLiveRegular",tag:"Serp",description:`Live SERP provides real-time data on search engine results for the specified keyword, search engine, and location.
|
|
146
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/bing/organic/live/regular/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/bing/organic/live/regular/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein"}]},{path:"/v3/serp/bing/organic/live/advanced",method:"post",operationId:"BingOrganicLiveAdvanced",tag:"Serp",description:`Live SERP provides real-time data on top 100 search engine results for the specified keyword, search engine, and location. This endpoint will supply a complete overview of featured snippets and other extra elements of SERPs.
|
|
147
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/bing/organic/live/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/bing/organic/live/advanced/",example:[{language_code:"en",location_code:2840,keyword:"flight ticket new york san francisco"}]},{path:"/v3/serp/bing/organic/live/html",method:"post",operationId:"BingOrganicLiveHtml",tag:"Serp",description:`Live SERP HTML provides a raw HTML page of search engine results for the specified keyword, search engine, and location.
|
|
148
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/bing/organic/live/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/bing/organic/live/html/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein"}]},{path:"/v3/serp/youtube/locations",method:"get",operationId:"YoutubeLocations",tag:"Serp",description:`You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
|
|
149
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/youtube/locations/"},{path:"/v3/serp/youtube/locations/{country}",method:"get",operationId:"YoutubeLocationsCountry",tag:"Serp",description:`You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
|
|
150
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/youtube/locations/"},{path:"/v3/serp/youtube/languages",method:"get",operationId:"YoutubeLanguages",tag:"Serp",description:`You will receive the list of languages by calling this API.
|
|
151
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/youtube/languages/"},{path:"/v3/serp/youtube/video_info/task_post",method:"post",operationId:"YoutubeVideoInfoTaskPost",tag:"Serp",description:`YouTube Video Info API provides detailed information about the video you specify in the POST request. You will get data from the watching page containing key video and content metrics as well as the channel where the video is published.
|
|
152
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_info/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/youtube/video_info/task_post/",example:[{language_code:"en",location_code:2840,video_id:"vQXvyV0zIP4"}]},{path:"/v3/serp/youtube/video_info/tasks_ready",method:"get",operationId:"YoutubeVideoInfoTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
153
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
154
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_info/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/youtube/video_info/tasks_ready/"},{path:"/v3/serp/youtube/video_info/tasks_fixed",method:"get",operationId:"YoutubeVideoInfoTasksFixed",tag:"Serp",description:`The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.
|
|
155
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_info/tasks_fixed/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/youtube/video_info/tasks_fixed/"},{path:"/v3/serp/youtube/video_info/task_get/advanced/{id}",method:"get",operationId:"YoutubeVideoInfoTaskGetAdvanced",tag:"Serp",description:`Description of the fields for sending a request:
|
|
156
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_info/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/youtube/video_info/task_get/advanced/"},{path:"/v3/serp/youtube/video_info/live/advanced",method:"post",operationId:"YoutubeVideoInfoLiveAdvanced",tag:"Serp",description:`Live YouTube Video Info provides real-time data on the video you specify in the request. You will get data from the watching page containing key video and content metrics as well as the channel where the video is published.
|
|
157
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_info/live/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/youtube/video_info/live/advanced/",example:[{language_code:"en",location_code:2840,video_id:"vQXvyV0zIP4"}]},{path:"/v3/serp/youtube/organic/task_post",method:"post",operationId:"YoutubeOrganicTaskPost",tag:"Serp",description:`YouTube Organic API provides the top 20 blocks of search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
|
|
158
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/organic/task_post/'`,docUrl:"https://docs.dataforseo.com/v3/serp/youtube/organic/task_post/",example:[{language_code:"en",location_code:2840,keyword:"audi"}]},{path:"/v3/serp/youtube/organic/tasks_ready",method:"get",operationId:"YoutubeOrganicTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
159
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
160
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/organic/tasks_ready/'`,docUrl:"https://docs.dataforseo.com/v3/serp/youtube/organic/tasks_ready/"},{path:"/v3/serp/youtube/organic/tasks_fixed",method:"get",operationId:"YoutubeOrganicTasksFixed",tag:"Serp",description:`The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.
|
|
161
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/organic/tasks_fixed/'`,docUrl:"https://docs.dataforseo.com/v3/serp/youtube/organic/tasks_fixed/"},{path:"/v3/serp/youtube/organic/task_get/advanced/{id}",method:"get",operationId:"YoutubeOrganicTaskGetAdvanced",tag:"Serp",description:`Description of the fields for sending a request:
|
|
162
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/organic/task_get/advanced/'`,docUrl:"https://docs.dataforseo.com/v3/serp/youtube/organic/task_get/advanced/"},{path:"/v3/serp/youtube/organic/live/advanced",method:"post",operationId:"YoutubeOrganicLiveAdvanced",tag:"Serp",description:`Live SERP provides real-time data on the top 20 blocks of YouTube search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
|
|
163
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/organic/live/advanced/'`,docUrl:"https://docs.dataforseo.com/v3/serp/youtube/organic/live/advanced/",example:[{language_code:"en",location_code:2840,keyword:"audi"}]},{path:"/v3/serp/youtube/video_subtitles/task_post",method:"post",operationId:"YoutubeVideoSubtitlesTaskPost",tag:"Serp",description:`YouTube Subtitles API provides data on all subtitles in the video you specify in the POST request. You will get data from the watching page containing subtitled text, its language, and duration in the video.
|
|
164
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_subtitles/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/youtube/video_subtitles/task_post/",example:[{language_code:"en",location_code:2840,video_id:"Y8Wu4rSNJms"}]},{path:"/v3/serp/youtube/video_subtitles/tasks_ready",method:"get",operationId:"YoutubeVideoSubtitlesTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
165
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
166
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_subtitles/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/youtube/video_subtitles/tasks_ready/"},{path:"/v3/serp/youtube/video_subtitles/tasks_fixed",method:"get",operationId:"YoutubeVideoSubtitlesTasksFixed",tag:"Serp",description:`The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.
|
|
167
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_subtitles/tasks_fixed/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/youtube/video_subtitles/tasks_fixed/"},{path:"/v3/serp/youtube/video_subtitles/task_get/advanced/{id}",method:"get",operationId:"YoutubeVideoSubtitlesTaskGetAdvanced",tag:"Serp",description:`Description of the fields for sending a request:
|
|
168
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_subtitles/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/youtube/video_subtitles/task_get/advanced/"},{path:"/v3/serp/youtube/video_subtitles/live/advanced",method:"post",operationId:"YoutubeVideoSubtitlesLiveAdvanced",tag:"Serp",description:`Live YouTube Subtitles provides real-time data on subtitles in the video you specify in the request. You will get data from the watching page containing subtitled text, its language, and duration in the video.
|
|
169
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_subtitles/live/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/youtube/video_subtitles/live/advanced/",example:[{language_code:"en",location_code:2840,video_id:"Y8Wu4rSNJms"}]},{path:"/v3/serp/youtube/video_comments/task_post",method:"post",operationId:"YoutubeVideoCommentsTaskPost",tag:"Serp",description:`YouTube Comments API provides data on comments on the video you specify in the request. You will get the top 20 comments on the video as well as information about the author, and key comment metrics.
|
|
170
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_comments/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/youtube/video_comments/task_post/",example:[{language_code:"en",location_code:2840,video_id:"vQXvyV0zIP4"}]},{path:"/v3/serp/youtube/video_comments/tasks_ready",method:"get",operationId:"YoutubeVideoCommentsTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
171
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
172
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_comments/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/youtube/video_comments/tasks_ready/"},{path:"/v3/serp/youtube/video_comments/tasks_fixed",method:"get",operationId:"YoutubeVideoCommentsTasksFixed",tag:"Serp",description:`The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.
|
|
173
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_comments/tasks_fixed/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/youtube/video_comments/tasks_fixed/"},{path:"/v3/serp/youtube/video_comments/task_get/advanced/{id}",method:"get",operationId:"YoutubeVideoCommentsTaskGetAdvanced",tag:"Serp",description:`Description of the fields for sending a request:
|
|
174
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_comments/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/youtube/video_comments/task_get/advanced/"},{path:"/v3/serp/youtube/video_comments/live/advanced",method:"post",operationId:"YoutubeVideoCommentsLiveAdvanced",tag:"Serp",description:`Live YouTube Comments provides real-time data on comments on the video you specify in the request. You will get the top 20 comments on the video as well as information about the author, and key comment metrics.
|
|
175
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_comments/live/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/youtube/video_comments/live/advanced/",example:[{language_code:"en",location_code:2840,video_id:"vQXvyV0zIP4"}]},{path:"/v3/serp/yahoo/locations",method:"get",operationId:"YahooLocations",tag:"Serp",description:`You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
|
|
176
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/yahoo/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/yahoo/locations/"},{path:"/v3/serp/yahoo/locations/{country}",method:"get",operationId:"YahooLocationsCountry",tag:"Serp",description:`You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
|
|
177
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/yahoo/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/yahoo/locations/"},{path:"/v3/serp/yahoo/languages",method:"get",operationId:"YahooLanguages",tag:"Serp",description:`You will receive the list of languages by calling this API.
|
|
178
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/yahoo/languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/yahoo/languages/"},{path:"/v3/serp/yahoo/organic/task_post",method:"post",operationId:"YahooOrganicTaskPost",tag:"Serp",description:`SERP API provides top search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
|
|
179
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/yahoo/organic/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/yahoo/organic/task_post/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein"}]},{path:"/v3/serp/yahoo/organic/tasks_ready",method:"get",operationId:"YahooOrganicTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
180
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
181
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/yahoo/organic/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/yahoo/organic/tasks_ready/"},{path:"/v3/serp/yahoo/organic/tasks_fixed",method:"get",operationId:"YahooOrganicTasksFixed",tag:"Serp",description:`The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.
|
|
182
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/yahoo/organic/tasks_fixed/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/yahoo/organic/tasks_fixed/"},{path:"/v3/serp/yahoo/organic/task_get/regular/{id}",method:"get",operationId:"YahooOrganicTaskGetRegular",tag:"Serp",description:`Description of the fields for sending a request:
|
|
183
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/yahoo/organic/task_get/regular/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/yahoo/organic/task_get/regular/"},{path:"/v3/serp/yahoo/organic/task_get/advanced/{id}",method:"get",operationId:"YahooOrganicTaskGetAdvanced",tag:"Serp",description:`Description of the fields for sending a request:
|
|
184
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/yahoo/organic/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/yahoo/organic/task_get/advanced/"},{path:"/v3/serp/yahoo/organic/task_get/html/{id}",method:"get",operationId:"YahooOrganicTaskGetHtml",tag:"Serp",description:`Description of the fields for sending a request:
|
|
185
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/yahoo/organic/task_get/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/yahoo/organic/task_get/html/"},{path:"/v3/serp/yahoo/organic/live/regular",method:"post",operationId:"YahooOrganicLiveRegular",tag:"Serp",description:`Live Yahoo SERP provides real-time data on search engine results for the specified keyword, search engine, and location.
|
|
186
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/yahoo/organic/live/regular/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/yahoo/organic/live/regular/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein"}]},{path:"/v3/serp/yahoo/organic/live/advanced",method:"post",operationId:"YahooOrganicLiveAdvanced",tag:"Serp",description:`Live SERP provides real-time data on top search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
|
|
187
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/yahoo/organic/live/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/yahoo/organic/live/advanced/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein"}]},{path:"/v3/serp/yahoo/organic/live/html",method:"post",operationId:"YahooOrganicLiveHtml",tag:"Serp",description:`Live SERP HTML provides a raw HTML page of search engine results for the specified keyword, search engine, and location.
|
|
188
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/yahoo/organic/live/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/yahoo/organic/live/html/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein"}]},{path:"/v3/serp/baidu/locations",method:"get",operationId:"BaiduLocations",tag:"Serp",description:`You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
|
|
189
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/baidu/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/baidu/locations/"},{path:"/v3/serp/baidu/locations/{country}",method:"get",operationId:"BaiduLocationsCountry",tag:"Serp",description:`You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
|
|
190
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/baidu/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/baidu/locations/"},{path:"/v3/serp/baidu/languages",method:"get",operationId:"BaiduLanguages",tag:"Serp",description:`You will receive the list of languages by calling this API. You can also download the full list of supported languages in the CSV format (last updated 2026-04-06).
|
|
191
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/baidu/languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/baidu/languages/"},{path:"/v3/serp/baidu/organic/task_post",method:"post",operationId:"BaiduOrganicTaskPost",tag:"Serp",description:`Baidu SERP API provides top 10 search engine results. These results are specific to the selected location (see the List of Locations) and other settings.
|
|
192
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/baidu/organic/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/baidu/organic/task_post/",example:[{location_code:2156,keyword:"best iphone ever",tag:"some_string_123",priority:2}]},{path:"/v3/serp/baidu/organic/tasks_ready",method:"get",operationId:"BaiduOrganicTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
193
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
194
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/baidu/organic/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/baidu/organic/tasks_ready/"},{path:"/v3/serp/baidu/organic/tasks_fixed",method:"get",operationId:"BaiduOrganicTasksFixed",tag:"Serp",description:`The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.
|
|
195
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/baidu/organic/tasks_fixed/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/baidu/organic/tasks_fixed/"},{path:"/v3/serp/baidu/organic/task_get/regular/{id}",method:"get",operationId:"BaiduOrganicTaskGetRegular",tag:"Serp",description:`Description of the fields for sending a request:
|
|
196
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/baidu/organic/task_get/regular/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/baidu/organic/task_get/regular/"},{path:"/v3/serp/baidu/organic/task_get/advanced/{id}",method:"get",operationId:"BaiduOrganicTaskGetAdvanced",tag:"Serp",description:`Description of the fields for sending a request:
|
|
197
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/baidu/organic/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/baidu/organic/task_get/advanced/"},{path:"/v3/serp/baidu/organic/task_get/html/{id}",method:"get",operationId:"BaiduOrganicTaskGetHtml",tag:"Serp",description:`Description of the fields for sending a request:
|
|
198
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/baidu/organic/task_get/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/baidu/organic/task_get/html/"},{path:"/v3/serp/naver/organic/task_post",method:"post",operationId:"NaverOrganicTaskPost",tag:"Serp",description:`Naver SERP API provides top 15 search engine results. Naver search results do not vary by location and language, and the search parameters for this search engine do not contain language and location variables. However, you can specify a keyword in any language, and the search engine results may vary depending on the language you used for specifying the search query.
|
|
199
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/naver/organic/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/naver/organic/task_post/",example:[{keyword:"albert einstein",device:"desktop",tag:"some_string_123",postback_url:"https://your-server.com/postbackscript.php",postback_data:"regular"}]},{path:"/v3/serp/naver/organic/tasks_ready",method:"get",operationId:"NaverOrganicTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
200
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
201
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/naver/organic/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/naver/organic/tasks_ready/"},{path:"/v3/serp/naver/organic/tasks_fixed",method:"get",operationId:"NaverOrganicTasksFixed",tag:"Serp",description:`The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.
|
|
202
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/naver/organic/tasks_fixed/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/naver/organic/tasks_fixed/"},{path:"/v3/serp/naver/organic/task_get/regular/{id}",method:"get",operationId:"NaverOrganicTaskGetRegular",tag:"Serp",description:`Description of the fields for sending a request:
|
|
203
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/naver/organic/task_get/regular/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/naver/organic/task_get/regular/"},{path:"/v3/serp/naver/organic/task_get/advanced/{id}",method:"get",operationId:"NaverOrganicTaskGetAdvanced",tag:"Serp",description:`Description of the fields for sending a request:
|
|
204
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/naver/organic/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/naver/organic/task_get/advanced/"},{path:"/v3/serp/naver/organic/task_get/html/{id}",method:"get",operationId:"NaverOrganicTaskGetHtml",tag:"Serp",description:`Description of the fields for sending a request:
|
|
205
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/naver/organic/task_get/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/naver/organic/task_get/html/"},{path:"/v3/serp/seznam/locations",method:"get",operationId:"SeznamLocations",tag:"Serp",description:`You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
|
|
206
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/seznam/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/seznam/locations/"},{path:"/v3/serp/seznam/locations/{country}",method:"get",operationId:"SeznamLocationsCountry",tag:"Serp",description:`You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
|
|
207
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/seznam/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/seznam/locations/"},{path:"/v3/serp/seznam/languages",method:"get",operationId:"SeznamLanguages",tag:"Serp",description:`You will receive the list of languages by calling this API.
|
|
208
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/seznam/languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/seznam/languages/"},{path:"/v3/serp/seznam/organic/task_post",method:"post",operationId:"SeznamOrganicTaskPost",tag:"Serp",description:`Seznam SERP API provides top 10 search engine results from one of the most popular search engines in the Czech Republic. Seznam is focused on the local search market, and thus supports the Czech language only.
|
|
209
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/seznam/organic/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/seznam/organic/task_post/",example:[{language_code:"cs",location_code:2203,keyword:"albert einstein"}]},{path:"/v3/serp/seznam/organic/tasks_ready",method:"get",operationId:"SeznamOrganicTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
210
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
211
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/seznam/organic/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/seznam/organic/tasks_ready/"},{path:"/v3/serp/seznam/organic/tasks_fixed",method:"get",operationId:"SeznamOrganicTasksFixed",tag:"Serp",description:`The ‘Tasks Fixed’ endpoint is designed to provide you with the list of re-parsed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed re-parsed tasks using this endpoint. Then, you can re-collect the fixed results using the ‘Task GET’ endpoint.
|
|
212
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/seznam/organic/tasks_fixed/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/seznam/organic/tasks_fixed/"},{path:"/v3/serp/seznam/organic/task_get/regular/{id}",method:"get",operationId:"SeznamOrganicTaskGetRegular",tag:"Serp",description:`Description of the fields for sending a request:
|
|
213
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/seznam/organic/task_get/regular/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/seznam/organic/task_get/regular/"},{path:"/v3/serp/seznam/organic/task_get/advanced/{id}",method:"get",operationId:"SeznamOrganicTaskGetAdvanced",tag:"Serp",description:`Description of the fields for sending a request:
|
|
214
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/seznam/organic/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/seznam/organic/task_get/advanced/"},{path:"/v3/serp/seznam/organic/task_get/html/{id}",method:"get",operationId:"SeznamOrganicTaskGetHtml",tag:"Serp",description:`Description of the fields for sending a request:
|
|
215
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/seznam/organic/task_get/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/seznam/organic/task_get/html/"},{path:"/v3/serp/google/finance_explore/task_post",method:"post",operationId:"GoogleFinanceExploreTaskPost",tag:"Serp",description:`Google Finance Explore API provides real-time data from the ‘Explore’ tab of Google Finance. These results are specific to the parameters you specify in the request: location and language.
|
|
216
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/finance_explore/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/finance_explore/task_post/",example:[{location_code:2840,language_name:"English"}]},{path:"/v3/serp/google/finance_explore/tasks_ready",method:"get",operationId:"GoogleFinanceExploreTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
217
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
218
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/finance_explore/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/finance_explore/tasks_ready/"},{path:"/v3/serp/google/finance_explore/task_get/advanced/{id}",method:"get",operationId:"GoogleFinanceExploreTaskGetAdvanced",tag:"Serp",description:`Live Google Finance Explore provides real-time data from the ‘Explore’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language.
|
|
219
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/finance_explore/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/finance_explore/task_get/advanced/"},{path:"/v3/serp/google/finance_explore/task_get/html/{id}",method:"get",operationId:"GoogleFinanceExploreTaskGetHtml",tag:"Serp",description:`Description of the fields for sending a request:
|
|
220
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/finance_explore/task_get/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/finance_explore/task_get/html/"},{path:"/v3/serp/google/finance_explore/live/advanced",method:"post",operationId:"GoogleFinanceExploreLiveAdvanced",tag:"Serp",description:`Live Google Finance Explore provides real-time data from the ‘Explore’ tab of Google Finance. These results are specific to the parameters you specify in the request: location and language.
|
|
221
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/finance_explore/live/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/finance_explore/live/advanced/",example:[{location_code:2840,language_name:"English"}]},{path:"/v3/serp/google/finance_explore/live/html",method:"post",operationId:"GoogleFinanceExploreLiveHtml",tag:"Serp",description:`Live SERP HTML provides raw HTML page from the ‘Explore’ tab of Google Finance. These results are specific to the parameters you specify in the request: location and language.
|
|
222
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/finance_explore/live/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/finance_explore/live/html/",example:[{language_code:"en",location_code:2840}]},{path:"/v3/serp/google/finance_markets/task_post",method:"post",operationId:"GoogleFinanceMarketsTaskPost",tag:"Serp",description:`Google Finance Markets API provides real-time data from the ‘Markets’ tab of Google Finance. These results are specific to the parameters you specify in the request: location, language, and market_type.
|
|
223
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/finance_markets/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/finance_markets/task_post/",example:[{location_code:2840,language_name:"English"}]},{path:"/v3/serp/google/finance_markets/tasks_ready",method:"get",operationId:"GoogleFinanceMarketsTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
224
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
225
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/finance_markets/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/finance_markets/tasks_ready/"},{path:"/v3/serp/google/finance_markets/task_get/advanced/{id}",method:"get",operationId:"GoogleFinanceMarketsTaskGetAdvanced",tag:"Serp",description:`Google Finance Markets API provides real-time data from the ‘Markets’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language.
|
|
226
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/finance_markets/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/finance_markets/task_get/advanced/"},{path:"/v3/serp/google/finance_markets/task_get/html/{id}",method:"get",operationId:"GoogleFinanceMarketsTaskGetHtml",tag:"Serp",description:`Description of the fields for sending a request:
|
|
227
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/finance_markets/task_get/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/finance_markets/task_get/html/"},{path:"/v3/serp/google/finance_markets/live/advanced",method:"post",operationId:"GoogleFinanceMarketsLiveAdvanced",tag:"Serp",description:`Live Google Finance Markets provides real-time data from the ‘Markets’ tab of Google Finance. These results are specific to the parameters you specify in the request: location, language, and market_type.
|
|
228
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/finance_markets/live/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/finance_markets/live/advanced/",example:[{location_code:2840,language_name:"English"}]},{path:"/v3/serp/google/finance_markets/live/html",method:"post",operationId:"GoogleFinanceMarketsLiveHtml",tag:"Serp",description:`Live SERP HTML provides raw HTML from the ‘Markets’ tab of Google Finance. These results are specific to the parameters you specify in the request: location and language.
|
|
229
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/finance_markets/live/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/finance_markets/live/html/",example:[{language_code:"en",location_code:2840}]},{path:"/v3/serp/google/finance_quote/task_post",method:"post",operationId:"GoogleFinanceQuoteTaskPost",tag:"Serp",description:`Google Finance Quote provides real-time data from the ‘Quote’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language.
|
|
230
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/finance_quote/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/finance_quote/task_post/",example:[{keyword:".DJI:INDEXDJX",location_code:2840,language_name:"English"}]},{path:"/v3/serp/google/finance_quote/tasks_ready",method:"get",operationId:"GoogleFinanceQuoteTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
231
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
232
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/finance_quote/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/finance_quote/tasks_ready/"},{path:"/v3/serp/google/finance_quote/task_get/advanced/{id}",method:"get",operationId:"GoogleFinanceQuoteTaskGetAdvanced",tag:"Serp",description:`Live Google Finance Quote provides real-time data from the ‘Quote’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language.
|
|
233
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/finance_quote/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/finance_quote/task_get/advanced/"},{path:"/v3/serp/google/finance_quote/task_get/html/{id}",method:"get",operationId:"GoogleFinanceQuoteTaskGetHtml",tag:"Serp",description:`Description of the fields for sending a request:
|
|
234
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/finance_quote/task_get/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/finance_quote/task_get/html/"},{path:"/v3/serp/google/finance_quote/live/advanced",method:"post",operationId:"GoogleFinanceQuoteLiveAdvanced",tag:"Serp",description:`Live Google Finance Quote provides real-time data from the ‘Quote’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language.
|
|
235
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/finance_quote/live/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/finance_quote/live/advanced/",example:[{keyword:"CLW00:NYMEX",location_code:2840,language_name:"English"}]},{path:"/v3/serp/google/finance_quote/live/html",method:"post",operationId:"GoogleFinanceQuoteLiveHtml",tag:"Serp",description:`Live SERP HTML provides raw HTML from the ‘Quote’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language.
|
|
236
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/finance_quote/live/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/finance_quote/live/html/",example:[{language_code:"en",location_code:2840,keyword:"NASDAQ-100"}]},{path:"/v3/serp/google/finance_ticker_search/task_post",method:"post",operationId:"GoogleFinanceTickerSearchTaskPost",tag:"Serp",description:`Google Finance Ticker Search allows you to search for financial instruments available on Google Finance along with additional information. The result is specific to the parameters you specify in the request: keyword (name of a company or financial instrument) in the keyword field, location and language.
|
|
237
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/finance_ticker_search/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/finance_ticker_search/task_post/",example:[{language_name:"English",location_code:2840,category:"all",keyword:"DJ",priority:2}]},{path:"/v3/serp/google/finance_ticker_search/tasks_ready",method:"get",operationId:"GoogleFinanceTickerSearchTasksReady",tag:"Serp",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
238
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
239
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/finance_ticker_search/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/finance_ticker_search/tasks_ready/"},{path:"/v3/serp/google/finance_ticker_search/task_get/advanced/{id}",method:"get",operationId:"GoogleFinanceTickerSearchTaskGetAdvanced",tag:"Serp",description:`Google Finance Ticker Search allows you to search for financial instruments available on Google Finance along with additional information. The result is specific to the parameters you specify in the request: keyword (name of a company or financial instrument) in the keyword field, location and language.
|
|
240
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/finance_ticker_search/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/finance_ticker_search/task_get/advanced/"},{path:"/v3/serp/google/finance_ticker_search/live/advanced",method:"post",operationId:"GoogleFinanceTickerSearchLiveAdvanced",tag:"Serp",description:`Live Google Finance Ticker Search allows you to search for financial instruments available on Google Finance along with additional information. The result is specific to the parameters you specify in the request: keyword (name of a company or financial instrument) in the keyword field, location and language.
|
|
241
|
+
for more info please visit 'https://docs.dataforseo.com/v3/serp/google/finance_ticker_search/live/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/serp/google/finance_ticker_search/live/advanced/",example:[{language_name:"English",location_code:2840,category:"all",keyword:"DJ"}]},{path:"/v3/dataforseo_labs/id_list",method:"post",operationId:"DataforseoLabsIdList",tag:"DataforseoLabs",description:`This endpoint is designed to provide you with a list of IDs and metadata for all DataForSEO Labs tasks created within the specified time period, including both successful and uncompleted tasks.
|
|
242
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/id_list/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/id_list/",example:[{datetime_from:"2026-04-12 04:39:39 +00:00",datetime_to:"2026-04-14 04:39:39 +00:00",limit:100,offset:0,sort:"desc",include_metadata:!0}]},{path:"/v3/dataforseo_labs/status",method:"get",operationId:"Status",tag:"DataforseoLabs",description:`By calling this endpoint, you will find out when the DataForSEO Labs data was last updated. The API response will provide separate update dates for the Google, Bing, and Amazon endpoints of DataForSEO Labs API.
|
|
243
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/status/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/status/"},{path:"/v3/dataforseo_labs/errors",method:"post",operationId:"DataforseoLabsErrors",tag:"DataforseoLabs",description:`By calling this endpoint you will receive information about the DataForSEO Labs API tasks that returned an error within the past 7 days.
|
|
244
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/errors/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/errors/",example:[{limit:10,offset:0}]},{path:"/v3/dataforseo_labs/available_filters",method:"get",operationId:"AvailableFilters",tag:"DataforseoLabs",description:`Here you will find all the necessary information about filters that can be used with DataForSEO Labs API endpoints.
|
|
245
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/filters/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/filters/"},{path:"/v3/dataforseo_labs/locations_and_languages",method:"get",operationId:"LocationsAndLanguages",tag:"DataforseoLabs",description:`Using this endpoint you can get the full list of locations and languages supported in DataForSEO Labs API. Available sources currently include Google, Bing, and Amazon search engines. However, you should note that Amazon and Bing locations and languages are currently limited to the US/English.
|
|
246
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages/"},{path:"/v3/dataforseo_labs/categories",method:"get",operationId:"Categories",tag:"DataforseoLabs",description:`We use Google product and service categories. This endpoint will provide you with the full list of available categories.
|
|
247
|
+
You can also download the CSV file by this link.
|
|
248
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/categories_list/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/categories_list/"},{path:"/v3/dataforseo_labs/google/available_history",method:"get",operationId:"GoogleAvailableHistory",tag:"DataforseoLabs",description:`By calling this endpoint, you will find obtain a list of dates available for setting in the first_date and second_date fields of the Domain Metrics by Categories endpoint.
|
|
249
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/available_history/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/available_history/live/"},{path:"/v3/dataforseo_labs/google/keywords_for_site/live",method:"post",operationId:"GoogleKeywordsForSiteLive",tag:"DataforseoLabs",description:`The Keywords For Site endpoint will provide you with a list of keywords relevant to the target domain. Each keyword is supplied with relevant categories, search volume data for the last month, cost-per-click, competition, and search volume trend values for the past 12 months.
|
|
250
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/keywords_for_site/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/keywords_for_site/live/",example:[{target:"apple.com",language_code:"en",location_code:2840,include_serp_info:!0,include_subdomains:!0,filters:["serp_info.se_results_count",">",0],limit:3}]},{path:"/v3/dataforseo_labs/google/related_keywords/live",method:"post",operationId:"GoogleRelatedKeywordsLive",tag:"DataforseoLabs",description:`The Related Keywords endpoint provides keywords appearing in the
|
|
251
|
+
"searches related to" SERP element
|
|
252
|
+
You can get up to 4680 keyword ideas by specifying the search depth. Each related keyword comes with the list of relevant product categories, search volume rate for the last month, search volume trend for the previous 12 months, as well as current cost-per-click and competition values.
|
|
253
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/related_keywords/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/related_keywords/live/",example:[{keyword:"phone",language_name:"English",location_code:2840,limit:3}]},{path:"/v3/dataforseo_labs/google/keyword_suggestions/live",method:"post",operationId:"GoogleKeywordSuggestionsLive",tag:"DataforseoLabs",description:`The Keyword Suggestions endpoint provides search queries that include the specified seed keyword.
|
|
254
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/keyword_suggestions/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/keyword_suggestions/live/",example:[{keyword:"phone",location_code:2840,language_code:"en",include_serp_info:!0,include_seed_keyword:!0,limit:1}]},{path:"/v3/dataforseo_labs/google/keyword_ideas/live",method:"post",operationId:"GoogleKeywordIdeasLive",tag:"DataforseoLabs",description:`The Keyword Ideas endpoint provides search terms that are relevant to the product or service categories of the specified keywords. The algorithm selects the keywords which fall into the same categories as the seed keywords specified in a POST array.
|
|
255
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/keyword_ideas/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/keyword_ideas/live/",example:[{keywords:["phone","watch"],location_code:2840,language_code:"en",include_serp_info:!0,limit:3}]},{path:"/v3/dataforseo_labs/google/bulk_keyword_difficulty/live",method:"post",operationId:"GoogleBulkKeywordDifficultyLive",tag:"DataforseoLabs",description:`This endpoint will provide you with the Keyword Difficulty metric for a maximum of 1,000 keywords in one API request. Keyword Difficulty stands for the relative difficulty of ranking in the first top-10 organic results for the related keyword. Keyword Difficulty in DataForSEO API responses indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100.
|
|
256
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/bulk_keyword_difficulty/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/bulk_keyword_difficulty/live/",example:[{location_code:2840,language_code:"en",keywords:["dentist new york","pizza brooklyn","car dealer los angeles"]}]},{path:"/v3/dataforseo_labs/google/search_intent/live",method:"post",operationId:"GoogleSearchIntentLive",tag:"DataforseoLabs",description:`This endpoint will provide you with search intent data for up to 1,000 keywords. For each keyword that you specify when setting a task, the API will return the keyword’s search intent and intent probability. Besides the highest probable search intent, the results will also provide you with other likely search intent(s) and their probability.
|
|
257
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/search_intent/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/search_intent/live/",example:[{language_code:"en",keywords:["login page","audi a7","elon musk","milk store new york"]}]},{path:"/v3/dataforseo_labs/google/categories_for_keywords/languages",method:"get",operationId:"GoogleCategoriesForKeywordsLanguages",tag:"DataforseoLabs",description:`Using this endpoint you can get the full list of languages supported for the Google Categories for Keywords endpoint of DataForSEO Labs API.
|
|
258
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/languages/"},{path:"/v3/dataforseo_labs/google/categories_for_domain/live",method:"post",operationId:"GoogleCategoriesForDomainLive",tag:"DataforseoLabs",description:`This endpoint will provide you with Google product or service categories that include keywords the domain ranks for in search. Furthermore, you will obtain general rankings and traffic data for the keywords under a certain category.
|
|
259
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/categories_for_domain/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/categories_for_domain/live/",example:[{target:"dataforseo.com",language_code:"en",location_name:"United States",item_types:["paid","organic","featured_snippet","local_pack"],limit:3}]},{path:"/v3/dataforseo_labs/google/categories_for_keywords/live",method:"post",operationId:"GoogleCategoriesForKeywordsLive",tag:"DataforseoLabs",description:`This endpoint will provide you with Google product and service categories related for each specified keyword. You can indicate a maximum of 1,000 keywords in one API request.
|
|
260
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/categories_for_keywords/live/",example:[{language_code:"en",keywords:["dentist new york","pizza brooklyn","car dealer los angeles"]}]},{path:"/v3/dataforseo_labs/google/keywords_for_categories/live",method:"post",operationId:"GoogleKeywordsForCategoriesLive",tag:"DataforseoLabs",description:`This endpoint will provide you with a list of keywords relevant to the specified product categories. You will get the search volume rate for the last month, search volume trend for the previous 12 months, as well as current cost-per-click and competition values for each keyword.
|
|
261
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/keywords_for_categories/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/keywords_for_categories/live/",example:[{category_codes:[12191,12193],language_name:"English",location_code:2840,include_serp_info:!0,limit:3}]},{path:"/v3/dataforseo_labs/google/domain_metrics_by_categories/live",method:"post",operationId:"GoogleDomainMetricsByCategoriesLive",tag:"DataforseoLabs",description:`This endpoint will provide you with dynamics of change in metrics of domains relevant to the specified product and service categories. You will receive historical ranking data from Google SERPs, along with valuable current and historical domain metrics, such as ETV, impressions ETV, estimated paid traffic cost, the total count of SERPs that contain domains, and more.
|
|
262
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/domain_metrics_by_categories/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/domain_metrics_by_categories/live/",example:[{location_code:2840,language_code:"en",category_codes:[13418,11494],first_date:"2026-01-15",second_date:"2026-03-15",limit:3}]},{path:"/v3/dataforseo_labs/google/top_searches/live",method:"post",operationId:"GoogleTopSearchesLive",tag:"DataforseoLabs",description:`The Top Searches endpoint of DataForSEO Labs API can provide you with over 7 billion keywords from the DataForSEO Keyword Database. Each keyword in the API response is provided with a set of relevant keyword data with Google Ads metrics, product categories, and Google SERP data.
|
|
263
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/top_searches/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/top_searches/live/",example:[{language_name:"English",location_code:2840,limit:3}]},{path:"/v3/dataforseo_labs/google/ranked_keywords/live",method:"post",operationId:"GoogleRankedKeywordsLive",tag:"DataforseoLabs",description:`This endpoint will provide you with the list of keywords that any domain or webpage is ranking for. You will also get SERP elements related to the keyword position, as well as monthly searches and other data relevant to the returned keywords.
|
|
264
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/ranked_keywords/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/ranked_keywords/live/",example:[{target:"dataforseo.com",language_name:"English",location_name:"United States",load_rank_absolute:!0,limit:3}]},{path:"/v3/dataforseo_labs/google/serp_competitors/live",method:"post",operationId:"GoogleSerpCompetitorsLive",tag:"DataforseoLabs",description:`This endpoint will provide you with a list of domains ranking for the keywords you specify. You will also get SERP rankings, rating, estimated traffic volume, and visibility values the provided domains gain from the specified keywords.
|
|
265
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/serp_competitors/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/serp_competitors/live/",example:[{keywords:["phone"],language_name:"English",location_code:2840,item_types:["organic"],limit:5}]},{path:"/v3/dataforseo_labs/google/competitors_domain/live",method:"post",operationId:"GoogleCompetitorsDomainLive",tag:"DataforseoLabs",description:`This endpoint will provide you with a full overview of ranking and traffic data of the competitor domains from organic and paid search. In addition to that, you will get the metrics specific to the keywords both competitor domains and your domain rank for within the same SERP.
|
|
266
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/competitors_domain/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/competitors_domain/live/",example:[{target:"newmouth.com",intersecting_domains:["dentaly.org","health.com","trysnow.com"],language_name:"English",location_code:2840,limit:3}]},{path:"/v3/dataforseo_labs/google/domain_intersection/live",method:"post",operationId:"GoogleDomainIntersectionLive",tag:"DataforseoLabs",description:`This endpoint will provide you with the keywords for which both specified domains rank within the same SERP. You will get search volume, competition, cost-per-click and other data on each intersecting keyword. Along with that, you will get data on the first and second domain’s SERP element discovered for this keyword, as well as the estimated traffic volume and cost of ad traffic. Domain Intersection endpoint supports organic, paid, local pack, and featured snippet results.
|
|
267
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/domain_intersection/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/domain_intersection/live/",example:[{target1:"mom.com",target2:"quora.com",language_code:"en",location_code:2840,include_serp_info:!0,limit:3}]},{path:"/v3/dataforseo_labs/google/subdomains/live",method:"post",operationId:"GoogleSubdomainsLive",tag:"DataforseoLabs",description:`This endpoint will provide you with a list of subdomains of the specified domain, along with the ranking distribution across organic and paid search. In addition to that, you will also get the estimated traffic volume of subdomains based on search volume and impressions.
|
|
268
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/subdomains/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/subdomains/live/",example:[{target:"dataforseo.com",language_name:"English",location_code:2840,filters:[["metrics.organic.pos_1","<>",0],"or",["metrics.organic.pos_2_3","<>",0]]}]},{path:"/v3/dataforseo_labs/google/relevant_pages/live",method:"post",operationId:"GoogleRelevantPagesLive",tag:"DataforseoLabs",description:"for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/relevant_pages/live/?bash'",docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/relevant_pages/live/",example:[{target:"amazon.com",language_name:"English",location_code:2840,filters:[["metrics.organic.pos_1","<>",0],"or",["metrics.organic.pos_2_3","<>",0]],limit:3}]},{path:"/v3/dataforseo_labs/google/domain_rank_overview/live",method:"post",operationId:"GoogleDomainRankOverviewLive",tag:"DataforseoLabs",description:`This endpoint will provide you with ranking and traffic data from organic and paid search for the specified domain. You will be able to review the domain ranking distribution in SERPs as well as estimated monthly traffic volume for both organic and paid results.
|
|
269
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/domain_rank_overview/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/domain_rank_overview/live/",example:[{target:"dataforseo.com",language_name:"English",location_code:2840}]},{path:"/v3/dataforseo_labs/google/historical_serps/live",method:"post",operationId:"GoogleHistoricalSerpsLive",tag:"DataforseoLabs",description:`This endpoint will provide you with Google SERPs collected within the specified time frame. You will also receive a complete overview of featured snippets and other extra elements that were present within the specified dates. The data will allow you to analyze the dynamics of keyword rankings over time for the specified keyword and location.
|
|
270
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/historical_serps/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/historical_serps/live/",example:[{keyword:"albert einstein",location_code:2840,language_code:"en",date_from:"2026-01-15",date_to:"2026-03-15"}]},{path:"/v3/dataforseo_labs/google/historical_rank_overview/live",method:"post",operationId:"GoogleHistoricalRankOverviewLive",tag:"DataforseoLabs",description:`This endpoint will provide you with historical data on rankings and traffic of the specified domain, such as domain ranking distribution in SERPs and estimated monthly traffic volume for both organic and paid results.
|
|
271
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/historical_rank_overview/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/historical_rank_overview/live/",example:[{target:"dataforseo.com",location_code:2840,language_code:"en",date_from:"2026-01-15",date_to:"2026-03-15"}]},{path:"/v3/dataforseo_labs/google/page_intersection/live",method:"post",operationId:"GooglePageIntersectionLive",tag:"DataforseoLabs",description:`This endpoint will provide you with the keywords for which specified pages rank within the same SERP. You will get search volume, competition, cost-per-click data on each intersecting keyword. Along with that, you will get data on SERP elements that specified pages rank for in search results, as well as the estimated traffic volume and cost of ad traffic. Page Intersection endpoint supports organic, paid, local pack and featured snippet results.
|
|
272
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/page_intersection/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/page_intersection/live/",example:[{pages:{"1":"https://forbes.com","2":"https://cnn.com/*"},language_name:"English",location_code:2840,include_serp_info:!0,limit:3}]},{path:"/v3/dataforseo_labs/google/bulk_traffic_estimation/live",method:"post",operationId:"GoogleBulkTrafficEstimationLive",tag:"DataforseoLabs",description:`This endpoint will provide you with estimated monthly traffic volumes for up to 1,000 domains, subdomains, or webpages. Along with organic search traffic estimations, you will also get separate values for paid search, featured snippet, and local pack results.
|
|
273
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/bulk_traffic_estimation/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/bulk_traffic_estimation/live/",example:[{targets:["dataforseo.com","cnn.com","forbes.com"],location_code:2840,language_code:"en",item_types:["organic","paid"]}]},{path:"/v3/dataforseo_labs/google/historical_bulk_traffic_estimation/live",method:"post",operationId:"GoogleHistoricalBulkTrafficEstimationLive",tag:"DataforseoLabs",description:`This endpoint will provide you with historical monthly traffic volumes for up to 1,000 domains collected within the specified time range through October 2020. If you do not specify the range, data will be returned for the previous 12 months. Along with organic search traffic estimations, you will also get separate values for paid search, featured snippet, and local pack results.
|
|
274
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/historical_bulk_traffic_estimation/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/historical_bulk_traffic_estimation/live/",example:[{targets:["dataforseo.com","cnn.com","forbes.com"],location_code:2840,language_code:"en",date_from:"2026-01-15",date_to:"2026-03-15",item_types:["organic","paid"]}]},{path:"/v3/dataforseo_labs/google/historical_keyword_data/live",method:"post",operationId:"GoogleHistoricalKeywordDataLive",tag:"DataforseoLabs",description:`
|
|
275
|
+
This endpoint provides Google historical keyword data for specified keywords, including search volume, cost-per-click, competition values for paid search, monthly searches, and search volume trends. You can get historical keyword data since August, 2021, depending on keywords along with location and language combination. You can find the list of supported locations and languages here.
|
|
276
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/historical_keyword_data/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/historical_keyword_data/live/",example:[{language_code:"en",location_code:2840,keywords:["iphone"]}]},{path:"/v3/dataforseo_labs/google/keyword_overview/live",method:"post",operationId:"GoogleKeywordOverviewLive",tag:"DataforseoLabs",description:`
|
|
277
|
+
This endpoint provides Google keyword data for specified keywords. For each keyword, you will receive current cost-per-click, competition values for paid search, search volume, search intent, monthly searches, as well as SERP and backlink information. Additionally, you can obtain clickstream data, such as clickstream search volume, by specifying the include_clickstream_data parameter.
|
|
278
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/keyword_overview/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/keyword_overview/live/",example:[{language_code:"en",location_code:2840,include_clickstream_data:!0,include_serp_info:!0,keywords:["iphone"]}]},{path:"/v3/dataforseo_labs/amazon/bulk_search_volume/live",method:"post",operationId:"AmazonBulkSearchVolumeLive",tag:"DataforseoLabs",description:`This endpoint will provide you with search volume values for a maximum of 1,000 keywords in one API request. Here search volume represents the approximate number of monthly searches for a keyword on Amazon. The returned results are specific to the keywords, location, and language parameters specified in a POST request.
|
|
279
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/amazon/bulk_search_volume/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/amazon/bulk_search_volume/live/",example:[{keywords:["buy laptop","cheap laptops for sale","purchase laptop"],location_code:2840,language_code:"en"}]},{path:"/v3/dataforseo_labs/amazon/related_keywords/live",method:"post",operationId:"AmazonRelatedKeywordsLive",tag:"DataforseoLabs",description:`The Related Keywords endpoint provides keywords appearing in the
|
|
280
|
+
"Related Searches" section on Amazon.
|
|
281
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/amazon/related_keywords/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/amazon/related_keywords/live/",example:[{keyword:"computer mouse",language_name:"English",location_code:2840,limit:5,include_seed_keyword:!0}]},{path:"/v3/dataforseo_labs/amazon/ranked_keywords/live",method:"post",operationId:"AmazonRankedKeywordsLive",tag:"DataforseoLabs",description:`This endpoint will provide you with a list of keywords the target product ranks for on Amazon. The returned results are specific to the asin specified in a POST request. Learn more about ASIN in this help center article.
|
|
282
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/amazon/ranked_keywords/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/amazon/ranked_keywords/live/",example:[{asin:"B00R92CL5E",location_code:2840,language_code:"en"}]},{path:"/v3/dataforseo_labs/amazon/product_rank_overview/live",method:"post",operationId:"AmazonProductRankOverviewLive",tag:"DataforseoLabs",description:`This endpoint will provide you with ranking data from organic and paid Amazon SERPs for the target products. The returned results are specific to the asins specified in a POST request. Learn more about ASIN in this help center article.
|
|
283
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/amazon/product_rank_overview/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/amazon/product_rank_overview/live/",example:[{asins:["B001TJ3HUG","B01LW2SL7R"],language_name:"English",location_code:2840}]},{path:"/v3/dataforseo_labs/amazon/product_competitors/live",method:"post",operationId:"AmazonProductCompetitorsLive",tag:"DataforseoLabs",description:`This endpoint will provide you with a list of products that intersect with a target asin in Amazon SERPs. The data can help you identify product competitors for any listing published on Amazon. The returned results are specific to the asin as well as the location and language parameters specified in a POST request.
|
|
284
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/amazon/product_competitors/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/amazon/product_competitors/live/",example:[{asin:"019005476X",location_code:2840,language_code:"en"}]},{path:"/v3/dataforseo_labs/amazon/product_keyword_intersections/live",method:"post",operationId:"AmazonProductKeywordIntersectionsLive",tag:"DataforseoLabs",description:`This endpoint will provide you with a list of keywords for which the target products intersect in Amazon SERP. The returned results are specific to the asins specified in a POST request. Learn more about ASIN in this help center article.
|
|
285
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/amazon/product_keyword_intersections/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/amazon/product_keyword_intersections/live/",example:[{asins:{"1":"B09172433Z","2":"B07GBZ4Q68","3":"B07GCKQD77"},language_name:"English",location_code:2840}]},{path:"/v3/dataforseo_labs/google/bulk_app_metrics/live",method:"post",operationId:"GoogleBulkAppMetricsLive",tag:"DataforseoLabs",description:`This endpoint will provide you with ranking metrics for up to 1000 Google Play applications.
|
|
286
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/bulk_app_metrics/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/bulk_app_metrics/live/",example:[{app_ids:["org.telegram.messenger","com.zhiliaoapp.musically"],language_name:"English",location_code:2840}]},{path:"/v3/dataforseo_labs/google/keywords_for_app/live",method:"post",operationId:"GoogleKeywordsForAppLive",tag:"DataforseoLabs",description:`This endpoint will provide you with a list of keywords for which the target app ranks on Google Play. You will obtain keyword data and discover the app’s ranking position for each returned keyword.
|
|
287
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/keywords_for_app/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/keywords_for_app/live/",example:[{app_id:"org.telegram.messenger",language_name:"English",location_code:2840,limit:10}]},{path:"/v3/dataforseo_labs/google/app_competitors/live",method:"post",operationId:"GoogleAppCompetitorsLive",tag:"DataforseoLabs",description:`This endpoint will provide you with a list of mobile applications that intersect with the target app for its ranking keywords on Google Play. You will obtain the IDs of competitor apps along with search volume and ranking data on competitor ranking keywords.
|
|
288
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/app_competitors/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/app_competitors/live/",example:[{app_id:"org.telegram.messenger",language_name:"English",location_code:2840,limit:10}]},{path:"/v3/dataforseo_labs/google/app_intersection/live",method:"post",operationId:"GoogleAppIntersectionLive",tag:"DataforseoLabs",description:`This endpoint will provide you with a list of keywords for which the mobile applications specified in the app_ids object rank within the same Google Play SERP.
|
|
289
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/app_intersection/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/google/app_intersection/live/",example:[{app_ids:{"1":"org.telegram.messenger","2":"com.zhiliaoapp.musically"},language_name:"English",location_code:2840,limit:10}]},{path:"/v3/dataforseo_labs/apple/bulk_app_metrics/live",method:"post",operationId:"AppleBulkAppMetricsLive",tag:"DataforseoLabs",description:`This endpoint will provide you with ranking metrics for up to 1000 App Store applications.
|
|
290
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/apple/bulk_app_metrics/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/apple/bulk_app_metrics/live/",example:[{app_ids:["686449807","382617920"],language_name:"English",location_code:2840}]},{path:"/v3/dataforseo_labs/apple/keywords_for_app/live",method:"post",operationId:"AppleKeywordsForAppLive",tag:"DataforseoLabs",description:`This endpoint will provide you with a list of keywords for which the target app ranks on App Store. You will obtain keyword data and discover the app’s ranking position for each returned keyword.
|
|
291
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/apple/keywords_for_app/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/apple/keywords_for_app/live/",example:[{app_id:"686449807",language_name:"English",location_code:2840,limit:10}]},{path:"/v3/dataforseo_labs/apple/app_competitors/live",method:"post",operationId:"AppleAppCompetitorsLive",tag:"DataforseoLabs",description:`This endpoint will provide you with a list of mobile applications that intersect with the target app for its ranking keywords on App Store. You will obtain the IDs of competitor apps along with search volume and ranking data on competitor ranking keywords.
|
|
292
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/apple/app_competitors/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/apple/app_competitors/live/",example:[{app_id:"686449807",language_name:"English",location_code:2840,limit:10}]},{path:"/v3/dataforseo_labs/apple/app_intersection/live",method:"post",operationId:"AppleAppIntersectionLive",tag:"DataforseoLabs",description:`This endpoint will provide you with a list of keywords for which the mobile applications specified in the app_ids object rank within the same App Store SERP.
|
|
293
|
+
for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/apple/app_intersection/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/dataforseo_labs/apple/app_intersection/live/",example:[{app_ids:{"1":"686449807","2":"382617920"},language_name:"English",location_code:2840,limit:10}]},{path:"/v3/domain_analytics/id_list",method:"post",operationId:"DomainAnalyticsIdList",tag:"DomainAnalytics",description:`This endpoint is designed to provide you with a list of IDs and metadata for all Domain Analytics tasks created within the specified time period, including both successful and uncompleted tasks.
|
|
294
|
+
for more info please visit 'https://docs.dataforseo.com/v3/domain_analytics/id_list/?bash'`,docUrl:"https://docs.dataforseo.com/v3/domain_analytics/id_list/",example:[{datetime_from:"2026-04-12 04:39:39 +00:00",datetime_to:"2026-04-14 04:39:39 +00:00",limit:100,offset:0,sort:"desc",include_metadata:!0}]},{path:"/v3/domain_analytics/errors",method:"post",operationId:"DomainAnalyticsErrors",tag:"DomainAnalytics",description:`By calling this endpoint you will receive information about the Domain Analytics API tasks that returned an error within the past 7 days.
|
|
295
|
+
for more info please visit 'https://docs.dataforseo.com/v3/domain_analytics/errors/?bash'`,docUrl:"https://docs.dataforseo.com/v3/domain_analytics/errors/",example:[{limit:10,offset:0,filtered_function:"pingback_url"}]},{path:"/v3/domain_analytics/technologies/available_filters",method:"get",operationId:"TechnologiesAvailableFilters",tag:"DomainAnalytics",description:`Here you will find all the necessary information about filters that can be used with Domain Analytics Technologies API endpoints.
|
|
296
|
+
for more info please visit 'https://docs.dataforseo.com/v3/domain_analytics/technologies/filters/?bash'`,docUrl:"https://docs.dataforseo.com/v3/domain_analytics/technologies/filters/"},{path:"/v3/domain_analytics/technologies/locations",method:"get",operationId:"TechnologiesLocations",tag:"DomainAnalytics",description:`You will receive the list of locations by this API call.
|
|
297
|
+
for more info please visit 'https://docs.dataforseo.com/v3/domain_analytics/technologies/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/domain_analytics/technologies/locations/"},{path:"/v3/domain_analytics/technologies/languages",method:"get",operationId:"TechnologiesLanguages",tag:"DomainAnalytics",description:`You will receive the list of languages by calling this API.
|
|
298
|
+
|
|
299
|
+
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
|
|
300
|
+
for more info please visit 'https://docs.dataforseo.com/v3/domain_analytics/technologies/languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/domain_analytics/technologies/languages/"},{path:"/v3/domain_analytics/technologies/technologies",method:"get",operationId:"TechnologiesTechnologies",tag:"DomainAnalytics",description:`This endpoint will provide you with the full list of available technologies structured by technology groups and categories each particular technology belongs to.
|
|
301
|
+
for more info please visit 'https://docs.dataforseo.com/v3/domain_analytics/technologies/technologies/?bash'`,docUrl:"https://docs.dataforseo.com/v3/domain_analytics/technologies/technologies/"},{path:"/v3/domain_analytics/technologies/aggregation_technologies/live",method:"post",operationId:"TechnologiesAggregationTechnologiesLive",tag:"DomainAnalytics",description:`The Aggregation Technologies endpoint will provide you with a list of the most popular technologies websites use alongside the technologies you specify. Alternatively, you can specify technology categories or groups to obtain wider stats.
|
|
302
|
+
for more info please visit 'https://docs.dataforseo.com/v3/domain_analytics/technologies/aggregation_technologies/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/domain_analytics/technologies/aggregation_technologies/live/",example:[{mode:"entry",technology:"Nginx",keyword:"WordPress",filters:[["country_iso_code","=","US"],"and",["domain_rank",">",800]],order_by:["groups_count,desc"],limit:10}]},{path:"/v3/domain_analytics/technologies/technologies_summary/live",method:"post",operationId:"TechnologiesTechnologiesSummaryLive",tag:"DomainAnalytics",description:`The Technologies Summary endpoint will provide you with the number of domains across different countries and languages that use the specified technology names, technology groups, or technology categories.
|
|
303
|
+
for more info please visit 'https://docs.dataforseo.com/v3/domain_analytics/technologies/technologies_summary/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/domain_analytics/technologies/technologies_summary/live/",example:[{mode:"entry",technologies:["Ngi"],keywords:["WordPress"],filters:[["country_iso_code","=","US"],"and",["domain_rank",">",800]]}]},{path:"/v3/domain_analytics/technologies/technology_stats/live",method:"post",operationId:"TechnologiesTechnologyStatsLive",tag:"DomainAnalytics",description:`The Technology Stats endpoint will provide you with historical data on the number of domains across different countries and languages that use the specified technology.
|
|
304
|
+
for more info please visit 'https://docs.dataforseo.com/v3/domain_analytics/technologies/technology_stats/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/domain_analytics/technologies/technology_stats/live/",example:[{technology:"jQuery",date_from:"2026-01-15",date_to:"2026-03-15"}]},{path:"/v3/domain_analytics/technologies/domains_by_technology/live",method:"post",operationId:"TechnologiesDomainsByTechnologyLive",tag:"DomainAnalytics",description:`This endpoint provides domains based on the technology they use. In addition to the list of domains, you will also get their technology profiles, the country and language they belong to, and other related data.
|
|
305
|
+
for more info please visit 'https://docs.dataforseo.com/v3/domain_analytics/technologies/domains_by_technology/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/domain_analytics/technologies/domains_by_technology/live/",example:[{technologies:["Nginx"],filters:[["country_iso_code","=","US"],"and",["domain_rank",">",800]],order_by:["last_visited,desc"],limit:10}]},{path:"/v3/domain_analytics/technologies/domains_by_html_terms/live",method:"post",operationId:"TechnologiesDomainsByHtmlTermsLive",tag:"DomainAnalytics",description:`This endpoint provides domains based on the HTML terms they use on their homepage. In addition to the list of domains, you will also get their technology profiles, the country and language they belong to, and other related data.
|
|
306
|
+
for more info please visit 'https://docs.dataforseo.com/v3/domain_analytics/technologies/domains_by_html_terms/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/domain_analytics/technologies/domains_by_html_terms/live/",example:[{search_terms:["data-attrid"],order_by:["last_visited,desc"],limit:10,offset:0}]},{path:"/v3/domain_analytics/technologies/domain_technologies/live",method:"post",operationId:"TechnologiesDomainTechnologiesLive",tag:"DomainAnalytics",description:`Using this endpoint you will get a list of technologies used in a particular domain.
|
|
307
|
+
for more info please visit 'https://docs.dataforseo.com/v3/domain_analytics/technologies/domain_technologies/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/domain_analytics/technologies/domain_technologies/live/",example:[{target:"dataforseo.com"}]},{path:"/v3/domain_analytics/whois/available_filters",method:"get",operationId:"WhoisAvailableFilters",tag:"DomainAnalytics",description:`Here you will find all the necessary information about filters that can be used with Domain Analytics Whois API.
|
|
308
|
+
for more info please visit 'https://docs.dataforseo.com/v3/domain_analytics/whois/filters/?bash'`,docUrl:"https://docs.dataforseo.com/v3/domain_analytics/whois/filters/"},{path:"/v3/domain_analytics/whois/overview/live",method:"post",operationId:"WhoisOverviewLive",tag:"DomainAnalytics",description:`This endpoint will provide you with Whois data enriched with backlink stats, and ranking and traffic info from organic and paid search results. Using this endpoint you will be able to get all these data for the domains matching the parameters you specify in the request.
|
|
309
|
+
for more info please visit 'https://docs.dataforseo.com/v3/domain_analytics/whois/overview/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/domain_analytics/whois/overview/live/",example:[{limit:2,filters:[["epp_status_codes","in",["client_transfer_prohibited","client_update_prohibited"]]]}]},{path:"/v3/keywords_data/id_list",method:"post",operationId:"KeywordsDataIdList",tag:"KeywordsData",description:`This endpoint is designed to provide you with a list of IDs and metadata for all Keywords Data tasks created within the specified time period, including both successful and uncompleted tasks.
|
|
310
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/id_list/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/id_list/",example:[{datetime_from:"2026-04-12 04:39:39 +00:00",datetime_to:"2026-04-14 04:39:39 +00:00",limit:100,offset:0,sort:"desc",include_metadata:!0}]},{path:"/v3/keywords_data/errors",method:"post",operationId:"KeywordsDataErrors",tag:"KeywordsData",description:`By calling this endpoint you will receive information about the Keywords Data API tasks that returned an error within the past 7 days.
|
|
311
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/errors/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/errors/",example:[{limit:10,offset:0,filtered_function:"pingback_url"}]},{path:"/v3/keywords_data/google_ads/status",method:"get",operationId:"GoogleAdsStatus",tag:"KeywordsData",description:`By calling this endpoint, you will know if Google updated keyword data for the previous month. Generally, Google updates keyword data in the middle of the month. So, if Google updated its data in October, you would be able to see the actual search volume, cost-per-click, competition, and other metrics for September. If Google didn’t update its data in October, the latest information would be available for August.
|
|
312
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/status/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_ads/status/"},{path:"/v3/keywords_data/google_ads/locations",method:"get",operationId:"GoogleAdsLocations",tag:"KeywordsData",description:`We use Google Geographical Targeting. You can refer to Google Ads Target Types page to review the full list of possible location types. With Keywords Data API, you can select any location type supported by Google, except for “Okrug”.
|
|
313
|
+
Postal Codes can be used to set a task, albeit API response will not return data for such tasks.
|
|
314
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_ads/locations/"},{path:"/v3/keywords_data/google_ads/locations/{country}",method:"get",operationId:"GoogleAdsLocationsCountry",tag:"KeywordsData",description:`We use Google Geographical Targeting. You can refer to Google Ads Target Types page to review the full list of possible location types. With Keywords Data API, you can select any location type supported by Google, except for “Okrug”.
|
|
315
|
+
Postal Codes can be used to set a task, albeit API response will not return data for such tasks.
|
|
316
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_ads/locations/"},{path:"/v3/keywords_data/google_ads/languages",method:"get",operationId:"GoogleAdsLanguages",tag:"KeywordsData",description:`By calling this API you will receive the list of languages supported by Keywords Data API.
|
|
317
|
+
|
|
318
|
+
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information about available languages.
|
|
319
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_ads/languages/"},{path:"/v3/keywords_data/google_ads/search_volume/task_post",method:"post",operationId:"GoogleAdsSearchVolumeTaskPost",tag:"KeywordsData",description:`Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API.
|
|
320
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/search_volume/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_ads/search_volume/task_post/",example:[{location_name:"United States",keywords:["buy laptop","cheap laptops for sale","purchase laptop"]}]},{path:"/v3/keywords_data/google_ads/search_volume/tasks_ready",method:"get",operationId:"GoogleAdsSearchVolumeTasksReady",tag:"KeywordsData",description:`This endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
321
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/search_volume/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_ads/search_volume/tasks_ready/"},{path:"/v3/keywords_data/google_ads/search_volume/task_get/{id}",method:"get",operationId:"GoogleAdsSearchVolumeTaskGet",tag:"KeywordsData",description:`Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API.
|
|
322
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/search_volume/task_get/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_ads/search_volume/task_get/"},{path:"/v3/keywords_data/google_ads/search_volume/live",method:"post",operationId:"GoogleAdsSearchVolumeLive",tag:"KeywordsData",description:`Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API.
|
|
323
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/search_volume/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_ads/search_volume/live/",example:[{location_code:2840,keywords:["buy laptop","cheap laptops for sale","purchase laptop"],date_from:"2026-01-15",search_partners:!0}]},{path:"/v3/keywords_data/google_ads/keywords_for_site/task_post",method:"post",operationId:"GoogleAdsKeywordsForSiteTaskPost",tag:"KeywordsData",description:"for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_site/task_post/?bash'",docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_site/task_post/",example:[{location_code:2840,target:"dataforseo.com"}]},{path:"/v3/keywords_data/google_ads/keywords_for_site/tasks_ready",method:"get",operationId:"GoogleAdsKeywordsForSiteTasksReady",tag:"KeywordsData",description:`This endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
324
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_site/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_site/tasks_ready/"},{path:"/v3/keywords_data/google_ads/keywords_for_site/task_get/{id}",method:"get",operationId:"GoogleAdsKeywordsForSiteTaskGet",tag:"KeywordsData",description:`Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API.
|
|
325
|
+
|
|
326
|
+
This endpoint will provide you with a list of keywords relevant to the specified domain along with their bids, search volumes for the last month, search volume trends for the last year (for estimating search volume dynamics), and competition levels.
|
|
327
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_site/task_get/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_site/task_get/"},{path:"/v3/keywords_data/google_ads/keywords_for_site/live",method:"post",operationId:"GoogleAdsKeywordsForSiteLive",tag:"KeywordsData",description:`Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API.
|
|
328
|
+
|
|
329
|
+
This endpoint will provide you with a list of keywords relevant to the specified domain along with their bids, search volumes for the last month, search volume trends for the last year (for estimating search volume dynamics), and competition levels.
|
|
330
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_site/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_site/live/",example:[{location_code:2840,target:"dataforseo.com"}]},{path:"/v3/keywords_data/google_ads/keywords_for_keywords/task_post",method:"post",operationId:"GoogleAdsKeywordsForKeywordsTaskPost",tag:"KeywordsData",description:`Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API.
|
|
331
|
+
|
|
332
|
+
This endpoint will provide relevant keywords for the specified terms. Set up to 20 keywords in the keywords array and get keyword suggestions from Google Ads. You can get up to 20,000 keyword suggestions with all essential keyword data in response to one request.
|
|
333
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_keywords/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_keywords/task_post/",example:[{location_code:2840,keywords:["phone","cellphone"]}]},{path:"/v3/keywords_data/google_ads/keywords_for_keywords/tasks_ready",method:"get",operationId:"GoogleAdsKeywordsForKeywordsTasksReady",tag:"KeywordsData",description:`This endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
334
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_keywords/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_keywords/tasks_ready/"},{path:"/v3/keywords_data/google_ads/keywords_for_keywords/task_get/{id}",method:"get",operationId:"GoogleAdsKeywordsForKeywordsTaskGet",tag:"KeywordsData",description:`Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API.
|
|
335
|
+
|
|
336
|
+
This endpoint will select relevant keywords for the specified terms. Set up to 20 keywords and get the results, which are suggested by Google Ads for your query.
|
|
337
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_keywords/task_get/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_keywords/task_get/"},{path:"/v3/keywords_data/google_ads/keywords_for_keywords/live",method:"post",operationId:"GoogleAdsKeywordsForKeywordsLive",tag:"KeywordsData",description:`Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API.
|
|
338
|
+
|
|
339
|
+
This endpoint will provide relevant keywords for the specified terms. Set up to 20 keywords in the keywords array and get keyword suggestions from Google Ads.
|
|
340
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_keywords/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_ads/keywords_for_keywords/live/",example:[{location_code:2840,keywords:["phone","cellphone"]}]},{path:"/v3/keywords_data/google_ads/ad_traffic_by_keywords/task_post",method:"post",operationId:"GoogleAdsAdTrafficByKeywordsTaskPost",tag:"KeywordsData",description:"for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/ad_traffic_by_keywords/task_post/?bash'",docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_ads/ad_traffic_by_keywords/task_post/",example:[{language_code:"en",location_code:2840,bid:999,match:"exact",keywords:["seo marketing"]}]},{path:"/v3/keywords_data/google_ads/ad_traffic_by_keywords/tasks_ready",method:"get",operationId:"GoogleAdsAdTrafficByKeywordsTasksReady",tag:"KeywordsData",description:`This endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
341
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/ad_traffic_by_keywords/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_ads/ad_traffic_by_keywords/tasks_ready/"},{path:"/v3/keywords_data/google_ads/ad_traffic_by_keywords/task_get/{id}",method:"get",operationId:"GoogleAdsAdTrafficByKeywordsTaskGet",tag:"KeywordsData",description:"for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/ad_traffic_by_keywords/task_get/?bash'",docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_ads/ad_traffic_by_keywords/task_get/"},{path:"/v3/keywords_data/google_ads/ad_traffic_by_keywords/live",method:"post",operationId:"GoogleAdsAdTrafficByKeywordsLive",tag:"KeywordsData",description:"for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_ads/ad_traffic_by_keywords/live/?bash'",docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_ads/ad_traffic_by_keywords/live/",example:[{location_code:2840,language_code:"en",bid:999,match:"exact",keywords:["seo marketing"]}]},{path:"/v3/keywords_data/google_trends/locations",method:"get",operationId:"GoogleTrendsLocations",tag:"KeywordsData",description:"for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_trends/locations/?bash'",docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_trends/locations/"},{path:"/v3/keywords_data/google_trends/locations/{country}",method:"get",operationId:"GoogleTrendsLocationsCountry",tag:"KeywordsData",description:"for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_trends/locations/?bash'",docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_trends/locations/"},{path:"/v3/keywords_data/google_trends/languages",method:"get",operationId:"GoogleTrendsLanguages",tag:"KeywordsData",description:`By calling this API you will receive the list of languages supported by Google Trends API.
|
|
342
|
+
|
|
343
|
+
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information about available languages.
|
|
344
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_trends/languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_trends/languages/"},{path:"/v3/keywords_data/google_trends/categories",method:"get",operationId:"GoogleTrendsCategories",tag:"KeywordsData",description:`By calling this API you will receive the list of categories supported by Google Trends API.
|
|
345
|
+
|
|
346
|
+
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information about available categories.
|
|
347
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_trends/categories/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_trends/categories/"},{path:"/v3/keywords_data/google_trends/explore/task_post",method:"post",operationId:"GoogleTrendsExploreTaskPost",tag:"KeywordsData",description:`This endpoint will provide you with the keyword popularity data from the ‘Explore’ feature of Google Trends. You can check keyword trends for Google Search, Google News, Google Images, Google Shopping, and YouTube.
|
|
348
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_trends/explore/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_trends/explore/task_post/",example:[{date_from:"2026-01-15",date_to:"2026-03-15",type:"youtube",category_code:3,keywords:["seo api","rank api"]}]},{path:"/v3/keywords_data/google_trends/explore/tasks_ready",method:"get",operationId:"GoogleTrendsExploreTasksReady",tag:"KeywordsData",description:`This endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
349
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_trends/explore/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_trends/explore/tasks_ready/"},{path:"/v3/keywords_data/google_trends/explore/task_get/{id}",method:"get",operationId:"GoogleTrendsExploreTaskGet",tag:"KeywordsData",description:"for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_trends/explore/task_get/?bash'",docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_trends/explore/task_get/"},{path:"/v3/keywords_data/google_trends/explore/live",method:"post",operationId:"GoogleTrendsExploreLive",tag:"KeywordsData",description:`This endpoint will provide you with the keyword popularity data from the ‘Explore’ feature of Google Trends. You can check keyword trends for Google Search, Google News, Google Images, Google Shopping, and YouTube.
|
|
350
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/google_trends/explore/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/google_trends/explore/live/",example:[{location_name:"United States",date_from:"2026-01-15",date_to:"2026-03-15",type:"youtube",category_code:3,keywords:["rugby","cricket"]}]},{path:"/v3/keywords_data/dataforseo_trends/locations",method:"get",operationId:"DataforseoTrendsLocations",tag:"KeywordsData",description:`You will receive the list of DataForSEO Trends locations by calling this API. You can filter the list of locations by country when setting a task. Please note that the minimum geographic scope supported for the DataForSEO Trends API is country level.
|
|
351
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/dataforseo_trends/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/dataforseo_trends/locations/"},{path:"/v3/keywords_data/dataforseo_trends/locations/{country}",method:"get",operationId:"DataforseoTrendsLocationsCountry",tag:"KeywordsData",description:`You will receive the list of DataForSEO Trends locations by calling this API. You can filter the list of locations by country when setting a task. Please note that the minimum geographic scope supported for the DataForSEO Trends API is country level.
|
|
352
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/dataforseo_trends/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/dataforseo_trends/locations/"},{path:"/v3/keywords_data/dataforseo_trends/explore/live",method:"post",operationId:"DataforseoTrendsExploreLive",tag:"KeywordsData",description:`This endpoint will provide you with the keyword popularity data from DataForSEO Trends. You can check keyword trends for Google Search, Google News, and Google Shopping.
|
|
353
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/dataforseo_trends/explore/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/dataforseo_trends/explore/live/",example:[{keywords:["iphone 14","samsung s23"],location_code:2840}]},{path:"/v3/keywords_data/dataforseo_trends/subregion_interests/live",method:"post",operationId:"DataforseoTrendsSubregionInterestsLive",tag:"KeywordsData",description:`This endpoint will provide you with location-specific keyword popularity data from DataForSEO Trends. You can check keyword trends for Google Search, Google News, and Google Shopping.
|
|
354
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/dataforseo_trends/subregion_interests/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/dataforseo_trends/subregion_interests/live/",example:[{keywords:["rugby","cricket"],date_from:"2026-01-15",date_to:"2026-03-15",type:"web",location_name:"United States"}]},{path:"/v3/keywords_data/dataforseo_trends/demography/live",method:"post",operationId:"DataforseoTrendsDemographyLive",tag:"KeywordsData",description:`This endpoint will provide you with the demographic breakdown (by age and gender) of keyword popularity per each specified term based on DataForSEO Trends data. You can check keyword trends for Google Search, Google News, and Google Shopping.
|
|
355
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/dataforseo_trends/demography/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/dataforseo_trends/demography/live/",example:[{keywords:["rugby","cricket"],date_from:"2026-01-15",date_to:"2026-03-15",type:"web",location_name:"United States"}]},{path:"/v3/keywords_data/dataforseo_trends/merged_data/live",method:"post",operationId:"DataforseoTrendsMergedDataLive",tag:"KeywordsData",description:`This endpoint will provide you with the keyword popularity data from DataForSEO Trends. In addition to keyword popularity rate over the given time range, you will get location-specific keyword popularity data, and a demographic breakdown of keyword popularity per each specified term along with comparative values.
|
|
356
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/dataforseo_trends/merged_data/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/dataforseo_trends/merged_data/live/",example:[{keywords:["rugby","cricket"],date_from:"2026-01-15",date_to:"2026-03-15",type:"web",location_name:"United States"}]},{path:"/v3/keywords_data/bing/locations",method:"get",operationId:"KeywordsDataBingLocations",tag:"KeywordsData",description:`By calling this API you will receive the list of locations supported in Bing Ads API.
|
|
357
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/locations/"},{path:"/v3/keywords_data/bing/languages",method:"get",operationId:"KeywordsDataBingLanguages",tag:"KeywordsData",description:`By calling this API you will receive the list of languages supported by Bing Ads API.
|
|
358
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/languages/"},{path:"/v3/keywords_data/bing/search_volume/task_post",method:"post",operationId:"BingSearchVolumeTaskPost",tag:"KeywordsData",description:`This endpoint will provide you with search volume data for the last month, search volume trend for up to 24 past months (that will let you estimate search volume dynamics), current cost-per-click and competition values for paid search.
|
|
359
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/search_volume/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/search_volume/task_post/",example:[{location_name:"United States",language_name:"English",keywords:["average page rpm adsense","adsense blank ads how long","leads and prospects"]}]},{path:"/v3/keywords_data/bing/search_volume/tasks_ready",method:"get",operationId:"BingSearchVolumeTasksReady",tag:"KeywordsData",description:`This endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
360
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/search_volume/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/search_volume/tasks_ready/"},{path:"/v3/keywords_data/bing/search_volume/task_get/{id}",method:"get",operationId:"BingSearchVolumeTaskGet",tag:"KeywordsData",description:"for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/search_volume/task_get/?bash'",docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/search_volume/task_get/"},{path:"/v3/keywords_data/bing/search_volume/live",method:"post",operationId:"BingSearchVolumeLive",tag:"KeywordsData",description:`This endpoint will provide you with search volume data for the last month, search volume trend for up to 24 past months (that will let you estimate search volume dynamics), current cost-per-click and competition values for paid search.
|
|
361
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/search_volume/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/search_volume/live/",example:[{location_name:"United States",language_code:"en",keywords:["tom and jerry","silicon valley","spider man"]}]},{path:"/v3/keywords_data/bing/audience_estimation/job_functions",method:"get",operationId:"BingAudienceEstimationJobFunctions",tag:"KeywordsData",description:`By calling this API you will receive the list of job functions with job_function_id supported by Bing Ads Audience Estimation endpoint.
|
|
362
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/audience_estimation/job_functions/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/audience_estimation/job_functions/"},{path:"/v3/keywords_data/bing/audience_estimation/industries",method:"get",operationId:"BingAudienceEstimationIndustries",tag:"KeywordsData",description:`By calling this API you will receive the list of industries with industry_id supported by Bing Ads Audience Estimation endpoint.
|
|
363
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/audience_estimation/industries/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/audience_estimation/industries/"},{path:"/v3/keywords_data/bing/audience_estimation/task_post",method:"post",operationId:"BingAudienceEstimationTaskPost",tag:"KeywordsData",description:`This endpoint provides estimated audience size for an ad campaign based on specified targeting criteria. It returns data on the total estimated audience, such as suggested bid and budget for an ad campaign and estimated engagement metrics.
|
|
364
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/audience_estimation/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/audience_estimation/task_post/",example:[{location_coordinate:"29.6821525,-82.4098881,100",age:["twenty_five_to_thirty_four","eighteen_to_twenty_four","unknown"],bid:1,daily_budget:24,gender:["male"],industry:[806303407,806301758],job_function:[806298607]}]},{path:"/v3/keywords_data/bing/audience_estimation/tasks_ready",method:"get",operationId:"BingAudienceEstimationTasksReady",tag:"KeywordsData",description:`This endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
365
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/audience_estimation/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/audience_estimation/tasks_ready/"},{path:"/v3/keywords_data/bing/audience_estimation/task_get/{id}",method:"get",operationId:"BingAudienceEstimationTaskGet",tag:"KeywordsData",description:"for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/audience_estimation/task_get/?bash'",docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/audience_estimation/task_get/"},{path:"/v3/keywords_data/bing/audience_estimation/live",method:"post",operationId:"BingAudienceEstimationLive",tag:"KeywordsData",description:`This endpoint provides estimated audience size for an ad campaign based on specified targeting criteria. It returns data on the total estimated audience, such as suggested bid and budget for an ad campaign and estimated engagement metrics.
|
|
366
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/audience_estimation/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/audience_estimation/live/",example:[{location_coordinate:"29.6821525,-82.4098881,100",age:["twenty_five_to_thirty_four","eighteen_to_twenty_four","unknown"],bid:1,daily_budget:24,gender:["male"],industry:[806303407,806301758],job_function:[806298607]}]},{path:"/v3/keywords_data/bing/keywords_for_site/task_post",method:"post",operationId:"BingKeywordsForSiteTaskPost",tag:"KeywordsData",description:`This endpoint will provide you with a list of keywords relevant to the specified website along with their search volume for the last month, search volume trend for up to 24 past months (for estimating search volume dynamics), current cost-per-click and competition level for paid search. The maximum number of returned keywords is 3000.
|
|
367
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_site/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_site/task_post/",example:[{language_code:"en",location_code:2840,target:"dataforseo.com"}]},{path:"/v3/keywords_data/bing/keywords_for_site/tasks_ready",method:"get",operationId:"BingKeywordsForSiteTasksReady",tag:"KeywordsData",description:`This endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
368
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_site/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_site/tasks_ready/"},{path:"/v3/keywords_data/bing/keywords_for_site/task_get/{id}",method:"get",operationId:"BingKeywordsForSiteTaskGet",tag:"KeywordsData",description:`This endpoint will provide you with a list of keywords relevant to the specified website along with their search volume for the last month, search volume trend for the last year (for estimating search volume dynamics), current cost-per-click and competition level for paid search. The maximum number of returned keywords is 3000.
|
|
369
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_site/task_get/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_site/task_get/"},{path:"/v3/keywords_data/bing/keywords_for_site/live",method:"post",operationId:"BingKeywordsForSiteLive",tag:"KeywordsData",description:`This endpoint will provide you with a list of keywords relevant to the specified URL along with their search volume for the last month, search volume trend for up to 24 past months (for estimating search volume dynamics), current cost-per-click and competition values for paid search. The maximum number of returned keywords is 3000.
|
|
370
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_site/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_site/live/",example:[{language_code:"en",location_code:2840,target:"dataforseo.com"}]},{path:"/v3/keywords_data/bing/keywords_for_keywords/task_post",method:"post",operationId:"BingKeywordsForKeywordsTaskPost",tag:"KeywordsData",description:`This endpoint will select relevant keywords for the specified terms. Set up to 200 keywords and get the results, which are suggested by Bing Ads for your query. You can get up to 3000 keyword suggestions using this function.
|
|
371
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_keywords/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_keywords/task_post/",example:[{location_code:2840,language_code:"en",keywords:["average page rpm adsense","adsense blank ads how long","leads and prospects"]}]},{path:"/v3/keywords_data/bing/keywords_for_keywords/tasks_ready",method:"get",operationId:"BingKeywordsForKeywordsTasksReady",tag:"KeywordsData",description:`This endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
372
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_keywords/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_keywords/tasks_ready/"},{path:"/v3/keywords_data/bing/keywords_for_keywords/task_get/{id}",method:"get",operationId:"BingKeywordsForKeywordsTaskGet",tag:"KeywordsData",description:`This endpoint will select relevant keywords for the specified terms. Set up to 200 keywords and get the results, which are suggested by Bing Ads for your query. You can get up to 3000 keyword suggestions using this function.
|
|
373
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_keywords/task_get/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_keywords/task_get/"},{path:"/v3/keywords_data/bing/keywords_for_keywords/live",method:"post",operationId:"BingKeywordsForKeywordsLive",tag:"KeywordsData",description:`This endpoint will select the relevant keywords for the specified ones. Set up to 200 keywords and get the results, which are suggested by Bing Ads for your query. You can get up to 3000 keyword suggestions using this function.
|
|
374
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_keywords/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/keywords_for_keywords/live/",example:[{location_name:"United States",language_name:"English",keywords:["average page rpm adsense","adsense blank ads how long","leads and prospects"]}]},{path:"/v3/keywords_data/bing/keyword_performance/locations_and_languages",method:"get",operationId:"BingKeywordPerformanceLocationsAndLanguages",tag:"KeywordsData",description:`Using this endpoint you can get the full list of locations and languages supported in Keyword Performance endpoints of Bing Keywords Data API.
|
|
375
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages/"},{path:"/v3/keywords_data/bing/keyword_performance/task_post",method:"post",operationId:"BingKeywordPerformanceTaskPost",tag:"KeywordsData",description:`You can receive a set of keyword performance stats for a group of keywords depending on the specified match type, location and language parameters. Ad position, clicks, impressions, and other keyword metrics are aggregated for the last month for one or all of the following device types: mobile, desktop, tablet.
|
|
376
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keyword_performance/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/keyword_performance/task_post/",example:[{location_code:2840,language_code:"en",keywords:["dataforseo","seo","ranking"]}]},{path:"/v3/keywords_data/bing/keyword_performance/tasks_ready",method:"get",operationId:"BingKeywordPerformanceTasksReady",tag:"KeywordsData",description:`This endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
377
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keyword_performance/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/keyword_performance/tasks_ready/"},{path:"/v3/keywords_data/bing/keyword_performance/task_get/{id}",method:"get",operationId:"BingKeywordPerformanceTaskGet",tag:"KeywordsData",description:`You can receive a set of keyword performance stats for a group of keywords depending on the specified match type, location and language parameters. Ad position, clicks, impressions, and other keyword metrics are aggregated for the last month for one or all of the following device types: mobile, desktop, tablet.
|
|
378
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keyword_performance/task_get/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/keyword_performance/task_get/"},{path:"/v3/keywords_data/bing/keyword_performance/live",method:"post",operationId:"BingKeywordPerformanceLive",tag:"KeywordsData",description:`You can receive a set of keyword performance stats for a group of keywords depending on the specified match type, location and language parameters. Ad position, clicks, impressions, and other keyword metrics are aggregated for the last month for one or all of the following device types: mobile, desktop, tablet.
|
|
379
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/keyword_performance/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/keyword_performance/live/",example:[{location_code:2840,language_code:"en",keywords:["dataforseo","seo","ranking"]}]},{path:"/v3/keywords_data/bing/search_volume_history/locations_and_languages",method:"get",operationId:"BingSearchVolumeHistoryLocationsAndLanguages",tag:"KeywordsData",description:`By calling this API you will receive the list of locations and languages supported by Bing ‘Search Volume History’ endpoint.
|
|
380
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/search_volume_history/locations_and_languages/"},{path:"/v3/keywords_data/bing/search_volume_history/task_post",method:"post",operationId:"BingSearchVolumeHistoryTaskPost",tag:"KeywordsData",description:`This endpoint will provide you with historical search volume data for up to 1000 keywords in one request. You can get search volume for keywords in monthly, weekly, or daily format and specify the device type.
|
|
381
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/search_volume_history/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/search_volume_history/task_post/",example:[{location_code:2840,language_code:"en",keywords:["10 minute timer"]}]},{path:"/v3/keywords_data/bing/search_volume_history/tasks_ready",method:"get",operationId:"BingSearchVolumeHistoryTasksReady",tag:"KeywordsData",description:`This endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
382
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/search_volume_history/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/search_volume_history/tasks_ready/"},{path:"/v3/keywords_data/bing/search_volume_history/task_get/{id}",method:"get",operationId:"BingSearchVolumeHistoryTaskGet",tag:"KeywordsData",description:"for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/search_volume_history/task_get/?bash'",docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/search_volume_history/task_get/"},{path:"/v3/keywords_data/bing/search_volume_history/live",method:"post",operationId:"BingSearchVolumeHistoryLive",tag:"KeywordsData",description:`This endpoint will provide you with historical search volume data for up to 1000 keywords in one request. You can get search volume for keywords in monthly, weekly, or daily format and specify the device type.
|
|
383
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/bing/search_volume_history/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/bing/search_volume_history/live/",example:[{location_code:2840,language_code:"en",keywords:["10 minute timer"]}]},{path:"/v3/keywords_data/clickstream_data/locations_and_languages",method:"get",operationId:"ClickstreamDataLocationsAndLanguages",tag:"KeywordsData",description:`Using this endpoint you can get the full list of locations and languages supported in DataForSEO Clickstream Data API.
|
|
384
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages/"},{path:"/v3/keywords_data/clickstream_data/dataforseo_search_volume/live",method:"post",operationId:"ClickstreamDataDataforseoSearchVolumeLive",tag:"KeywordsData",description:"for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/clickstream_data/dataforseo_search_volume/live/?bash'",docUrl:"https://docs.dataforseo.com/v3/keywords_data/clickstream_data/dataforseo_search_volume/live/",example:[{location_code:2840,language_code:"en",tag:"test-tag",keywords:["you tube","youtube","youtub"]}]},{path:"/v3/keywords_data/clickstream_data/global_search_volume/live",method:"post",operationId:"ClickstreamDataGlobalSearchVolumeLive",tag:"KeywordsData",description:`
|
|
385
|
+
The Clickstream Global Search Volume endpoint of DataForSEO Keywords Data API is designed to provide clickstream-based search volume data for up to 1000 keywords in a single Live request. What’s more, it offers geographical distribution of clickstream search volume values across all available locations.
|
|
386
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/clickstream_data/global_search_volume/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/clickstream_data/global_search_volume/live/",example:[{tag:"test-tag",keywords:["you tube","youtube","youtub"]}]},{path:"/v3/keywords_data/clickstream_data/bulk_search_volume/live",method:"post",operationId:"ClickstreamDataBulkSearchVolumeLive",tag:"KeywordsData",description:`
|
|
387
|
+
The Bulk Clickstream Search Volume endpoint of DataForSEO Keywords Data API is designed to provide clickstream-based search volume data for up to 1000 keywords in a single Live request. What’s more, it offers historical search volume values for up to 12 months (depending on keywords, location, and language parameters).
|
|
388
|
+
for more info please visit 'https://docs.dataforseo.com/v3/keywords_data/clickstream_data/bulk_search_volume/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/keywords_data/clickstream_data/bulk_search_volume/live/",example:[{location_code:2840,tag:"test-tag",keywords:["you tube","youtube","youtub"]}]},{path:"/v3/backlinks/id_list",method:"post",operationId:"BacklinksIdList",tag:"Backlinks",description:`This endpoint is designed to provide you with a list of IDs and metadata for all Backlinks tasks created within the specified time period, including both successful and uncompleted tasks.
|
|
389
|
+
for more info please visit 'https://docs.dataforseo.com/v3/backlinks/id_list/?bash'`,docUrl:"https://docs.dataforseo.com/v3/backlinks/id_list/",example:[{datetime_from:"2026-04-12 04:39:39 +00:00",datetime_to:"2026-04-14 04:39:39 +00:00",limit:100,offset:0,sort:"desc",include_metadata:!0}]},{path:"/v3/backlinks/errors",method:"post",operationId:"BacklinksErrors",tag:"Backlinks",description:`By calling this endpoint you will receive information about the Backlinks API tasks that returned an error within the past 7 days.
|
|
390
|
+
for more info please visit 'https://docs.dataforseo.com/v3/backlinks/errors/?bash'`,docUrl:"https://docs.dataforseo.com/v3/backlinks/errors/",example:[{limit:10,offset:0,filtered_function:"backlinks/content_duplicates"}]},{path:"/v3/backlinks/available_filters",method:"get",operationId:"BacklinksAvailableFilters",tag:"Backlinks",description:`Backlinks API features plenty of parameters that support custom filtration. By applying filters to your POST requests, you will be able to effortlessly extract data that matches your requirements. Note that we do not charge any fees for using data filtering or sorting rules.
|
|
391
|
+
|
|
392
|
+
Here you will find all the necessary information about filters that can be used with DataForSEO Backlinks API endpoints.
|
|
393
|
+
for more info please visit 'https://docs.dataforseo.com/v3/backlinks/filters/?bash'`,docUrl:"https://docs.dataforseo.com/v3/backlinks/filters/"},{path:"/v3/backlinks/index",method:"get",operationId:"Index",tag:"Backlinks",description:`This endpoint will provide you with the total number of backlinks, domains, and pages our database contains for the moment when you make a request. You will also get stats for the last 12 months.
|
|
394
|
+
for more info please visit 'https://docs.dataforseo.com/v3/backlinks/index/?bash'`,docUrl:"https://docs.dataforseo.com/v3/backlinks/index/"},{path:"/v3/backlinks/summary/live",method:"post",operationId:"SummaryLive",tag:"Backlinks",description:`This endpoint will provide you with an overview of backlinks data available for a given domain, subdomain, or webpage.
|
|
395
|
+
for more info please visit 'https://docs.dataforseo.com/v3/backlinks/summary/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/backlinks/summary/live/",example:[{target:"explodingtopics.com",internal_list_limit:10,include_subdomains:!0,backlinks_filters:["dofollow","=",!0],backlinks_status_type:"all"}]},{path:"/v3/backlinks/history/live",method:"post",operationId:"HistoryLive",tag:"Backlinks",description:`This endpoint will provide you with historical backlinks data back to the beginning of 2019. You can receive the number of backlinks a given domain had in a specific time period, the number of new & lost backlinks, referring domains, and more.
|
|
396
|
+
for more info please visit 'https://docs.dataforseo.com/v3/backlinks/history/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/backlinks/history/live/",example:[{target:"cnn.com",date_from:"2026-01-15",date_to:"2026-03-15"}]},{path:"/v3/backlinks/backlinks/live",method:"post",operationId:"BacklinksLive",tag:"Backlinks",description:`This endpoint will provide you with a list of backlinks and relevant data for the specified domain, subdomain, or webpage.
|
|
397
|
+
for more info please visit 'https://docs.dataforseo.com/v3/backlinks/backlinks/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/backlinks/backlinks/live/",example:[{target:"forbes.com",mode:"as_is",filters:["dofollow","=",!0],limit:5}]},{path:"/v3/backlinks/anchors/live",method:"post",operationId:"AnchorsLive",tag:"Backlinks",description:`This endpoint will provide you with a detailed overview of anchors used when linking to the specified website with relevant backlink data for each of them.
|
|
398
|
+
for more info please visit 'https://docs.dataforseo.com/v3/backlinks/anchors/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/backlinks/anchors/live/",example:[{target:"forbes.com",limit:4,order_by:["backlinks,desc"],filters:["anchor","like","%news%"]}]},{path:"/v3/backlinks/domain_pages/live",method:"post",operationId:"DomainPagesLive",tag:"Backlinks",description:`This endpoint will provide you with a detailed overview of domain pages with backlink data for each page.
|
|
399
|
+
for more info please visit 'https://docs.dataforseo.com/v3/backlinks/domain_pages/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/backlinks/domain_pages/live/",example:[{target:"forbes.com",limit:5,filters:[["page_summary.backlinks",">",5],"and",["page","like","%sites%"]]}]},{path:"/v3/backlinks/domain_pages_summary/live",method:"post",operationId:"DomainPagesSummaryLive",tag:"Backlinks",description:`This endpoint will provide you with detailed summary data on all backlinks and related metrics for each page of the target domain or subdomain you specify. If you indicate a single page as a target, you will get comprehensive summary data on all backlinks for that page.
|
|
400
|
+
for more info please visit 'https://docs.dataforseo.com/v3/backlinks/domain_pages_summary/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/backlinks/domain_pages_summary/live/",example:[{target:"forbes.com",limit:4,order_by:["backlinks,desc"]}]},{path:"/v3/backlinks/referring_domains/live",method:"post",operationId:"ReferringDomainsLive",tag:"Backlinks",description:`This endpoint will provide you with a detailed overview of referring domains pointing to the target you specify.
|
|
401
|
+
for more info please visit 'https://docs.dataforseo.com/v3/backlinks/referring_domains/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/backlinks/referring_domains/live/",example:[{target:"backlinko.com",limit:5,order_by:["rank,desc"],exclude_internal_backlinks:!0,backlinks_filters:["dofollow","=",!0],filters:["backlinks",">",100]}]},{path:"/v3/backlinks/referring_networks/live",method:"post",operationId:"ReferringNetworksLive",tag:"Backlinks",description:`This endpoint will provide you with a detailed overview of referring IPs and subnets pointing to the target you specify.
|
|
402
|
+
for more info please visit 'https://docs.dataforseo.com/v3/backlinks/referring_networks/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/backlinks/referring_networks/live/",example:[{target:"backlinko.com",network_address_type:"subnet",limit:5,order_by:["rank,desc"],exclude_internal_backlinks:!0,backlinks_filters:["dofollow","=",!0],filters:["backlinks",">",100]}]},{path:"/v3/backlinks/competitors/live",method:"post",operationId:"CompetitorsLive",tag:"Backlinks",description:`This endpoint will provide you with a list of competitors that share some part of the backlink profile with a target website, along with a number of backlink intersections and the rank of every competing website.
|
|
403
|
+
for more info please visit 'https://docs.dataforseo.com/v3/backlinks/competitors/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/backlinks/competitors/live/",example:[{target:"dataforseo.com",filters:["rank",">",100],order_by:["rank,desc"],limit:5}]},{path:"/v3/backlinks/domain_intersection/live",method:"post",operationId:"DomainIntersectionLive",tag:"Backlinks",description:`This endpoint will provide you with the list of domains pointing to the specified websites. This endpoint is especially useful for creating a Link Gap feature that shows what domains link to your competitors but do not link out to your website.
|
|
404
|
+
for more info please visit 'https://docs.dataforseo.com/v3/backlinks/domain_intersection/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/backlinks/domain_intersection/live/",example:[{targets:{"1":"moz.com","2":"ahrefs.com"},include_subdomains:!1,exclude_targets:["semrush.com"],limit:5,order_by:["1.backlinks,desc"],exclude_internal_backlinks:!0}]},{path:"/v3/backlinks/page_intersection/live",method:"post",operationId:"PageIntersectionLive",tag:"Backlinks",description:`This endpoint will provide you with the list of referring pages pointing to the specified targets. It is especially useful for finding the backlinks that point to your competitors but don’t point to your website.
|
|
405
|
+
for more info please visit 'https://docs.dataforseo.com/v3/backlinks/page_intersection/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/backlinks/page_intersection/live/",example:[{targets:{"1":"football.com","2":"fifa.com"},exclude_targets:["skysports.com"],limit:5,order_by:["1.rank,desc"],filters:[["2.domain_from_rank",">",400],"and",["1.dofollow","=",!0]]}]},{path:"/v3/backlinks/timeseries_summary/live",method:"post",operationId:"TimeseriesSummaryLive",tag:"Backlinks",description:`This endpoint will provide you with an overview of backlink data for the target domain available during a period between the two indicated dates. Backlink metrics will be grouped by the time range that you define: day, week, month, or year.
|
|
406
|
+
for more info please visit 'https://docs.dataforseo.com/v3/backlinks/timeseries_summary/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/backlinks/timeseries_summary/live/",example:[{target:"dataforseo.com",date_from:"2026-01-15",date_to:"2026-03-15",group_range:"month"}]},{path:"/v3/backlinks/timeseries_new_lost_summary/live",method:"post",operationId:"TimeseriesNewLostSummaryLive",tag:"Backlinks",description:`This endpoint will provide you with the number of new and lost backlinks and referring domains for the domain specified in the target field.
|
|
407
|
+
for more info please visit 'https://docs.dataforseo.com/v3/backlinks/timeseries_new_lost_summary/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/backlinks/timeseries_new_lost_summary/live/",example:[{target:"dataforseo.com",date_from:"2026-01-15",date_to:"2026-03-15",group_range:"month"}]},{path:"/v3/backlinks/bulk_ranks/live",method:"post",operationId:"BulkRanksLive",tag:"Backlinks",description:`This endpoint will provide you with rank scores of the domains, subdomains, and pages specified in the targets array. The score is based on the number of referring domains pointing to the specified domains, subdomains, or pages. The rank values represent real-time data for the date of the request and range from 0 (no backlinks detected) to 1,000 (highest rank). A similar scoring system is used in Google’s Page Rank algorithm. You can learn more about rank scores in this help center article
|
|
408
|
+
for more info please visit 'https://docs.dataforseo.com/v3/backlinks/bulk_ranks/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/backlinks/bulk_ranks/live/",example:[{targets:["forbes.com","cnn.com","bbc.com","yelp.com","https://www.apple.com/iphone/","https://ahrefs.com/blog/","ibm.com","https://variety.com/","https://stackoverflow.com/","www.trustpilot.com"]}]},{path:"/v3/backlinks/bulk_backlinks/live",method:"post",operationId:"BulkBacklinksLive",tag:"Backlinks",description:`This endpoint will provide you with the number of backlinks pointing to domains, subdomains, and pages specified in the targets array. The returned numbers correspond to all live backlinks, that is, total number of referring links with all attributes (e.g., nofollow, noreferrer, ugc, sponsored etc) that were found during the latest check.
|
|
409
|
+
for more info please visit 'https://docs.dataforseo.com/v3/backlinks/bulk_backlinks/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/backlinks/bulk_backlinks/live/",example:[{targets:["forbes.com","cnn.com","bbc.com","yelp.com","https://www.apple.com/iphone/","https://ahrefs.com/blog/","ibm.com","https://variety.com/","https://stackoverflow.com/","www.trustpilot.com"]}]},{path:"/v3/backlinks/bulk_spam_score/live",method:"post",operationId:"BulkSpamScoreLive",tag:"Backlinks",description:`This endpoint will provide you with spam scores of the domains, subdomains, and pages you specified in the targets array. Spam Score is DataForSEO’s proprietary metric that indicates how “spammy” your target is on a scale from 0 to 100. You can learn more about Spam Score, how it is calculated, and signals it takes into account in this help center article
|
|
410
|
+
for more info please visit 'https://docs.dataforseo.com/v3/backlinks/bulk_spam_score/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/backlinks/bulk_spam_score/live/",example:[{targets:["forbes.com","cnn.com","bbc.com","yelp.com","https://www.apple.com/iphone/","https://ahrefs.com/blog/","ibm.com","https://variety.com/","https://stackoverflow.com/","www.trustpilot.com"]}]},{path:"/v3/backlinks/bulk_referring_domains/live",method:"post",operationId:"BulkReferringDomainsLive",tag:"Backlinks",description:`This endpoint will provide you with the number of referring domains pointing to domains, subdomains, and pages specified in the targets array. The returned numbers are based on all live referring domains, that is, total number of domains pointing to the target with any type of backlinks (e.g., nofollow, noreferrer, ugc, sponsored etc) that were found during the latest check.
|
|
411
|
+
for more info please visit 'https://docs.dataforseo.com/v3/backlinks/bulk_referring_domains/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/backlinks/bulk_referring_domains/live/",example:[{targets:["forbes.com","cnn.com","bbc.com","yelp.com","https://www.apple.com/iphone/","https://ahrefs.com/blog/","ibm.com","https://variety.com/","https://stackoverflow.com/","www.trustpilot.com"]}]},{path:"/v3/backlinks/bulk_new_lost_backlinks/live",method:"post",operationId:"BulkNewLostBacklinksLive",tag:"Backlinks",description:`This endpoint will provide you with the number of new and lost backlinks for the domains, subdomains, and pages specified in the targets array.
|
|
412
|
+
for more info please visit 'https://docs.dataforseo.com/v3/backlinks/bulk_new_lost_backlinks/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/backlinks/bulk_new_lost_backlinks/live/",example:[{targets:["forbes.com","cnn.com","bbc.com","yelp.com","https://www.apple.com/iphone/","https://ahrefs.com/blog/","ibm.com","https://variety.com/","https://stackoverflow.com/","www.trustpilot.com"],date_from:"2026-01-15"}]},{path:"/v3/backlinks/bulk_new_lost_referring_domains/live",method:"post",operationId:"BulkNewLostReferringDomainsLive",tag:"Backlinks",description:`This endpoint will provide you with the number of referring domains pointing to the domains, subdomains and pages specified in the targets array.
|
|
413
|
+
for more info please visit 'https://docs.dataforseo.com/v3/backlinks/bulk_new_lost_referring_domains/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/backlinks/bulk_new_lost_referring_domains/live/",example:[{targets:["forbes.com","cnn.com","bbc.com","yelp.com","https://www.apple.com/iphone/","https://ahrefs.com/blog/","ibm.com","https://variety.com/","https://stackoverflow.com/","www.trustpilot.com"],date_from:"2026-01-15"}]},{path:"/v3/backlinks/bulk_pages_summary/live",method:"post",operationId:"BulkPagesSummaryLive",tag:"Backlinks",description:`This endpoint will provide you with a comprehensive overview of backlinks and related data for a bulk of up to 1000 pages, domains, or subdomains. If you indicate a single page as a target, you will get comprehensive summary data on all backlinks for that page.
|
|
414
|
+
for more info please visit 'https://docs.dataforseo.com/v3/backlinks/bulk_pages_summary/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/backlinks/bulk_pages_summary/live/",example:[{targets:["https://dataforseo.com/solutions","https://dataforseo.com/about-us"]}]},{path:"/v3/ai_optimization/chat_gpt/llm_scraper/locations",method:"get",operationId:"ChatGptLlmScraperLocations",tag:"AiOptimization",description:`You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
|
|
415
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/locations/"},{path:"/v3/ai_optimization/chat_gpt/llm_scraper/locations/{country}",method:"get",operationId:"ChatGptLlmScraperLocationsCountry",tag:"AiOptimization",description:`You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
|
|
416
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/locations/"},{path:"/v3/ai_optimization/chat_gpt/llm_scraper/languages",method:"get",operationId:"ChatGptLlmScraperLanguages",tag:"AiOptimization",description:`You will receive the list of languages by calling this API.
|
|
417
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/languages/"},{path:"/v3/ai_optimization/chat_gpt/llm_scraper/task_post",method:"post",operationId:"ChatGptLlmScraperTaskPost",tag:"AiOptimization",description:`ChatGPT LLM Scraper API provides results from ChatGPT searches. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) parameters.
|
|
418
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/task_post/",example:[{language_code:"en",location_code:2840,keyword:"what is chatgpt"}]},{path:"/v3/ai_optimization/chat_gpt/llm_scraper/tasks_ready",method:"get",operationId:"ChatGptLlmScraperTasksReady",tag:"AiOptimization",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
419
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
420
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/tasks_ready/"},{path:"/v3/ai_optimization/chat_gpt/llm_scraper/task_get/advanced/{id}",method:"get",operationId:"ChatGptLlmScraperTaskGetAdvanced",tag:"AiOptimization",description:`Description of the fields for sending a request:
|
|
421
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/task_get/advanced/"},{path:"/v3/ai_optimization/chat_gpt/llm_scraper/task_get/html/{id}",method:"get",operationId:"ChatGptLlmScraperTaskGetHtml",tag:"AiOptimization",description:`Description of the fields for sending a request:
|
|
422
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/task_get/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/task_get/html/"},{path:"/v3/ai_optimization/chat_gpt/llm_scraper/live/advanced",method:"post",operationId:"ChatGptLlmScraperLiveAdvanced",tag:"AiOptimization",description:`Live ChatGPT LLM Scraper endpoint provides results from ChatGPT searches. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) parameters.
|
|
423
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/live/advanced/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/live/advanced/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein"}]},{path:"/v3/ai_optimization/chat_gpt/llm_scraper/live/html",method:"post",operationId:"ChatGptLlmScraperLiveHtml",tag:"AiOptimization",description:`Live ChatGPT LLM Scraper API HTML provides a raw HTML page of the results for the specified keyword, language, and location.
|
|
424
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/live/html/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/live/html/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein"}]},{path:"/v3/ai_optimization/llm_mentions/locations_and_languages",method:"get",operationId:"LlmMentionsLocationsAndLanguages",tag:"AiOptimization",description:`Using this endpoint you can get the full list of locations and languages supported in AI Optimization LLM Mentions API.
|
|
425
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages/"},{path:"/v3/ai_optimization/llm_mentions/available_filters",method:"get",operationId:"LlmMentionsAvailableFilters",tag:"AiOptimization",description:`Here you will find all the necessary information about filters that can be used with AI Optimization LLM Mentions API endpoints.
|
|
426
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/llm_mentions/filters/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/llm_mentions/filters/"},{path:"/v3/ai_optimization/llm_mentions/search/live",method:"post",operationId:"LlmMentionsSearchLive",tag:"AiOptimization",description:`Live LLM Mentions Search endpoint provides mention data and related metrics from AI searches. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), as well as location and language parameters (see the List of Locations & Languages).
|
|
427
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/llm_mentions/search/live/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/llm_mentions/search/live/",example:[{language_name:"English",location_code:2840,target:[{domain:"dataforseo.com",search_filter:"exclude"},{keyword:"bmw",search_scope:["answer"]}],platform:"google",filters:[["ai_search_volume",">",1000]],order_by:["ai_search_volume,desc"],offset:0,limit:3}]},{path:"/v3/ai_optimization/llm_mentions/top_pages/live",method:"post",operationId:"LlmMentionsTopPagesLive",tag:"AiOptimization",description:`Live LLM Mentions Top Pages endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned pages for the specified target. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages).
|
|
428
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/llm_mentions/top_pages/live/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/llm_mentions/top_pages/live/",example:[{language_code:"en",location_code:2840,platform:"google",target:[{keyword:"bmw",search_scope:["answer"]},{keyword:"auto",search_scope:["question"],match_type:"partial_match"}],links_scope:"sources",initial_dataset_filters:[["ai_search_volume",">",10]],items_list_limit:3,internal_list_limit:2}]},{path:"/v3/ai_optimization/llm_mentions/top_domains/live",method:"post",operationId:"LlmMentionsTopDomainsLive",tag:"AiOptimization",description:`Live LLM Mentions Top Domains endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned domains for the specified target. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages).
|
|
429
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/llm_mentions/top_domains/live/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/llm_mentions/top_domains/live/",example:[{language_code:"en",location_code:2840,platform:"chat_gpt",target:[{keyword:"bmw",search_scope:["answer"]},{keyword:"auto",search_scope:["question"],match_type:"partial_match"}],links_scope:"sources",initial_dataset_filters:[["ai_search_volume",">",10]],items_list_limit:3,internal_list_limit:2}]},{path:"/v3/ai_optimization/llm_mentions/aggregated_metrics/live",method:"post",operationId:"LlmMentionsAggregatedMetricsLive",tag:"AiOptimization",description:`Live LLM Mentions endpoint provides aggregated metrics for mentions of the keywords or domains specified in the target array of the request. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages).
|
|
430
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/llm_mentions/aggregated_metrics/live/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/llm_mentions/aggregated_metrics/live/",example:[{language_code:"es",location_code:2840,platform:"google",target:[{domain:"en.wikipedia.org",search_filter:"exclude"},{keyword:"bmw",search_scope:["answer"]}],initial_dataset_filters:[["ai_search_volume",">",10]],internal_list_limit:10}]},{path:"/v3/ai_optimization/llm_mentions/cross_aggregated_metrics/live",method:"post",operationId:"LlmMentionsCrossAggregatedMetricsLive",tag:"AiOptimization",description:`Live LLM Mentions endpoint provides aggregated metrics grouped by custom keys for mentions of the keywords or domains specified in the target array of the request. Each item in the results array corresponds to the specified target. The results are specific to the selected platform (google for Google’s AI Overview or chat_gpt for ChatGPT), location and language parameters (see the List of Locations & Languages).
|
|
431
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/llm_mentions/cross_aggregated_metrics/live/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/llm_mentions/cross_aggregated_metrics/live/",example:[{language_code:"en",location_code:2840,platform:"google",targets:[{aggregation_key:"chat_gpt",target:[{keyword:"chat gpt"}]},{aggregation_key:"claude",target:[{keyword:"claude"}]},{aggregation_key:"gemini",target:[{keyword:"gemini"}]},{aggregation_key:"perplexity",target:[{keyword:"perplexity",search_filter:"include"}]}],initial_dataset_filters:[["ai_search_volume",">",10]],internal_list_limit:5}]},{path:"/v3/ai_optimization/chat_gpt/llm_responses/models",method:"get",operationId:"ChatGptLlmResponsesModels",tag:"AiOptimization",description:`You will receive the list of available Chat GPT AI models by calling this API.
|
|
432
|
+
|
|
433
|
+
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
|
|
434
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_responses/models/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_responses/models/"},{path:"/v3/ai_optimization/chat_gpt/llm_responses/live",method:"post",operationId:"ChatGptLlmResponsesLive",tag:"AiOptimization",description:`Live ChatGPT LLM Responses endpoint allows you to retrieve structured responses from a specific ChatGPT AI model, based on the input parameters.
|
|
435
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_responses/live/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_responses/live/",example:[{system_message:"communicate as if we are in a business meeting",message_chain:[{role:"user",message:"Hello, what’s up?"},{role:"ai",message:"Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?"}],max_output_tokens:200,temperature:0.3,top_p:0.5,model_name:"gpt-4.1-mini",web_search:!0,web_search_country_iso_code:"FR",web_search_city:"Paris",user_prompt:"provide information on how relevant the amusement park business is in France now"}]},{path:"/v3/ai_optimization/chat_gpt/llm_responses/task_post",method:"post",operationId:"ChatGptLlmResponsesTaskPost",tag:"AiOptimization",description:`ChatGPT LLM Responses endpoint allows you to retrieve structured responses from a specific ChatGPT model, based on the input parameters.
|
|
436
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_responses/task_post/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_responses/task_post/",example:[{system_message:"communicate as if we are in a business meeting",message_chain:[{role:"user",message:"Hello, what’s up?"},{role:"ai",message:"Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?"}],model_name:"gpt-4.1-mini",user_prompt:"provide information on how relevant the amusement park business is in France now"}]},{path:"/v3/ai_optimization/chat_gpt/llm_responses/tasks_ready",method:"get",operationId:"ChatGptLlmResponsesTasksReady",tag:"AiOptimization",description:`This endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
437
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_responses/tasks_ready/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_responses/tasks_ready/"},{path:"/v3/ai_optimization/chat_gpt/llm_responses/task_get/{id}",method:"get",operationId:"ChatGptLlmResponsesTaskGet",tag:"AiOptimization",description:`Chat GPT LLM Responses endpoint allows you to retrieve structured responses from a specific Chat GPT model, based on the input parameters.
|
|
438
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_responses/task_get/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/chat_gpt/llm_responses/task_get/"},{path:"/v3/ai_optimization/claude/llm_responses/models",method:"get",operationId:"ClaudeLlmResponsesModels",tag:"AiOptimization",description:`You will receive the list of available Claude AI models by calling this API.
|
|
439
|
+
|
|
440
|
+
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
|
|
441
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/claude/llm_responses/models/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/claude/llm_responses/models/"},{path:"/v3/ai_optimization/claude/llm_responses/live",method:"post",operationId:"ClaudeLlmResponsesLive",tag:"AiOptimization",description:`Live Claude LLM Responses endpoint allows you to retrieve structured responses from a specific Claude model, based on the input parameters.
|
|
442
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/claude/llm_responses/live/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/claude/llm_responses/live/",example:[{system_message:"communicate as if we are in a business meeting",message_chain:[{role:"user",message:"Hello, what’s up?"},{role:"ai",message:"Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?"}],max_output_tokens:200,model_name:"claude-opus-4-0",temperature:0.3,web_search:!0,web_search_country_iso_code:"FR",user_prompt:"provide information on how relevant the amusement park business is in France now"}]},{path:"/v3/ai_optimization/claude/llm_responses/task_post",method:"post",operationId:"ClaudeLlmResponsesTaskPost",tag:"AiOptimization",description:`Claude LLM Responses endpoint allows you to retrieve structured responses from a specific Claude model, based on the input parameters.
|
|
443
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/claude/llm_responses/task_post/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/claude/llm_responses/task_post/",example:[{system_message:"communicate as if we are in a business meeting",message_chain:[{role:"user",message:"Hello, what’s up?"},{role:"ai",message:"Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?"}],max_output_tokens:1024,temperature:0.3,web_search_country_iso_code:"FR",model_name:"claude-sonnet-4-0",web_search:!0,user_prompt:"provide information on how relevant the amusement park business is in France now"}]},{path:"/v3/ai_optimization/claude/llm_responses/tasks_ready",method:"get",operationId:"ClaudeLlmResponsesTasksReady",tag:"AiOptimization",description:`This endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
444
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/claude/llm_responses/tasks_ready/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/claude/llm_responses/tasks_ready/"},{path:"/v3/ai_optimization/claude/llm_responses/task_get/{id}",method:"get",operationId:"ClaudeLlmResponsesTaskGet",tag:"AiOptimization",description:`Claude LLM Responses endpoint allows you to retrieve structured responses from a specific Claude model, based on the input parameters.
|
|
445
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/claude/llm_responses/task_get/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/claude/llm_responses/task_get/"},{path:"/v3/ai_optimization/gemini/llm_responses/models",method:"get",operationId:"GeminiLlmResponsesModels",tag:"AiOptimization",description:`You will receive the list of available Gemini AI models by calling this API.
|
|
446
|
+
|
|
447
|
+
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
|
|
448
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_responses/models/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_responses/models/"},{path:"/v3/ai_optimization/gemini/llm_responses/task_post",method:"post",operationId:"GeminiLlmResponsesTaskPost",tag:"AiOptimization",description:`Gemini LLM Responses endpoint allows you to retrieve structured responses from a specific Gemini model, based on the input parameters.
|
|
449
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_responses/task_post/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_responses/task_post/",example:[{system_message:"communicate as if we are in a business meeting",message_chain:[{role:"user",message:"Hello, what’s up?"},{role:"ai",message:"Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?"}],model_name:"gemini-2.5-flash",user_prompt:"provide information on how relevant the amusement park business is in France now"}]},{path:"/v3/ai_optimization/gemini/llm_responses/tasks_ready",method:"get",operationId:"GeminiLlmResponsesTasksReady",tag:"AiOptimization",description:`This endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
450
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_responses/tasks_ready/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_responses/tasks_ready/"},{path:"/v3/ai_optimization/gemini/llm_responses/task_get/{id}",method:"get",operationId:"GeminiLlmResponsesTaskGet",tag:"AiOptimization",description:`Gemini LLM Responses endpoint allows you to retrieve structured responses from a specific Gemini model, based on the input parameters.
|
|
451
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_responses/task_get/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_responses/task_get/"},{path:"/v3/ai_optimization/gemini/llm_responses/live",method:"post",operationId:"GeminiLlmResponsesLive",tag:"AiOptimization",description:`Live Gemini LLM Responses endpoint allows you to retrieve structured responses from a specific Gemini AI model, based on the input parameters.
|
|
452
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_responses/live/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_responses/live/",example:[{system_message:"communicate as if we are in a business meeting",message_chain:[{role:"user",message:"Hello, what’s up?"},{role:"ai",message:"Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?"}],max_output_tokens:200,temperature:0.3,top_p:0.5,model_name:"gemini-2.5-flash",web_search:!0,user_prompt:"provide information on how relevant the amusement park business is in France now"}]},{path:"/v3/ai_optimization/gemini/llm_scraper/locations",method:"get",operationId:"GeminiLlmScraperLocations",tag:"AiOptimization",description:`You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
|
|
453
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/locations/"},{path:"/v3/ai_optimization/gemini/llm_scraper/languages",method:"get",operationId:"GeminiLlmScraperLanguages",tag:"AiOptimization",description:`You will receive the list of languages by calling this API.
|
|
454
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/languages/"},{path:"/v3/ai_optimization/gemini/llm_scraper/task_post",method:"post",operationId:"GeminiLlmScraperTaskPost",tag:"AiOptimization",description:`Gemini LLM Scraper API provides structured results from Gemini. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages), and keyword.
|
|
455
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/task_post/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein"}]},{path:"/v3/ai_optimization/gemini/llm_scraper/tasks_ready",method:"get",operationId:"GeminiLlmScraperTasksReady",tag:"AiOptimization",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
456
|
+
Learn more about task completion and obtaining a list of completed tasks in this help center article.
|
|
457
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/tasks_ready/"},{path:"/v3/ai_optimization/gemini/llm_scraper/task_get/advanced/{id}",method:"get",operationId:"GeminiLlmScraperTaskGetAdvanced",tag:"AiOptimization",description:`Description of the fields for sending a request:
|
|
458
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/task_get/advanced/"},{path:"/v3/ai_optimization/gemini/llm_scraper/task_get/html/{id}",method:"get",operationId:"GeminiLlmScraperTaskGetHtml",tag:"AiOptimization",description:`Description of the fields for sending a request:
|
|
459
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/task_get/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/task_get/html/"},{path:"/v3/ai_optimization/gemini/llm_scraper/live/advanced",method:"post",operationId:"GeminiLlmScraperLiveAdvanced",tag:"AiOptimization",description:`Live Gemini LLM Scraper endpoint provides structured results from Gemini. The results are specific to the selected location (see the List of Locations), language (see the List of Languages), and keyword.
|
|
460
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/live/advanced/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/live/advanced/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein"}]},{path:"/v3/ai_optimization/gemini/llm_scraper/live/html",method:"post",operationId:"GeminiLlmScraperLiveHtml",tag:"AiOptimization",description:`Live Gemini LLM Scraper API HTML provides a raw HTML page of the results for the specified keyword, language (see the List of Languages), and location (see the List of Locations).
|
|
461
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/live/html/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/gemini/llm_scraper/live/html/",example:[{language_code:"en",location_code:2840,keyword:"albert einstein"}]},{path:"/v3/ai_optimization/perplexity/llm_responses/models",method:"get",operationId:"PerplexityLlmResponsesModels",tag:"AiOptimization",description:`You will receive the list of available Perplexity AI models by calling this API.
|
|
462
|
+
|
|
463
|
+
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
|
|
464
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/perplexity/llm_responses/models/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/perplexity/llm_responses/models/"},{path:"/v3/ai_optimization/perplexity/llm_responses/live",method:"post",operationId:"PerplexityLlmResponsesLive",tag:"AiOptimization",description:`Live Perplexity LLM Responses endpoint allows you to retrieve structured responses from a specific Perplexity AI model, based on the input parameters.
|
|
465
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/perplexity/llm_responses/live/'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/perplexity/llm_responses/live/",example:[{system_message:"communicate as if we are in a business meeting",message_chain:[{role:"user",message:"Hello, what’s up?"},{role:"ai",message:"Hello! I’m doing well, thank you. How can I assist you today? Are there any specific topics or projects you’d like to discuss in our meeting?"}],max_output_tokens:200,temperature:0.3,top_p:0.5,web_search_country_iso_code:"FR",model_name:"sonar",user_prompt:"provide information on how relevant the amusement park business is in France now"}]},{path:"/v3/ai_optimization/ai_keyword_data/available_filters",method:"get",operationId:"AiKeywordDataAvailableFilters",tag:"AiOptimization",description:`Here you will find all the necessary information about filters that can be used with AI Keyword Data API endpoints.
|
|
466
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/ai_keyword_data/available_filters'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/ai_keyword_data/available_filters"},{path:"/v3/ai_optimization/ai_keyword_data/locations_and_languages",method:"get",operationId:"AiKeywordDataLocationsAndLanguages",tag:"AiOptimization",description:`Using this endpoint you can get the full list of locations and languages supported in AI Keyword Data API.
|
|
467
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/ai_keyword_data/locations_and_languages'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/ai_keyword_data/locations_and_languages"},{path:"/v3/ai_optimization/ai_keyword_data/keywords_search_volume/live",method:"post",operationId:"AiKeywordDataKeywordsSearchVolumeLive",tag:"AiOptimization",description:`This endpoint provides search volume data for your target keywords, reflecting their estimated usage in AI tools.
|
|
468
|
+
for more info please visit 'https://docs.dataforseo.com/v3/ai_optimization/ai_keyword_data/keywords_search_volume/live'`,docUrl:"https://docs.dataforseo.com/v3/ai_optimization/ai_keyword_data/keywords_search_volume/live",example:[{language_name:"English",location_code:2840,keywords:["iphone","seo"]}]},{path:"/v3/on_page/id_list",method:"post",operationId:"OnPageIdList",tag:"OnPage",description:`This endpoint is designed to provide you with a list of IDs and metadata for all On-Page tasks created within the specified time period, including both successful and uncompleted tasks.
|
|
469
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/id_list/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/id_list/",example:[{datetime_from:"2026-04-12 04:39:39 +00:00",datetime_to:"2026-04-14 04:39:39 +00:00",limit:100,offset:0,sort:"desc",include_metadata:!0}]},{path:"/v3/on_page/errors",method:"post",operationId:"OnPageErrors",tag:"OnPage",description:`By calling this endpoint you will receive information about the OnPage API tasks that returned an error within the past 7 days.
|
|
470
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/errors/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/errors/",example:[{limit:10,offset:0,filtered_function:"pingback_url"}]},{path:"/v3/on_page/force_stop",method:"post",operationId:"ForceStop",tag:"OnPage",description:`This endpoint is designed to force stop the crawl process of websites you specified in a task. The execution of all the tasks associated with the IDs indicated in your request to this endpoint will be stopped. You will still be able to obtain the data on pages that have been scanned until the crawling process was stopped.
|
|
471
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/force_stop/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/force_stop/",example:[{id:"08121600-1535-0216-0000-37b4c7a34453"},{id:"08121600-1535-0216-0000-d6a5000b6897"}]},{path:"/v3/on_page/available_filters",method:"get",operationId:"OnPageAvailableFilters",tag:"OnPage",description:`OnPage API supports plenty of customizable crawling parameters that allow you to adapt the extraction of website data to your requirements and modify the thresholds for various performance indicators.
|
|
472
|
+
|
|
473
|
+
Here you will find all the necessary information about filters and thresholds that can be used with DataForSEO OnPage API endpoints.
|
|
474
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/filters_and_thresholds/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/filters_and_thresholds/"},{path:"/v3/on_page/task_post",method:"post",operationId:"TaskPost",tag:"OnPage",description:`OnPage API checks websites for 60+ customizable on-page parameters defines and displays all found flaws and opportunities for optimization so that you can easily fix them. It checks meta tags, duplicate content, image tags, response codes, and other parameters on every page. You can find the full list of OnPage API check-up parameters in the Pages section.
|
|
475
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/task_post/",example:[{target:"dataforseo.com",max_crawl_pages:10,load_resources:!0,enable_javascript:!0,custom_js:"meta = {}; meta.url = document.URL; meta;",tag:"some_string_123",pingback_url:"https://your-server.com/pingscript?id=$id&tag=$tag"}]},{path:"/v3/on_page/tasks_ready",method:"get",operationId:"OnPageTasksReady",tag:"OnPage",description:`The ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks, which results haven’t been collected yet.
|
|
476
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page-tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page-tasks_ready/"},{path:"/v3/on_page/summary/{id}",method:"get",operationId:"Summary",tag:"OnPage",description:`Using this function, you can get the overall information on a website as well as drill down into exact on-page issues of a website that has been scanned. As a result, you will know what functions to use for receiving detailed data for each of the found issues.
|
|
477
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/summary/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/summary/"},{path:"/v3/on_page/pages",method:"post",operationId:"Pages",tag:"OnPage",description:`This endpoint returns a list of crawled pages with on-page check-ups and other metrics related to the page performance.
|
|
478
|
+
Using this function you will get page-specific data with detailed information on how well your pages are optimized for search.
|
|
479
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/pages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/pages/",example:[{id:"07281559-0695-0216-0000-c269be8b7592",filters:[["resource_type","=","html"],"and",["meta.scripts_count",">",40]],order_by:["meta.content.plain_text_word_count,desc"],limit:10}]},{path:"/v3/on_page/pages_by_resource",method:"post",operationId:"PagesByResource",tag:"OnPage",description:`This endpoint will return the list of pages where a specific resource is located. Using this function you will also get the data related to the pages that contain a specified resource.
|
|
480
|
+
You can get the URL of a resource using the Resources endpoint.
|
|
481
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/page_by_resource/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/page_by_resource/",example:[{id:"02241700-1535-0216-0000-034137259bc1",url:"https://www.etsy.com/about/jobs.workco2018.js?"}]},{path:"/v3/on_page/resources",method:"post",operationId:"Resources",tag:"OnPage",description:`This endpoint will provide you with a list of resources, including images, scripts, stylesheets, and broken elements.
|
|
482
|
+
You will get a detailed overview of every resource found on the crawled pages.
|
|
483
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/resources/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/resources/",example:[{id:"07281559-0695-0216-0000-c269be8b7592",filters:[["resource_type","=","image"],"and",["size",">",1e5]],order_by:["size,desc"],limit:10}]},{path:"/v3/on_page/duplicate_tags",method:"post",operationId:"DuplicateTags",tag:"OnPage",description:`This endpoint returns a list of pages that contain duplicate title or description tags. The response also contains data related to page performance.
|
|
484
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/duplicate_tags/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/duplicate_tags/",example:[{id:"07281559-0695-0216-0000-c269be8b7592",type:"duplicate_description",limit:10}]},{path:"/v3/on_page/duplicate_content",method:"post",operationId:"DuplicateContent",tag:"OnPage",description:`This endpoint returns a list of pages that have content similar to the page specified in the request. The response also contains data related to page performance and the similarity index that indicates how similar the compared pages are.
|
|
485
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/duplicate_content/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/duplicate_content/",example:[{id:"07281559-0695-0216-0000-c269be8b7592",url:"https://www.etsy.com/"}]},{path:"/v3/on_page/links",method:"post",operationId:"Links",tag:"OnPage",description:`This endpoint will provide you with a list of internal and external links detected on a target website.
|
|
486
|
+
The following link types are supported:
|
|
487
|
+
anchor – links that point to a specific portion of a webpage;
|
|
488
|
+
image – links that point to an image;
|
|
489
|
+
canonical – links that point to a canonical page;
|
|
490
|
+
meta – links with meta http-equiv=refresh ;
|
|
491
|
+
alternate – links with link rel="alternate" pointing to an alternative version of a webpage ;
|
|
492
|
+
redirect – links with redirect status.
|
|
493
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/links/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/links/",example:[{id:"07281559-0695-0216-0000-c269be8b7592",page_from:"/apis/google-trends-api",filters:[["dofollow","=",!0],"and",["direction","=","external"]],limit:10}]},{path:"/v3/on_page/redirect_chains",method:"post",operationId:"RedirectChains",tag:"OnPage",description:`Redirect chains occur when there are at least two redirects between the initial URL and the destination URL. For example, if page A redirects to page B which redirects to page C, such a series of redirects is considered a redirect chain. Sometimes, if page B redirects back to page A, the redirect chain becomes closed and is considered a redirect loop.
|
|
494
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/redirect_chains/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/redirect_chains/",example:[{id:"03051327-4536-0216-1000-3b458a2cfcca",url:"https://test_rdr.dataforseo.com/a/"}]},{path:"/v3/on_page/non_indexable",method:"post",operationId:"NonIndexable",tag:"OnPage",description:`This endpoint returns a list of pages that are blocked from being indexed by Google and other search engines through robots.txt, HTTP headers, or meta tags settings.
|
|
495
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/non_indexable/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/non_indexable/",example:[{id:"07281559-0695-0216-0000-c269be8b7592",filters:[["reason","=","robots_txt"],"and",["url","like","%go%"]],limit:10}]},{path:"/v3/on_page/waterfall",method:"post",operationId:"Waterfall",tag:"OnPage",description:`This endpoint is designed to provide you with the page speed insights. Using this function you can get detailed information about the page loading time, time to secure connection, the time it takes to load page resources, and so on.
|
|
496
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/waterfall/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/waterfall/",example:[{id:"08101204-0696-0216-0000-644a7b21a48a",url:"https://dataforseo.com/tag/broken-links"}]},{path:"/v3/on_page/keyword_density",method:"post",operationId:"KeywordDensity",tag:"OnPage",description:`This endpoint will provide you with keyword density and keyword frequency data for terms appearing on the specified website or web page. You can filter and sort the data that will be retrieved with this API call.
|
|
497
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/keyword_density/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/keyword_density/",example:[{id:"09101923-1535-0216-0000-2389a8854b70",url:"https://dataforseo.com/",keyword_length:2,filters:["frequency",">",5]}]},{path:"/v3/on_page/microdata",method:"post",operationId:"Microdata",tag:"OnPage",description:`This endpoint is designed to validate structured JSON-LD data and Microdata. Using this function you will obtain microdata available on the specified page of the target website and detailed results of its validation.
|
|
498
|
+
To use this endpoint, set the validate_micromarkup parameter to true in the POST request to OnPage API.
|
|
499
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/microdata/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/microdata/",example:[{id:"02241700-1535-0216-0000-034137259bc1",url:"https://dataforseo.com/apis"}]},{path:"/v3/on_page/raw_html",method:"post",operationId:"RawHtml",tag:"OnPage",description:`This endpoint returns the HTML of a page you indicate in the request.
|
|
500
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/raw_html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/raw_html/",example:[{id:"07281559-0695-0216-0000-c269be8b7592",url:"https://dataforseo.com/apis"}]},{path:"/v3/on_page/page_screenshot",method:"post",operationId:"PageScreenshot",tag:"OnPage",description:`Using this endpoint, you can capture a full high-quality screenshot of any webpage. In this way, you can review the target page as the DataForSEO crawler and Googlebot see it.
|
|
501
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/page_screenshot/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/page_screenshot/",example:[{url:"https://dataforseo.com/apis"}]},{path:"/v3/on_page/content_parsing",method:"post",operationId:"ContentParsing",tag:"OnPage",description:`This endpoint allows parsing the content on any page you specify and will return the structured content of the target page, including link URLs, anchors, headings, and textual content.
|
|
502
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/content_parsing/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/content_parsing/",example:[{url:"https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api",id:"11161551-1535-0216-0000-500b3f307f92"}]},{path:"/v3/on_page/content_parsing/live",method:"post",operationId:"ContentParsingLive",tag:"OnPage",description:`This endpoint allows parsing the content on any page you specify and will return the structured content of the target page, including link URLs, anchors, headings, and textual content.
|
|
503
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/content_parsing/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/content_parsing/live/",example:[{url:"https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api"}]},{path:"/v3/on_page/instant_pages",method:"post",operationId:"InstantPages",tag:"OnPage",description:`Using this function you will get page-specific data with detailed information on how well a particular page is optimized for organic search.
|
|
504
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/instant_pages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/instant_pages/",example:[{url:"https://dataforseo.com/blog",enable_javascript:!0,custom_js:"meta = {}; meta.url = document.URL; meta;"}]},{path:"/v3/on_page/lighthouse/languages",method:"get",operationId:"LighthouseLanguages",tag:"OnPage",description:`You will receive the list of languages by calling this API.
|
|
505
|
+
|
|
506
|
+
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
|
|
507
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/lighthouse/languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/lighthouse/languages/"},{path:"/v3/on_page/lighthouse/audits",method:"get",operationId:"LighthouseAudits",tag:"OnPage",description:`The OnPage Lighthouse API is based on Google’s open-source Lighthouse project and provides data on the quality of web pages.
|
|
508
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/lighthouse/audits/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/lighthouse/audits/"},{path:"/v3/on_page/lighthouse/versions",method:"get",operationId:"LighthouseVersions",tag:"OnPage",description:`OnPage Lighthouse API is based on Google’s open-source Lighthouse project and provides data on the quality of web pages.
|
|
509
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/lighthouse/versions/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/lighthouse/versions/"},{path:"/v3/on_page/lighthouse/task_post",method:"post",operationId:"LighthouseTaskPost",tag:"OnPage",description:`The OnPage Lighthouse API is based on Google’s open-source Lighthouse project for measuring the quality of web pages and web apps.
|
|
510
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/lighthouse/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/lighthouse/task_post/",example:[{url:"https://dataforseo.com",for_mobile:!0,tag:"some_string_123",pingback_url:"https://your-server.com/pingscript?id=$id&tag=$tag"}]},{path:"/v3/on_page/lighthouse/tasks_ready",method:"get",operationId:"LighthouseTasksReady",tag:"OnPage",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
511
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/lighthouse/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/lighthouse/tasks_ready/"},{path:"/v3/on_page/lighthouse/task_get/json/{id}",method:"get",operationId:"LighthouseTaskGetJson",tag:"OnPage",description:`The OnPage Lighthouse API is based on Google’s open-source Lighthouse project for measuring the quality of web pages and web apps. This endpoint will provide you with the results of Lighthouse Audit. Use the id received in the response of your Task POST request to get the results. The response will include data about all categories and audits specified in the Task POST. By default, the response will include all available data about the webpage including its performance, accessibility, progressive web apps, SEO, and compliance with best practices.
|
|
512
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/lighthouse/task_get/json/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/lighthouse/task_get/json/"},{path:"/v3/on_page/lighthouse/live/json",method:"post",operationId:"LighthouseLiveJson",tag:"OnPage",description:`The OnPage Lighthouse API is based on Google’s open-source Lighthouse project for measuring the quality of web pages and web apps.
|
|
513
|
+
for more info please visit 'https://docs.dataforseo.com/v3/on_page/lighthouse/live/json/?bash'`,docUrl:"https://docs.dataforseo.com/v3/on_page/lighthouse/live/json/",example:[{url:"https://dataforseo.com",for_mobile:!0,tag:"some_string_123"}]},{path:"/v3/content_analysis/id_list",method:"post",operationId:"ContentAnalysisIdList",tag:"ContentAnalysis",description:`This endpoint is designed to provide you with a list of IDs and metadata for all Content Analysis tasks created within the specified time period, including both successful and uncompleted tasks.
|
|
514
|
+
for more info please visit 'https://docs.dataforseo.com/v3/content_analysis/id_list/?bash'`,docUrl:"https://docs.dataforseo.com/v3/content_analysis/id_list/",example:[{datetime_from:"2026-04-12 04:39:39 +00:00",datetime_to:"2026-04-14 04:39:39 +00:00",limit:100,offset:0,sort:"desc",include_metadata:!0}]},{path:"/v3/content_analysis/available_filters",method:"get",operationId:"ContentAnalysisAvailableFilters",tag:"ContentAnalysis",description:`Here you will find all the necessary information about filters that can be used with Content Analysis API endpoints.
|
|
515
|
+
for more info please visit 'https://docs.dataforseo.com/v3/content_analysis/filters/?bash'`,docUrl:"https://docs.dataforseo.com/v3/content_analysis/filters/"},{path:"/v3/content_analysis/locations",method:"get",operationId:"Locations",tag:"ContentAnalysis",description:`You will receive the list of locations by this API call.
|
|
516
|
+
for more info please visit 'https://docs.dataforseo.com/v3/content_analysis/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/content_analysis/locations/"},{path:"/v3/content_analysis/languages",method:"get",operationId:"Languages",tag:"ContentAnalysis",description:`You will receive the list of languages by calling this API.
|
|
517
|
+
|
|
518
|
+
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
|
|
519
|
+
for more info please visit 'https://docs.dataforseo.com/v3/content_analysis/languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/content_analysis/languages/"},{path:"/v3/content_analysis/categories",method:"get",operationId:"ContentAnalysisCategories",tag:"ContentAnalysis",description:`We use Google product and service categories. This endpoint will provide you with the full list of available categories.
|
|
520
|
+
You can also download the CSV file by this link.
|
|
521
|
+
for more info please visit 'https://docs.dataforseo.com/v3/content_analysis/categories/?bash'`,docUrl:"https://docs.dataforseo.com/v3/content_analysis/categories/"},{path:"/v3/content_analysis/search/live",method:"post",operationId:"SearchLive",tag:"ContentAnalysis",description:`This endpoint will provide you with detailed citation data available for the target keyword.
|
|
522
|
+
for more info please visit 'https://docs.dataforseo.com/v3/content_analysis/search/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/content_analysis/search/live/",example:[{keyword_fields:{snippet:"logitech"},keyword:"logitech",page_type:["ecommerce","news","blogs","message-boards","organization"],search_mode:"as_is",filters:["main_domain","=","reviewfinder.ca"],order_by:["content_info.sentiment_connotations.anger,desc"],limit:10}]},{path:"/v3/content_analysis/summary/live",method:"post",operationId:"ContentAnalysisSummaryLive",tag:"ContentAnalysis",description:`This endpoint will provide you with an overview of citation data available for the target keyword.
|
|
523
|
+
for more info please visit 'https://docs.dataforseo.com/v3/content_analysis/summary/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/content_analysis/summary/live/",example:[{keyword:"logitech",page_type:["ecommerce","news","blogs","message-boards","organization"],internal_list_limit:8,positive_connotation_threshold:0.5}]},{path:"/v3/content_analysis/sentiment_analysis/live",method:"post",operationId:"SentimentAnalysisLive",tag:"ContentAnalysis",description:`This endpoint will provide you with sentiment analysis data for the citations available for the target keyword.
|
|
524
|
+
for more info please visit 'https://docs.dataforseo.com/v3/content_analysis/sentiment_analysis/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/content_analysis/sentiment_analysis/live/",example:[{keyword:"logitech",internal_list_limit:1}]},{path:"/v3/content_analysis/rating_distribution/live",method:"post",operationId:"RatingDistributionLive",tag:"ContentAnalysis",description:`This endpoint will provide you with rating distribution data for the keyword and other parameters specified in the request.
|
|
525
|
+
for more info please visit 'https://docs.dataforseo.com/v3/content_analysis/rating_distribution/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/content_analysis/rating_distribution/live/",example:[{keyword:"logitech",search_mode:"as_is",internal_list_limit:10}]},{path:"/v3/content_analysis/phrase_trends/live",method:"post",operationId:"PhraseTrendsLive",tag:"ContentAnalysis",description:`This endpoint will provide you with data on all citations of the target keyword for the indicated date range.
|
|
526
|
+
for more info please visit 'https://docs.dataforseo.com/v3/content_analysis/phrase_trends/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/content_analysis/phrase_trends/live/",example:[{keyword:"logitech",search_mode:"as_is",date_from:"2026-01-15",date_group:"month"}]},{path:"/v3/content_analysis/category_trends/live",method:"post",operationId:"CategoryTrendsLive",tag:"ContentAnalysis",description:`This endpoint will provide you with data on all citations in the target category for the indicated date range.
|
|
527
|
+
for more info please visit 'https://docs.dataforseo.com/v3/content_analysis/category_trends/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/content_analysis/category_trends/live/",example:[{category_code:10994,search_mode:"as_is",date_from:"2026-01-15",date_group:"month"}]},{path:"/v3/merchant/id_list",method:"post",operationId:"MerchantIdList",tag:"Merchant",description:`This endpoint is designed to provide you with a list of IDs and metadata for all Merchant tasks created within the specified time period, including both successful and uncompleted tasks.
|
|
528
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/id_list/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/id_list/",example:[{datetime_from:"2026-04-12 04:39:39 +00:00",datetime_to:"2026-04-14 04:39:39 +00:00",limit:100,offset:0,sort:"desc",include_metadata:!0}]},{path:"/v3/merchant/errors",method:"post",operationId:"MerchantErrors",tag:"Merchant",description:`By calling this endpoint you will receive information about the Merchant API tasks that returned an error within the past 7 days.
|
|
529
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/errors/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/errors/",example:[{limit:10,offset:0,filtered_function:"pingback_url"}]},{path:"/v3/merchant/google/languages",method:"get",operationId:"MerchantGoogleLanguages",tag:"Merchant",description:`You will receive the list of supported Google Shopping languages by calling this API.
|
|
530
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/google/languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/google/languages/"},{path:"/v3/merchant/google/locations",method:"get",operationId:"MerchantGoogleLocations",tag:"Merchant",description:"for more info please visit 'https://docs.dataforseo.com/v3/merchant/google/locations/?bash'",docUrl:"https://docs.dataforseo.com/v3/merchant/google/locations/"},{path:"/v3/merchant/google/locations/{country}",method:"get",operationId:"MerchantGoogleLocationsCountry",tag:"Merchant",description:"for more info please visit 'https://docs.dataforseo.com/v3/merchant/google/locations/?bash'",docUrl:"https://docs.dataforseo.com/v3/merchant/google/locations/"},{path:"/v3/merchant/google/products/task_post",method:"post",operationId:"GoogleProductsTaskPost",tag:"Merchant",description:`Google Shopping Products endpoint will provide you with the list of products found on Google Shopping for the specified query. The results include product title, description in Google Shopping SERP, product rank, price, reviews and rating as well as the related domain.
|
|
531
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/google/products/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/google/products/task_post/",example:[{language_code:"en",location_code:2840,keyword:"iphone",price_min:5}]},{path:"/v3/merchant/google/products/tasks_ready",method:"get",operationId:"GoogleProductsTasksReady",tag:"Merchant",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
532
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/google/products/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/google/products/tasks_ready/"},{path:"/v3/merchant/tasks_ready",method:"get",operationId:"MerchantTasksReady",tag:"Merchant",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
533
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/google/products/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/google/products/tasks_ready/"},{path:"/v3/merchant/google/products/task_get/advanced/{id}",method:"get",operationId:"GoogleProductsTaskGetAdvanced",tag:"Merchant",description:`Description of the fields for sending a request:
|
|
534
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/google/products/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/google/products/task_get/advanced/"},{path:"/v3/merchant/google/products/task_get/html/{id}",method:"get",operationId:"GoogleProductsTaskGetHtml",tag:"Merchant",description:`Description of the fields for sending a request:
|
|
535
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/google/products/task_get/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/google/products/task_get/html/"},{path:"/v3/merchant/google/sellers/task_post",method:"post",operationId:"GoogleSellersTaskPost",tag:"Merchant",description:`Google Shopping Sellers endpoint will provide you with the list of top 10 sellers that listed the specified product on Google Shopping. The provided data for each seller includes related product base and total price, shipment and purchase details and special offers. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
|
|
536
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/google/sellers/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/google/sellers/task_post/",example:[{language_code:"en",location_code:2840,product_id:"1113158713975221117"}]},{path:"/v3/merchant/google/sellers/tasks_ready",method:"get",operationId:"GoogleSellersTasksReady",tag:"Merchant",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
537
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/google/sellers/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/google/sellers/tasks_ready/"},{path:"/v3/merchant/google/sellers/task_get/advanced/{id}",method:"get",operationId:"GoogleSellersTaskGetAdvanced",tag:"Merchant",description:`Description of the fields for sending a request:
|
|
538
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/google/sellers/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/google/sellers/task_get/advanced/"},{path:"/v3/merchant/google/product_info/task_post",method:"post",operationId:"GoogleProductInfoTaskPost",tag:"Merchant",description:`This endpoint provides data on a product listed on Google Shopping, including product description, images, rating, variations, specifications and sellers. In order to set a task, you have to specify one of the following fields: product_id, data_docid, or gid.
|
|
539
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/google/product_info/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/google/product_info/task_post/",example:[{language_code:"en",location_code:2840,product_id:"1113158713975221117"}]},{path:"/v3/merchant/google/product_info/tasks_ready",method:"get",operationId:"GoogleProductInfoTasksReady",tag:"Merchant",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
540
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/google/product_info/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/google/product_info/tasks_ready/"},{path:"/v3/merchant/google/product_info/task_get/advanced/{id}",method:"get",operationId:"GoogleProductInfoTaskGetAdvanced",tag:"Merchant",description:`Description of the fields for sending a request:
|
|
541
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/google/product_info/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/google/product_info/task_get/advanced/"},{path:"/v3/merchant/google/sellers/ad_url/{shop_ad_aclk}",method:"get",operationId:"GoogleSellersAdUrl",tag:"Merchant",description:`Google Shopping Sellers Ad URL is designed to provide you with a full URL of the advertisement containing all additional parameters set by the seller.
|
|
542
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/google/sellers/ad_url/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/google/sellers/ad_url/"},{path:"/v3/merchant/amazon/locations",method:"get",operationId:"AmazonLocations",tag:"Merchant",description:`You will receive the list of supported Amazon locations by this API call. You can filter the list of locations by country when setting a task.
|
|
543
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/amazon/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/amazon/locations/"},{path:"/v3/merchant/amazon/locations/{country}",method:"get",operationId:"AmazonLocationsCountry",tag:"Merchant",description:`You will receive the list of supported Amazon locations by this API call. You can filter the list of locations by country when setting a task.
|
|
544
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/amazon/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/amazon/locations/"},{path:"/v3/merchant/amazon/languages",method:"get",operationId:"AmazonLanguages",tag:"Merchant",description:`You will receive the list of supported Amazon languages by calling this API.
|
|
545
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/amazon/languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/amazon/languages/"},{path:"/v3/merchant/amazon/products/task_post",method:"post",operationId:"AmazonProductsTaskPost",tag:"Merchant",description:`This endpoint provides results from Amazon product listings according to the specified keyword (product name), location, and language parameters.
|
|
546
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/amazon/products/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/amazon/products/task_post/",example:[{language_code:"en_US",location_code:2840,keyword:"shoes"}]},{path:"/v3/merchant/amazon/products/tasks_ready",method:"get",operationId:"AmazonProductsTasksReady",tag:"Merchant",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
547
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/amazon/products/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/amazon/products/tasks_ready/"},{path:"/v3/merchant/amazon/products/task_get/advanced/{id}",method:"get",operationId:"AmazonProductsTaskGetAdvanced",tag:"Merchant",description:`Description of the fields for sending a request:
|
|
548
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/amazon/products/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/amazon/products/task_get/advanced/"},{path:"/v3/merchant/amazon/products/task_get/html/{id}",method:"get",operationId:"AmazonProductsTaskGetHtml",tag:"Merchant",description:`Description of the fields for sending a request:
|
|
549
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/amazon/products/task_get/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/amazon/products/task_get/html/"},{path:"/v3/merchant/amazon/asin/task_post",method:"post",operationId:"AmazonAsinTaskPost",tag:"Merchant",description:`This endpoint will provide you with a full list of ASINs assigned to different modifications of a product.
|
|
550
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/amazon/asin/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/amazon/asin/task_post/",example:[{language_code:"en_US",location_code:2840,asin:"B0756FCPPN"}]},{path:"/v3/merchant/amazon/asin/tasks_ready",method:"get",operationId:"AmazonAsinTasksReady",tag:"Merchant",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints.
|
|
551
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/amazon/asin/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/amazon/asin/tasks_ready/"},{path:"/v3/merchant/amazon/asin/task_get/advanced/{id}",method:"get",operationId:"AmazonAsinTaskGetAdvanced",tag:"Merchant",description:`This endpoint will provide you with information about the product and ASINs of all its modifications listed on Amazon.
|
|
552
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/amazon/asin/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/amazon/asin/task_get/advanced/"},{path:"/v3/merchant/amazon/asin/task_get/html/{id}",method:"get",operationId:"AmazonAsinTaskGetHtml",tag:"Merchant",description:`Description of the fields for sending a request:
|
|
553
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/amazon/asin/task_get/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/amazon/asin/task_get/html/"},{path:"/v3/merchant/amazon/sellers/task_post",method:"post",operationId:"AmazonSellersTaskPost",tag:"Merchant",description:`This endpoint provides a list of sellers of the specified product on Amazon. The data provided for each seller includes related product condition, pricing, shipment, and rating details.
|
|
554
|
+
The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
|
|
555
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/amazon/sellers/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/amazon/sellers/task_post/",example:[{language_code:"en_US",location_code:2840,asin:"B085RFFC9Q"}]},{path:"/v3/merchant/amazon/sellers/tasks_ready",method:"get",operationId:"AmazonSellersTasksReady",tag:"Merchant",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
556
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/amazon/sellers/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/amazon/sellers/tasks_ready/"},{path:"/v3/merchant/amazon/sellers/task_get/advanced/{id}",method:"get",operationId:"AmazonSellersTaskGetAdvanced",tag:"Merchant",description:`This endpoint provides a list of sellers of the specified product on Amazon. The data provided for each seller includes related product condition, pricing, shipment, and rating details.
|
|
557
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/amazon/sellers/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/amazon/sellers/task_get/advanced/"},{path:"/v3/merchant/amazon/sellers/task_get/html/{id}",method:"get",operationId:"AmazonSellersTaskGetHtml",tag:"Merchant",description:`Description of the fields for sending a request:
|
|
558
|
+
for more info please visit 'https://docs.dataforseo.com/v3/merchant/amazon/sellers/task_get/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/merchant/amazon/sellers/task_get/html/"},{path:"/v3/app_data/id_list",method:"post",operationId:"AppDataIdList",tag:"AppData",description:`This endpoint is designed to provide you with a list of IDs and metadata for all App Data tasks created within the specified time period, including both successful and uncompleted tasks.
|
|
559
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/id_list/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/id_list/",example:[{datetime_from:"2026-04-12 04:39:39 +00:00",datetime_to:"2026-04-14 04:39:39 +00:00",limit:100,offset:0,sort:"desc",include_metadata:!0}]},{path:"/v3/app_data/errors",method:"post",operationId:"AppDataErrors",tag:"AppData",description:`By calling this endpoint you will receive information about the App Data API tasks that returned an error within the past 7 days.
|
|
560
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/errors/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/errors/",example:[{limit:10,offset:0,filtered_function:"pingback_url"}]},{path:"/v3/app_data/google/categories",method:"get",operationId:"GoogleCategories",tag:"AppData",description:`This endpoint will provide you with a full list of app categories available on Google Play.
|
|
561
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/google/categories/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/google/categories/"},{path:"/v3/app_data/google/locations",method:"get",operationId:"AppDataGoogleLocations",tag:"AppData",description:`By calling this endpoint you will receive the list of Google locations supported in App Data API.
|
|
562
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/google/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/google/locations/"},{path:"/v3/app_data/google/locations/{country}",method:"get",operationId:"AppDataGoogleLocationsCountry",tag:"AppData",description:`By calling this endpoint you will receive the list of Google locations supported in App Data API.
|
|
563
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/google/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/google/locations/"},{path:"/v3/app_data/google/languages",method:"get",operationId:"AppDataGoogleLanguages",tag:"AppData",description:`By calling this endpoint you will receive the list of Google languages supported in App Data API.
|
|
564
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/google/languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/google/languages/"},{path:"/v3/app_data/google/app_searches/task_post",method:"post",operationId:"GoogleAppSearchesTaskPost",tag:"AppData",description:`This endpoint will provide you with a list of apps ranking on Google Play for the specified keyword. The returned results are specific to the indicated keyword, as well as the language and location parameters.
|
|
565
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/google/app_searches/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/google/app_searches/task_post/",example:[{keyword:"vpn",location_code:2840,language_code:"en",depth:30}]},{path:"/v3/app_data/google/app_searches/tasks_ready",method:"get",operationId:"GoogleAppSearchesTasksReady",tag:"AppData",description:`The ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints.
|
|
566
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/google/app_searches/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/google/app_searches/tasks_ready/"},{path:"/v3/app_data/tasks_ready",method:"get",operationId:"AppDataTasksReady",tag:"AppData",description:`The ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints.
|
|
567
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/google/app_searches/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/google/app_searches/tasks_ready/"},{path:"/v3/app_data/google/app_searches/task_get/advanced/{id}",method:"get",operationId:"GoogleAppSearchesTaskGetAdvanced",tag:"AppData",description:`This endpoint will provide you with a list of apps ranking on Google Play for the keyword specified in a POST request. You will also receive additional information about each application: its ID, icon, reviews count, rating, price, and other data. The results are specific to the keyword as well as location and language parameters specified in the POST request.
|
|
568
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/google/app_searches/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/google/app_searches/task_get/advanced/"},{path:"/v3/app_data/google/app_searches/task_get/html/{id}",method:"get",operationId:"GoogleAppSearchesTaskGetHtml",tag:"AppData",description:`Description of the fields for sending a request:
|
|
569
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/google/app_searches/task_get/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/google/app_searches/task_get/html/"},{path:"/v3/app_data/google/app_list/task_post",method:"post",operationId:"GoogleAppListTaskPost",tag:"AppData",description:`This endpoint will provide you with a list of mobile applications published in the top charts on the Google Play platform. The returned results are specific to the app collection as well as the the language and location parameters.
|
|
570
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/google/app_list/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/google/app_list/task_post/",example:[{app_collection:"topselling_free",location_code:2840,language_code:"en",depth:100}]},{path:"/v3/app_data/google/app_list/tasks_ready",method:"get",operationId:"GoogleAppListTasksReady",tag:"AppData",description:`The ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints.
|
|
571
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/google/app_list/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/google/app_list/tasks_ready/"},{path:"/v3/app_data/google/app_list/task_get/advanced/{id}",method:"get",operationId:"GoogleAppListTaskGetAdvanced",tag:"AppData",description:`This endpoint will provide you with a list of applications published in the top charts on the Google Play platform, including app IDs, ratings, prices, titles, and more. The results are specific to the app_collection as well as the location and language parameters specified in the POST request.
|
|
572
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/google/app_list/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/google/app_list/task_get/advanced/"},{path:"/v3/app_data/google/app_list/task_get/html/{id}",method:"get",operationId:"GoogleAppListTaskGetHtml",tag:"AppData",description:`Description of the fields for sending a request:
|
|
573
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/google/app_list/task_get/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/google/app_list/task_get/html/"},{path:"/v3/app_data/google/app_info/task_post",method:"post",operationId:"GoogleAppInfoTaskPost",tag:"AppData",description:`This endpoint will provide you with information about the Google Play application specified in the app_id field of the POST request.
|
|
574
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/google/app_info/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/google/app_info/task_post/",example:[{app_id:"org.telegram.messenger",location_code:2840,language_code:"en"}]},{path:"/v3/app_data/google/app_info/tasks_ready",method:"get",operationId:"GoogleAppInfoTasksReady",tag:"AppData",description:`The ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints.
|
|
575
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/google/app_info/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/google/app_info/tasks_ready/"},{path:"/v3/app_data/google/app_info/task_get/advanced/{id}",method:"get",operationId:"GoogleAppInfoTaskGetAdvanced",tag:"AppData",description:`This endpoint will provide you with information about the mobile application specified in a POST request. You will receive its ID, icon, description, reviews count, rating, number of installs, images, and other data. The results are specific to the app_id parameter specified in the POST request.
|
|
576
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/google/app_info/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/google/app_info/task_get/advanced/"},{path:"/v3/app_data/google/app_info/task_get/html/{id}",method:"get",operationId:"GoogleAppInfoTaskGetHtml",tag:"AppData",description:`Description of the fields for sending a request:
|
|
577
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/google/app_info/task_get/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/google/app_info/task_get/html/"},{path:"/v3/app_data/google/app_reviews/task_post",method:"post",operationId:"GoogleAppReviewsTaskPost",tag:"AppData",description:`This endpoint will provide you with reviews published on the Google Play platform for the app specified in the app_id field. The returned results are specific to the indicated language and location parameters.
|
|
578
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/google/app_reviews/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/google/app_reviews/task_post/",example:[{app_id:"org.telegram.messenger",location_code:2840,language_code:"en",depth:150}]},{path:"/v3/app_data/google/app_reviews/tasks_ready",method:"get",operationId:"GoogleAppReviewsTasksReady",tag:"AppData",description:`The ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints.
|
|
579
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/google/app_reviews/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/google/app_reviews/tasks_ready/"},{path:"/v3/app_data/google/app_reviews/task_get/advanced/{id}",method:"get",operationId:"GoogleAppReviewsTaskGetAdvanced",tag:"AppData",description:`This endpoint will provide you with feedback data on applications listed on the Google Play platform, including review ratings, review content, user profile info of each reviewer, review publication dates, and more. The results are specific to the app_id as well as the location and language parameters specified in the POST request.
|
|
580
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/google/app_reviews/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/google/app_reviews/task_get/advanced/"},{path:"/v3/app_data/google/app_reviews/task_get/html/{id}",method:"get",operationId:"GoogleAppReviewsTaskGetHtml",tag:"AppData",description:`Description of the fields for sending a request:
|
|
581
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/google/app_reviews/task_get/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/google/app_reviews/task_get/html/"},{path:"/v3/app_data/google/app_listings/categories",method:"get",operationId:"GoogleAppListingsCategories",tag:"AppData",description:`This endpoint will provide you with a full list of app categories available on Google Play.
|
|
582
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/google/app_listings/categories/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/google/app_listings/categories/"},{path:"/v3/app_data/google/app_listings/search/live",method:"post",operationId:"GoogleAppListingsSearchLive",tag:"AppData",description:`This endpoint will provide you with a list of apps published on Google Play along with additional information: its ID, icon, reviews count, rating, price, and other data. The results are specific to the title, description, and categories parameters specified in the API request.
|
|
583
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/google/app_listings/search/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/google/app_listings/search/live/",example:[{title:"vpn",description:"vpn",categories:["Tools"],order_by:["item.installs_count,asc"],filters:[["item.rating.value",">",4.5]],limit:10}]},{path:"/v3/app_data/apple/categories",method:"get",operationId:"AppleCategories",tag:"AppData",description:`This endpoint will provide you with a full list of app categories available on App Store.
|
|
584
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/apple/categories/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/apple/categories/"},{path:"/v3/app_data/apple/locations",method:"get",operationId:"AppleLocations",tag:"AppData",description:`By calling this endpoint you will receive the list of Apple locations supported in App Data API.
|
|
585
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/apple/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/apple/locations/"},{path:"/v3/app_data/apple/languages",method:"get",operationId:"AppleLanguages",tag:"AppData",description:`By calling this endpoint you will receive the list of Apple languages supported in App Data API.
|
|
586
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/apple/languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/apple/languages/"},{path:"/v3/app_data/apple/app_searches/task_post",method:"post",operationId:"AppleAppSearchesTaskPost",tag:"AppData",description:`This endpoint will provide you with a list of apps ranking on the App Store for the specified keyword. The returned results are specific to the indicated keyword, as well as the location and language parameters.
|
|
587
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/apple/app_searches/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/apple/app_searches/task_post/",example:[{keyword:"vpn",location_code:2840,language_code:"en",depth:200}]},{path:"/v3/app_data/apple/app_searches/tasks_ready",method:"get",operationId:"AppleAppSearchesTasksReady",tag:"AppData",description:`The ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints.
|
|
588
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/apple/app_searches/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/apple/app_searches/tasks_ready/"},{path:"/v3/app_data/apple/app_searches/task_get/advanced/{id}",method:"get",operationId:"AppleAppSearchesTaskGetAdvanced",tag:"AppData",description:`This endpoint will provide you with a list of apps ranking on the App Store for the keyword specified in a POST request. You will also receive additional information about each application: its ID, icon, reviews count, rating, price, and other data. The results are specific to the keyword as well as location and language parameters specified in the POST request.
|
|
589
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/apple/app_searches/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/apple/app_searches/task_get/advanced/"},{path:"/v3/app_data/apple/app_info/task_post",method:"post",operationId:"AppleAppInfoTaskPost",tag:"AppData",description:`This endpoint will provide you with information about the App Store application specified in the app_id field of the POST request.
|
|
590
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/apple/app_info/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/apple/app_info/task_post/",example:[{app_id:"835599320",location_code:2840,language_code:"en"}]},{path:"/v3/app_data/apple/app_info/tasks_ready",method:"get",operationId:"AppleAppInfoTasksReady",tag:"AppData",description:`The ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints.
|
|
591
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/apple/app_info/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/apple/app_info/tasks_ready/"},{path:"/v3/app_data/apple/app_info/task_get/advanced/{id}",method:"get",operationId:"AppleAppInfoTaskGetAdvanced",tag:"AppData",description:`This endpoint will provide you with information about the mobile application specified in a POST request. You will receive its ID, icon, description, reviews count, rating, images, and other data. The results are specific to the app_id parameter specified in the POST request.
|
|
592
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/apple/app_info/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/apple/app_info/task_get/advanced/"},{path:"/v3/app_data/apple/app_list/task_post",method:"post",operationId:"AppleAppListTaskPost",tag:"AppData",description:`This endpoint will provide you with a list of mobile applications published in the top app charts on the App Store platform. The returned results are specific to the app collection as well as the language and location parameters.
|
|
593
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/apple/app_list/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/apple/app_list/task_post/",example:[{app_collection:"top_free_ios",location_code:2840,language_code:"en",depth:200,app_category:"games"}]},{path:"/v3/app_data/apple/app_list/tasks_ready",method:"get",operationId:"AppleAppListTasksReady",tag:"AppData",description:`The ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints.
|
|
594
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/apple/app_list/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/apple/app_list/tasks_ready/"},{path:"/v3/app_data/apple/app_list/task_get/advanced/{id}",method:"get",operationId:"AppleAppListTaskGetAdvanced",tag:"AppData",description:`This endpoint will provide you with a list of applications published in the top app charts on the App Store platform, including app IDs, ratings, prices, titles, and more. The results are specific to the app_collection as well as the location and language parameters specified in the POST request.
|
|
595
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/apple/app_list/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/apple/app_list/task_get/advanced/"},{path:"/v3/app_data/apple/app_reviews/task_post",method:"post",operationId:"AppleAppReviewsTaskPost",tag:"AppData",description:`This endpoint will provide you with reviews published on the App Store platform for the app specified in the app_id field. The returned results are specific to the indicated language and location parameters.
|
|
596
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/apple/app_reviews/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/apple/app_reviews/task_post/",example:[{app_id:"835599320",location_code:2840,language_code:"en",depth:200}]},{path:"/v3/app_data/apple/app_reviews/tasks_ready",method:"get",operationId:"AppleAppReviewsTasksReady",tag:"AppData",description:`The ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints.
|
|
597
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/apple/app_reviews/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/apple/app_reviews/tasks_ready/"},{path:"/v3/app_data/apple/app_reviews/task_get/advanced/{id}",method:"get",operationId:"AppleAppReviewsTaskGetAdvanced",tag:"AppData",description:`This endpoint will provide you with feedback data on applications listed on the App Store platform, including review ratings, review content, user profile info of each reviewer, review publication dates, and more. The results are specific to the app_id as well as the location and language parameters specified in the POST request.
|
|
598
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/apple/app_reviews/task_get/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/apple/app_reviews/task_get/advanced/"},{path:"/v3/app_data/apple/app_listings/categories",method:"get",operationId:"AppleAppListingsCategories",tag:"AppData",description:`This endpoint will provide you with a full list of app categories available on Apple App Store.
|
|
599
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/apple/app_listings/categories/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/apple/app_listings/categories/"},{path:"/v3/app_data/apple/app_listings/search/live",method:"post",operationId:"AppleAppListingsSearchLive",tag:"AppData",description:`This endpoint will provide you with a list of apps published on App Store along with additional information: its ID, icon, reviews count, rating, price, and other data. The results are specific to the title, description, and categories parameters specified in the API request.
|
|
600
|
+
for more info please visit 'https://docs.dataforseo.com/v3/app_data/apple/app_listings/search/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/app_data/apple/app_listings/search/live/",example:[{title:"vpn",description:"vpn",categories:["Tools"],order_by:["item.rating.value,desc"],filters:[["item.rating.value",">",4.5]],limit:2}]},{path:"/v3/business_data/id_list",method:"post",operationId:"BusinessDataIdList",tag:"BusinessData",description:`This endpoint is designed to provide you with a list of IDs and metadata for all Business Data tasks created within the specified time period, including both successful and uncompleted tasks.
|
|
601
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/id_list/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/id_list/",example:[{datetime_from:"2026-04-12 04:39:39 +00:00",datetime_to:"2026-04-14 04:39:39 +00:00",limit:100,offset:0,sort:"desc",include_metadata:!0}]},{path:"/v3/business_data/errors",method:"post",operationId:"BusinessDataErrors",tag:"BusinessData",description:`By calling this endpoint you will receive information about the Business Data API tasks that returned an error within the past 7 days.
|
|
602
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/errors/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/errors/",example:[{limit:10,offset:0,filtered_function:"pingback_url"}]},{path:"/v3/business_data/business_listings/locations",method:"get",operationId:"BusinessListingsLocations",tag:"BusinessData",description:`You will receive the list of locations by this API call. You can also download the full list of supported locations in the CSV format (last updated 2026-04-06).
|
|
603
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/business_listings/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/business_listings/locations/"},{path:"/v3/business_data/business_listings/categories",method:"get",operationId:"BusinessListingsCategories",tag:"BusinessData",description:`This endpoint will provide you with the list of top categories by business count.
|
|
604
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/business_listings/categories/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/business_listings/categories/"},{path:"/v3/business_data/business_listings/available_filters",method:"get",operationId:"BusinessListingsAvailableFilters",tag:"BusinessData",description:`Here you will find all the necessary information about filters that can be used with Business Listings API.
|
|
605
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/business_listings/filters/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/business_listings/filters/"},{path:"/v3/business_data/business_listings/search/live",method:"post",operationId:"BusinessListingsSearchLive",tag:"BusinessData",description:`Business Listings Search API provides results containing information about business entities listed on Google Maps in the specified categories. You will receive the address, contacts, rating, working hours, and other relevant data. The provided results are specific to the selected location (see the List of Locations) settings.
|
|
606
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/business_listings/search/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/business_listings/search/live/",example:[{categories:["pizza_restaurant"],description:"pizza",title:"pizza",is_claimed:!0,location_coordinate:"53.476225,-2.243572,10",order_by:["rating.value,desc"],filters:[["rating.value",">",3]],limit:3}]},{path:"/v3/business_data/business_listings/categories_aggregation/live",method:"post",operationId:"BusinessListingsCategoriesAggregationLive",tag:"BusinessData",description:`Business Listings Categories Aggregation endpoint provides results containing information about groups of related categories along with the number of entities in each category. The provided results are specific to the specified parameters.
|
|
607
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/business_listings/categories_aggregation/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/business_listings/categories_aggregation/live/",example:[{categories:["pizza_restaurant"],description:"pizza",title:"pizza",is_claimed:!0,location_coordinate:"53.476225,-2.243572,10",initial_dataset_filters:[["rating.value",">",3]],limit:3}]},{path:"/v3/business_data/google/locations",method:"get",operationId:"BusinessDataGoogleLocations",tag:"BusinessData",description:`You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
|
|
608
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/google/locations/"},{path:"/v3/business_data/google/locations/{country}",method:"get",operationId:"BusinessDataGoogleLocationsCountry",tag:"BusinessData",description:`You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task.
|
|
609
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/google/locations/"},{path:"/v3/business_data/google/languages",method:"get",operationId:"BusinessDataGoogleLanguages",tag:"BusinessData",description:`You will receive the list of languages by calling this API.
|
|
610
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/google/languages/"},{path:"/v3/business_data/google/my_business_info/task_post",method:"post",operationId:"GoogleMyBusinessInfoTaskPost",tag:"BusinessData",description:`Business Data API provides results containing information about specific business entity from Google. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
|
|
611
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/my_business_info/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/google/my_business_info/task_post/",example:[{language_code:"en",location_name:"New York,New York,United States",keyword:"RustyBrick, Inc."}]},{path:"/v3/business_data/google/my_business_info/tasks_ready",method:"get",operationId:"GoogleMyBusinessInfoTasksReady",tag:"BusinessData",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
612
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/my_business_info/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/google/my_business_info/tasks_ready/"},{path:"/v3/business_data/tasks_ready",method:"get",operationId:"BusinessDataTasksReady",tag:"BusinessData",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
613
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/my_business_info/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/google/my_business_info/tasks_ready/"},{path:"/v3/business_data/google/my_business_info/task_get/{id}",method:"get",operationId:"GoogleMyBusinessInfoTaskGet",tag:"BusinessData",description:"for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/my_business_info/task_get/?bash'",docUrl:"https://docs.dataforseo.com/v3/business_data/google/my_business_info/task_get/"},{path:"/v3/business_data/google/my_business_info/live",method:"post",operationId:"GoogleMyBusinessInfoLive",tag:"BusinessData",description:`Business Data API provides results containing information about specific business entity from Google. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
|
|
614
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/my_business_info/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/google/my_business_info/live/",example:[{language_code:"en",location_name:"New York,New York,United States",keyword:"RustyBrick, Inc."}]},{path:"/v3/business_data/google/my_business_updates/task_post",method:"post",operationId:"GoogleMyBusinessUpdatesTaskPost",tag:"BusinessData",description:`This endpoints provides the latest updates of a specific business entity from Google SERP. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
|
|
615
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/my_business_updates/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/google/my_business_updates/task_post/",example:[{language_code:"en",location_name:"New York,New York,United States",keyword:"RustyBrick, Inc."}]},{path:"/v3/business_data/google/my_business_updates/tasks_ready",method:"get",operationId:"GoogleMyBusinessUpdatesTasksReady",tag:"BusinessData",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
616
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/my_business_updates/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/google/my_business_updates/tasks_ready/"},{path:"/v3/business_data/google/my_business_updates/task_get/{id}",method:"get",operationId:"GoogleMyBusinessUpdatesTaskGet",tag:"BusinessData",description:"for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/my_business_updates/task_get/?bash'",docUrl:"https://docs.dataforseo.com/v3/business_data/google/my_business_updates/task_get/"},{path:"/v3/business_data/google/hotel_searches/task_post",method:"post",operationId:"GoogleHotelSearchesTaskPost",tag:"BusinessData",description:`Hotel Searches API provides results containing information about different hotels listed on Google. The provided results are specific to the keyword, selected location (see the List of Locations) and language (see the List of Languages) settings.
|
|
617
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/hotel_searches/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/google/hotel_searches/task_post/",example:[{language_code:"en",location_name:"New York,New York,United States",keyword:"cheap hotel",check_in:"2026-05-15",check_out:"2026-05-16",currency:"USD",adults:2,children:[14],sort_by:"highest_rating",priority:2,tag:"example"}]},{path:"/v3/business_data/google/hotel_searches/tasks_ready",method:"get",operationId:"GoogleHotelSearchesTasksReady",tag:"BusinessData",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
618
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/hotel_searches/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/google/hotel_searches/tasks_ready/"},{path:"/v3/business_data/google/hotel_searches/task_get/{id}",method:"get",operationId:"GoogleHotelSearchesTaskGet",tag:"BusinessData",description:"for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/hotel_searches/task_get/?bash'",docUrl:"https://docs.dataforseo.com/v3/business_data/google/hotel_searches/task_get/"},{path:"/v3/business_data/google/hotel_searches/live",method:"post",operationId:"GoogleHotelSearchesLive",tag:"BusinessData",description:`Hotel Searches API provides results containing information about different hotels listed on Google Hotels. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
|
|
619
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/hotel_searches/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/google/hotel_searches/live/",example:[{language_code:"en",location_name:"New York,New York,United States",keyword:"cheap hotel",check_in:"2026-05-15",check_out:"2026-05-16",currency:"USD",adults:2,children:[14],sort_by:"highest_rating",tag:"example"}]},{path:"/v3/business_data/google/hotel_info/task_post",method:"post",operationId:"GoogleHotelInfoTaskPost",tag:"BusinessData",description:`Google Hotel Info will provide you with structured data available for a specific hotel entity on the Google Hotels platform: such as service description, location details, rating, amenities, reviews, images, prices, and more.
|
|
620
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/hotel_info/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/google/hotel_info/task_post/",example:[{language_code:"en",location_name:"New York,New York,United States",hotel_identifier:"ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE",tag:"some_string_123",postback_url:"https://your-server.com/postbackscript.php",postback_data:"advanced"}]},{path:"/v3/business_data/google/hotel_info/tasks_ready",method:"get",operationId:"GoogleHotelInfoTasksReady",tag:"BusinessData",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
621
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/hotel_info/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/google/hotel_info/tasks_ready/"},{path:"/v3/business_data/google/hotel_info/task_get/advanced/{id}",method:"get",operationId:"GoogleHotelInfoTaskGetAdvanced",tag:"BusinessData",description:"for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/hotel_info/task_get/advanced/?bash'",docUrl:"https://docs.dataforseo.com/v3/business_data/google/hotel_info/task_get/advanced/"},{path:"/v3/business_data/google/hotel_info/task_get/html/{id}",method:"get",operationId:"GoogleHotelInfoTaskGetHtml",tag:"BusinessData",description:"for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/hotel_info/task_get/html/?bash'",docUrl:"https://docs.dataforseo.com/v3/business_data/google/hotel_info/task_get/html/"},{path:"/v3/business_data/google/hotel_info/live/advanced",method:"post",operationId:"GoogleHotelInfoLiveAdvanced",tag:"BusinessData",description:`Google Hotel Info will provide you with structured data available for a specific hotel entity on the Google Hotels platform: such as service description, location details, rating, amenities, reviews, images, prices, and more.
|
|
622
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/hotel_info/live/advanced/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/google/hotel_info/live/advanced/",example:[{language_code:"en",location_name:"New York,New York,United States",hotel_identifier:"CgoI-KWyzenM_MV3EAE"}]},{path:"/v3/business_data/google/hotel_info/live/html",method:"post",operationId:"GoogleHotelInfoLiveHtml",tag:"BusinessData",description:`Google Hotel Info will provide you with unstructured HTML data available for a specific hotel entity on the Google Hotels platform: such as service description, location details, rating, amenities, reviews, images, prices, and more.
|
|
623
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/hotel_info/live/html/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/google/hotel_info/live/html/",example:[{language_code:"en",location_name:"New York,New York,United States",hotel_identifier:"ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE"}]},{path:"/v3/business_data/google/reviews/task_post",method:"post",operationId:"GoogleReviewsTaskPost",tag:"BusinessData",description:`This endpoint provides results from the “Reviews” element of Google SERPs. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) parameters.
|
|
624
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/reviews/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/google/reviews/task_post/",example:[{location_name:"London,England,United Kingdom",language_name:"English",keyword:"hedonism wines",depth:50,sort_by:"highest_rating"}]},{path:"/v3/business_data/google/reviews/tasks_ready",method:"get",operationId:"GoogleReviewsTasksReady",tag:"BusinessData",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
625
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/reviews/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/google/reviews/tasks_ready/"},{path:"/v3/business_data/google/reviews/task_get/{id}",method:"get",operationId:"GoogleReviewsTaskGet",tag:"BusinessData",description:`The returned results are specific to the indicated local establishment name, search engine, location and language parameters. We emulate set location and search engine with the highest accuracy so that the results you receive will match the actual search results for the specified parameters at the time of task setting. You can always check the returned results accessing the check_url in the Incognito mode to make sure the received data is entirely relevant. Note that user preferences, search history, and other personalized search factors are ignored by our system and thus would not be reflected in the returned results.
|
|
626
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/reviews/task_get/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/google/reviews/task_get/"},{path:"/v3/business_data/google/extended_reviews/task_post",method:"post",operationId:"GoogleExtendedReviewsTaskPost",tag:"BusinessData",description:`This endpoint provides results from the “Reviews” element of Google SERPs, including not only Google user reviews but also reviews from other reputable sources (e.g., TripAdvisor, Yelp, Trustpilot). The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) parameters.
|
|
627
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/extended_reviews/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/google/extended_reviews/task_post/",example:[{location_name:"London,England,United Kingdom",language_name:"english",cid:"17626775537598922320"}]},{path:"/v3/business_data/google/extended_reviews/tasks_ready",method:"get",operationId:"GoogleExtendedReviewsTasksReady",tag:"BusinessData",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
628
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/extended_reviews/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/google/extended_reviews/tasks_ready/"},{path:"/v3/business_data/google/extended_reviews/task_get/{id}",method:"get",operationId:"GoogleExtendedReviewsTaskGet",tag:"BusinessData",description:`The returned results are specific to the indicated local establishment name, search engine, location and language parameters. We emulate set location and search engine with the highest accuracy so that the results you receive will match the actual search results for the specified parameters at the time of task setting. You can always check the returned results accessing the check_url in the Incognito mode to make sure the received data is entirely relevant. Note that user preferences, search history, and other personalized search factors are ignored by our system and thus would not be reflected in the returned results.
|
|
629
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/extended_reviews/task_get/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/google/extended_reviews/task_get/"},{path:"/v3/business_data/google/questions_and_answers/task_post",method:"post",operationId:"GoogleQuestionsAndAnswersTaskPost",tag:"BusinessData",description:`This endpoint will provide you with a detailed overview of questions and answers associated with a specific business entity listed on Google My Business. By submitting a request to this endpoint, you can access comprehensive data on the inquiries and responses related to a particular business, including the full text of the questions and answers, as well as metadata such as timestamps, user information.
|
|
630
|
+
|
|
631
|
+
The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
|
|
632
|
+
|
|
633
|
+
Your account will be billed for every 20 questions, the maximum number of answers returned for each question is 5.
|
|
634
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/questions_and_answers/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/google/questions_and_answers/task_post/",example:[{language_code:"en",location_name:"Los Angeles,California,United States",keyword:"The Last Bookstore"}]},{path:"/v3/business_data/google/questions_and_answers/tasks_ready",method:"get",operationId:"GoogleQuestionsAndAnswersTasksReady",tag:"BusinessData",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
635
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/questions_and_answers/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/google/questions_and_answers/tasks_ready/"},{path:"/v3/business_data/google/questions_and_answers/task_get/{id}",method:"get",operationId:"GoogleQuestionsAndAnswersTaskGet",tag:"BusinessData",description:"for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/questions_and_answers/task_get/?bash'",docUrl:"https://docs.dataforseo.com/v3/business_data/google/questions_and_answers/task_get/"},{path:"/v3/business_data/google/questions_and_answers/live",method:"post",operationId:"GoogleQuestionsAndAnswersLive",tag:"BusinessData",description:`This endpoint will provide you with a detailed overview of questions and answers associated with a specific business entity listed on Google My Business. By submitting a request to this endpoint, you can access comprehensive data on the inquiries and responses related to a particular business, including the full text of the questions and answers, as well as metadata such as timestamps, user information.
|
|
636
|
+
|
|
637
|
+
The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
|
|
638
|
+
|
|
639
|
+
Your account will be billed for every 20 questions, the maximum number of answers returned for each question is 5.
|
|
640
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/questions_and_answers/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/google/questions_and_answers/live/",example:[{language_code:"en",location_name:"Los Angeles,California,United States",keyword:"The Last Bookstore"}]},{path:"/v3/business_data/trustpilot/search/task_post",method:"post",operationId:"TrustpilotSearchTaskPost",tag:"BusinessData",description:`This endpoint provides a list of business profiles listed on the Trustpilot platform. The returned results are relevant to the specified keyword.
|
|
641
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/trustpilot/search/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/trustpilot/search/task_post/",example:[{keyword:"pizza restaurant",depth:20}]},{path:"/v3/business_data/trustpilot/search/tasks_ready",method:"get",operationId:"TrustpilotSearchTasksReady",tag:"BusinessData",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
642
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/trustpilot/search/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/trustpilot/search/tasks_ready/"},{path:"/v3/business_data/trustpilot/search/task_get/{id}",method:"get",operationId:"TrustpilotSearchTaskGet",tag:"BusinessData",description:`This endpoint provides a list of business profiles listed on the Trustpilot platform. The returned results are relevant to the keyword specified in a POST request. We emulate set parameters with the highest accuracy so that the results you receive match the actual search results for the specified parameters at the time of task setting. You can always check the returned results accessing the check_url in the Incognito mode to make sure the received data is entirely relevant. Note that user preferences, search history, and other personalized search factors are ignored by our system and thus will not be reflected in the returned results.
|
|
643
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/trustpilot/search/task_get/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/trustpilot/search/task_get/"},{path:"/v3/business_data/trustpilot/reviews/task_post",method:"post",operationId:"TrustpilotReviewsTaskPost",tag:"BusinessData",description:`This endpoint provides reviews published on the Trustpilot platform for the local establishment specified in the domain field.
|
|
644
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/trustpilot/reviews/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/trustpilot/reviews/task_post/",example:[{domain:"www.thepearlsource.com",depth:40}]},{path:"/v3/business_data/trustpilot/reviews/tasks_ready",method:"get",operationId:"TrustpilotReviewsTasksReady",tag:"BusinessData",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
645
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/trustpilot/reviews/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/trustpilot/reviews/tasks_ready/"},{path:"/v3/business_data/trustpilot/reviews/task_get/{id}",method:"get",operationId:"TrustpilotReviewsTaskGet",tag:"BusinessData",description:`This endpoint provides reviews published on the Trustpilot platform The returned results are specific to the indicated business entity. We emulate set parameters with the highest accuracy so that the results you receive will match the actual search results for the specified parameters at the time of task setting. You can always check the returned results accessing the check_url in the Incognito mode to make sure the received data is entirely relevant. Note that user preferences, search history, and other personalized search factors are ignored by our system and thus would not be reflected in the returned results.
|
|
646
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/trustpilot/reviews/task_get/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/trustpilot/reviews/task_get/"},{path:"/v3/business_data/tripadvisor/locations",method:"get",operationId:"TripadvisorLocations",tag:"BusinessData",description:`You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task. Note that supported location types in Tripadvisor Business Data API are City and Region only.
|
|
647
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/tripadvisor/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/tripadvisor/locations/"},{path:"/v3/business_data/tripadvisor/locations/{country}",method:"get",operationId:"TripadvisorLocationsCountry",tag:"BusinessData",description:`You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task. Note that supported location types in Tripadvisor Business Data API are City and Region only.
|
|
648
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/tripadvisor/locations/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/tripadvisor/locations/"},{path:"/v3/business_data/tripadvisor/languages",method:"get",operationId:"TripadvisorLanguages",tag:"BusinessData",description:`You will receive the list of languages by calling this API.
|
|
649
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/tripadvisor/languages/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/tripadvisor/languages/"},{path:"/v3/business_data/tripadvisor/search/task_post",method:"post",operationId:"TripadvisorSearchTaskPost",tag:"BusinessData",description:`This endpoint provides a list of business profiles listed on the Tripadvisor platform. The returned results are relevant to the specified keyword and the selected location (see the List of Locations).
|
|
650
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/tripadvisor/search/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/tripadvisor/search/task_post/",example:[{keyword:"pizza",location_code:1003854,depth:30}]},{path:"/v3/business_data/tripadvisor/search/tasks_ready",method:"get",operationId:"TripadvisorSearchTasksReady",tag:"BusinessData",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
651
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/tripadvisor/search/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/tripadvisor/search/tasks_ready/"},{path:"/v3/business_data/tripadvisor/search/task_get/{id}",method:"get",operationId:"TripadvisorSearchTaskGet",tag:"BusinessData",description:`This endpoint will provide you with data on businesses listed on the Tripadvisor platform. The results obtained through this endpoint are specific to the location (see the List of Tripadvisor Locations) and keyword parameters used in the POST request.
|
|
652
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/tripadvisor/search/task_get/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/tripadvisor/search/task_get/"},{path:"/v3/business_data/tripadvisor/reviews/task_post",method:"post",operationId:"TripadvisorReviewsTaskPost",tag:"BusinessData",description:`This endpoint provides results from the “Reviews” element on the Tripadvisor platform. The results are specific to the URL path or keyword you indicate, and and the selected location (see the List of Locations).
|
|
653
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/tripadvisor/reviews/task_post/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/tripadvisor/reviews/task_post/",example:[{url_path:"Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html",location_code:1003854,pingback_url:"https://your-server.com/pingback.php?id=$id&tag=$tag",tag:"some_string_123"}]},{path:"/v3/business_data/tripadvisor/reviews/tasks_ready",method:"get",operationId:"TripadvisorReviewsTasksReady",tag:"BusinessData",description:`The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
|
|
654
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/tripadvisor/reviews/tasks_ready/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/tripadvisor/reviews/tasks_ready/"},{path:"/v3/business_data/tripadvisor/reviews/task_get/{id}",method:"get",operationId:"TripadvisorReviewsTaskGet",tag:"BusinessData",description:`This endpoint provides feedback data on businesses listed on the Tripadvisor platform, including their locations, ratings, review content and count. The results are specific to the URL path indicated in the POST request.
|
|
655
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/tripadvisor/reviews/task_get/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/tripadvisor/reviews/task_get/"},{path:"/v3/business_data/social_media/pinterest/live",method:"post",operationId:"SocialMediaPinterestLive",tag:"BusinessData",description:`Social Media Pinterest API will provide you with data on pins made from the specified URLs. Pins on Pinterest correspond to content saves. For each specified page URL, you will get the number of content saves to Pinterest made using the Pinterest Save Button placed on that page.
|
|
656
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/social_media/pinterest/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/social_media/pinterest/live/",example:[{targets:["https://www.simplyrecipes.com/recipes/grilled_salmon_with_cucumber_mango_salsa/","https://tasty.co/recipe/classic-lasagna","https://www.allrecipes.com/recipe/255263/sicilian-roasted-chicken/"],tag:"some_string_123"}]},{path:"/v3/business_data/social_media/reddit/live",method:"post",operationId:"SocialMediaRedditLive",tag:"BusinessData",description:`Social Media Reddit API provides information for each share of the target webpage on Reddit. For each specified Reddit URL, you will get subreddit and author names, permalink, title, and the number of subreddit members.
|
|
657
|
+
for more info please visit 'https://docs.dataforseo.com/v3/business_data/social_media/reddit/live/?bash'`,docUrl:"https://docs.dataforseo.com/v3/business_data/social_media/reddit/live/",example:[{targets:["https://vk.com/","https://ahrefs.com/","https://google.com/","https://twitter.com/","https://reddit.com/","https://facebook.com/"],tag:"some_string_123"}]},{path:"/v3/appendix/user_data",method:"get",operationId:"UserData",tag:"Appendix",description:`You will receive detailed information about your API usage, prices, spending and other account details by calling this API.
|
|
658
|
+
for more info please visit 'https://docs.dataforseo.com/v3/appendix/user_data/?bash'`,docUrl:"https://docs.dataforseo.com/v3/appendix/user_data/"},{path:"/v3/appendix/errors",method:"get",operationId:"Errors",tag:"Appendix",description:`This endpoint returns a list of possible DataForSEO API errors and general status codes. Below you will find a list of HTTP response codes and internal messages. We recommend storing the data connected to error codes in your application log and designing a necessary system for handling related exceptional or error conditions.
|
|
659
|
+
for more info please visit 'https://docs.dataforseo.com/v3/appendix/errors/?bash'`,docUrl:"https://docs.dataforseo.com/v3/appendix/errors/"},{path:"/v3/appendix/webhook_resend",method:"post",operationId:"WebhookResend",tag:"Appendix",description:`Using this endpoint you can resend webhooks (pingbacks and postbacks) for up to 100 specified tasks.
|
|
660
|
+
Note: Your account will not be double-charged for resending a webhook.
|
|
661
|
+
for more info please visit 'https://docs.dataforseo.com/v3/appendix/webhook_resend/?bash'`,docUrl:"https://docs.dataforseo.com/v3/appendix/webhook_resend/",example:[{id:"08161139-0001-0066-1000-06491d097ed5"}]},{path:"/v3/appendix/status",method:"get",operationId:"AppendixStatus",tag:"Appendix",description:`By calling this API you will receive detailed information about the current status of all our APIs and endpoints. You will also get a full issue description if a problem occurs.
|
|
662
|
+
for more info please visit 'https://docs.dataforseo.com/v3/appendix/status/?bash'`,docUrl:"https://docs.dataforseo.com/v3/appendix/status/"}];var ue=po;function go(){return ue}function Z(e){let o=ho(e);return ue.find((t)=>ho(t.path)===o)}function mo(e,o){let t=e.toLowerCase();return ue.filter((a)=>{if(o&&a.tag?.toLowerCase()!==o.toLowerCase())return!1;if(!t)return!0;return a.path.toLowerCase().includes(t)||a.operationId?.toLowerCase().includes(t)||a.description?.toLowerCase().includes(t)})}function ho(e){let o=e.trim();if(!o.startsWith("/"))o="/"+o;if(!o.startsWith("/v3/"))o="/v3"+o;return o.replace(/\/+$/,"")}var ve="ram",ee=new TextEncoder,Ra=g({name:"list",resource:ve,spec:new h({description:"List endpoints, optionally filtered by tag and/or query.",options:[new p({short:"t",long:"tag",valueKind:c.TEXT,description:"Filter by tag."}),new p({short:"q",long:"query",valueKind:c.TEXT,description:"Substring match."}),new p({long:"json",valueKind:c.NONE,description:"Emit JSON instead of lines."})]}),fn:async(e,o,t,a)=>{let s=y(a,"tag")||void 0,i=mo(y(a,"query",""),s);if(G(a,"json"))return[ee.encode(JSON.stringify(i,null,2)+`
|
|
663
|
+
`),new L];let n=i.map((r)=>`${r.method.toUpperCase().padEnd(4)} ${r.path}`).join(`
|
|
664
|
+
`);return[ee.encode(n+`
|
|
665
|
+
`),new L({stderr:`
|
|
666
|
+
(${i.length} endpoints)
|
|
667
|
+
`})]}}),Ea=g({name:"show",resource:ve,spec:new h({description:"Show details for one endpoint.",positional:[u("path")]}),fn:async(e,o,t)=>{let a=t[0]??"",s=Z(a);if(!s)return[null,new L({exitCode:1,stderr:`No endpoint matches ${a}
|
|
668
|
+
`})];let i=`${s.method.toUpperCase()} ${s.path}
|
|
669
|
+
`;if(s.tag)i+=`tag: ${s.tag}
|
|
670
|
+
`;if(s.operationId)i+=`operationId: ${s.operationId}
|
|
671
|
+
`;if(s.docUrl)i+=`docs: ${s.docUrl}
|
|
672
|
+
`;if(s.description)i+=`
|
|
673
|
+
${s.description}
|
|
674
|
+
`;if(s.example!==void 0)i+=`
|
|
675
|
+
example body:
|
|
676
|
+
${JSON.stringify(s.example,null,2)}
|
|
677
|
+
`;return[ee.encode(i),new L]}}),za=g({name:"tags",resource:ve,spec:new h({description:"List all tags and how many endpoints each has."}),fn:async()=>{let e=new Map;for(let a of go()){let s=a.tag??"(untagged)";e.set(s,(e.get(s)??0)+1)}let t=[...e.entries()].sort((a,s)=>s[1]-a[1]).map(([a,s])=>`${String(s).padStart(4)} ${a}`).join(`
|
|
678
|
+
`);return[ee.encode(t+`
|
|
679
|
+
`),new L]}}),fo=A({name:"endpoints",description:"Discover and inspect DataForSEO endpoints.",commands:[Ra,Ea,za]});function oe(e){let o={};if(e.locationCode!==void 0)o.location_code=e.locationCode;else o.location_name=e.locationName??"United States";if(e.languageCode!==void 0)o.language_code=e.languageCode;else o.language_name=e.languageName??"English";return o}async function uo(e){return v("keywords_data/google_ads/search_volume/live",{...oe(e),keywords:e.keywords,include_serp_info:e.includeSerpInfo??!1})}async function vo(e){return v("dataforseo_labs/google/keyword_ideas/live",{...oe(e),keywords:e.keywords,limit:e.limit??100})}async function _o(e){return v("dataforseo_labs/google/keyword_suggestions/live",{...oe(e),keyword:e.keyword,limit:e.limit??100})}async function yo(e){return v("dataforseo_labs/google/ranked_keywords/live",{...oe(e),target:e.target,limit:e.limit??100})}var te="ram";function ae(e){return k(e)}var Ba=g({name:"search-volume",resource:te,spec:new h({description:"Get monthly search volume / CPC / competition for keywords.",positional:[u("keywords",{variadic:!0})],options:[...w,new p({long:"include-serp-info",valueKind:c.NONE,description:"Also return SERP feature snapshot."}),...m]}),fn:async(e,o,t,a)=>{let s=await uo({...ae(a),keywords:[...t],includeSerpInfo:G(a,"include-serp-info")});return f(s,a)}}),Oa=g({name:"ideas",resource:te,spec:new h({description:"Get keyword ideas (DataForSEO Labs).",positional:[u("keywords",{variadic:!0})],options:[...w,new p({long:"limit",valueKind:c.TEXT,description:"Max results.",defaultValue:"100"}),...m]}),fn:async(e,o,t,a)=>{let s=await vo({...ae(a),keywords:[...t],limit:I(a,"limit",100)});return f(s,a)}}),Ya=g({name:"suggestions",resource:te,spec:new h({description:"Get keyword suggestions for a seed keyword.",positional:[u("keyword")],options:[...w,new p({long:"limit",valueKind:c.TEXT,description:"Max results.",defaultValue:"100"}),...m]}),fn:async(e,o,t,a)=>{let s=await _o({...ae(a),keyword:t[0]??"",limit:I(a,"limit",100)});return f(s,a)}}),qa=g({name:"ranked",resource:te,spec:new h({description:"Keywords a target domain or URL ranks for.",positional:[u("target")],options:[...w,new p({long:"limit",valueKind:c.TEXT,description:"Max results.",defaultValue:"100"}),...m]}),fn:async(e,o,t,a)=>{let s=await yo({...ae(a),target:t[0]??"",limit:I(a,"limit",100)});return f(s,a)}}),ko=A({name:"keywords",description:"Search volume, ideas, suggestions.",commands:[Ba,Oa,Ya,qa]});function E(e){let o={};if(e.locationCode!==void 0)o.location_code=e.locationCode;else o.location_name=e.locationName??"United States";if(e.languageCode!==void 0)o.language_code=e.languageCode;else o.language_name=e.languageName??"English";return o}async function wo(e){return v("dataforseo_labs/google/competitors_domain/live",{...E(e),target:e.target,limit:e.limit??100})}async function bo(e){return v("dataforseo_labs/google/domain_intersection/live",{...E(e),target1:e.target1,target2:e.target2,limit:e.limit??100})}async function To(e){return v("dataforseo_labs/google/domain_rank_overview/live",{...E(e),target:e.target})}async function Io(e){return v("dataforseo_labs/google/related_keywords/live",{...E(e),keyword:e.keyword,limit:e.limit??100})}async function So(e){return v("dataforseo_labs/google/keyword_overview/live",{...E(e),keywords:e.keywords,include_serp_info:e.includeSerpInfo??!1,include_clickstream_data:e.includeClickstream??!1})}async function Lo(e){return v("dataforseo_labs/google/bulk_keyword_difficulty/live",{...E(e),keywords:e.keywords})}async function Ao(e){return v("dataforseo_labs/google/search_intent/live",{...E(e),keywords:e.keywords})}async function Go(e){return v("dataforseo_labs/google/top_searches/live",{...E(e),limit:e.limit??100})}async function Uo(e){return v("dataforseo_labs/google/historical_rank_overview/live",{...E(e),target:e.target})}var z="ram",se=new p({long:"limit",valueKind:c.TEXT,description:"Max results.",defaultValue:"100"}),Fa=g({name:"competitors",resource:z,spec:new h({description:"Domains competing with the target on organic search.",positional:[u("target")],options:[...w,se,...m]}),fn:async(e,o,t,a)=>{let s=await wo({...k(a),target:t[0]??"",limit:I(a,"limit",100)});return f(s,a)}}),Ma=g({name:"intersection",resource:z,spec:new h({description:"Keyword overlap between two domains.",positional:[u("target1"),u("target2")],options:[...w,se,...m]}),fn:async(e,o,t,a)=>{let s=await bo({...k(a),target1:t[0]??"",target2:t[1]??"",limit:I(a,"limit",100)});return f(s,a)}}),Ka=g({name:"overview",resource:z,spec:new h({description:"Domain rank overview (organic + paid traffic estimates).",positional:[u("target")],options:[...w,...m]}),fn:async(e,o,t,a)=>{let s=await To({...k(a),target:t[0]??""});return f(s,a)}}),Ca=g({name:"related",resource:z,spec:new h({description:"Semantically related keywords.",positional:[u("keyword")],options:[...w,se,...m]}),fn:async(e,o,t,a)=>{let s=await Io({...k(a),keyword:t[0]??"",limit:I(a,"limit",100)});return f(s,a)}}),Na=g({name:"keyword-overview",resource:z,spec:new h({description:"Full keyword profile: KD + volume + intent + SERP + backlinks for keywords.",positional:[u("keywords",{variadic:!0})],options:[...w,new p({long:"include-serp-info",valueKind:c.NONE,description:"Include SERP feature snapshot."}),new p({long:"include-clickstream",valueKind:c.NONE,description:"Include clickstream-derived volume."}),...m]}),fn:async(e,o,t,a)=>{let s=await So({...k(a),keywords:[...t],includeSerpInfo:G(a,"include-serp-info"),includeClickstream:G(a,"include-clickstream")});return f(s,a)}}),Ha=g({name:"bulk-difficulty",resource:z,spec:new h({description:"Bulk keyword difficulty (KD) for up to 1000 keywords in one call.",positional:[u("keywords",{variadic:!0})],options:[...w,...m]}),fn:async(e,o,t,a)=>{let s=await Lo({...k(a),keywords:[...t]});return f(s,a)}}),Xa=g({name:"intent",resource:z,spec:new h({description:"Classify search intent (informational/navigational/commercial/transactional) for keywords.",positional:[u("keywords",{variadic:!0})],options:[...w,...m]}),fn:async(e,o,t,a)=>{let s=await Ao({...k(a),keywords:[...t]});return f(s,a)}}),Wa=g({name:"top-searches",resource:z,spec:new h({description:"Currently-trending top searches in a location.",options:[...w,se,...m]}),fn:async(e,o,t,a)=>{let s=await Go({...k(a),limit:I(a,"limit",100)});return f(s,a)}}),Ja=g({name:"historical",resource:z,spec:new h({description:"Historical rank overview for a domain (month-by-month position counts).",positional:[u("target")],options:[...w,...m]}),fn:async(e,o,t,a)=>{let s=await Uo({...k(a),target:t[0]??""});return f(s,a)}}),Po=A({name:"labs",description:"DataForSEO Labs: competitors, gap analysis, keyword overview, intent, historical.",commands:[Fa,Ma,Ka,Ca,Na,Ha,Xa,Wa,Ja]});var Do="ram",xo=new TextEncoder,Ro=g({name:"login",resource:Do,spec:new h({description:"Save DataForSEO credentials to ~/.config/dataforseo/config.json (chmod 600).",options:[new p({short:"l",long:"login",valueKind:c.TEXT,description:"API login (email).",required:!0}),new p({short:"p",long:"password",valueKind:c.TEXT,description:"API password.",required:!0}),new p({long:"no-verify",valueKind:c.NONE,description:"Skip the verification call."})]}),fn:async(e,o,t,a)=>{let s=y(a,"login"),i=y(a,"password");if(!G(a,"no-verify")){process.env.DATAFORSEO_LOGIN=s,process.env.DATAFORSEO_PASSWORD=i;try{await R("/v3/appendix/user_data")}catch(r){return[null,new L({exitCode:1,stderr:`Credentials rejected: ${r.message}
|
|
680
|
+
Run with --no-verify to save anyway.
|
|
681
|
+
`})]}}let n=Ce({login:s,password:i});return[xo.encode(`Saved credentials to ${n}
|
|
682
|
+
`),new L]}}),Eo=g({name:"whoami",resource:Do,spec:new h({description:"Show the configured login (and verify against DataForSEO)."}),fn:async()=>{let o=`login: ${H().login}
|
|
683
|
+
config: ${Ke()}
|
|
684
|
+
`,a=(await R("/v3/appendix/user_data")).tasks?.[0]?.result?.[0];if(a?.money?.balance!==void 0)o+=`balance: $${a.money.balance.toFixed(2)}
|
|
685
|
+
`;return[xo.encode(o),new L]}});async function zo(e="serp/google"){return R(`${e}/locations`)}async function Bo(e="serp/google"){return R(`${e}/languages`)}async function Oo(){return R("/v3/appendix/user_data")}var _e="ram",Yo=g({name:"locations",resource:_e,spec:new h({description:"List supported locations for a given API.",options:[new p({long:"api",valueKind:c.TEXT,description:"API path under /v3.",defaultValue:"serp/google"}),...m]}),fn:async(e,o,t,a)=>{let s=await zo(y(a,"api","serp/google"));return f(s,a)}}),qo=g({name:"languages",resource:_e,spec:new h({description:"List supported languages for a given API.",options:[new p({long:"api",valueKind:c.TEXT,description:"API path under /v3.",defaultValue:"serp/google"}),...m]}),fn:async(e,o,t,a)=>{let s=await Bo(y(a,"api","serp/google"));return f(s,a)}}),Fo=g({name:"user",resource:_e,spec:new h({description:"Show DataForSEO account info (balance, plan, limits).",options:[...m]}),fn:async(e,o,t,a)=>{let s=await Oo();return f(s,{...a,flags:{...a.flags,full:!0}})}});import{readFileSync as ja}from"node:fs";var $a="ram",Mo=g({name:"raw",resource:$a,spec:new h({description:"Hit any DataForSEO endpoint by path (escape hatch over the full 437-endpoint API).",positional:[u("path")],options:[new p({short:"d",long:"data",valueKind:c.TEXT,description:"Inline JSON body."}),new p({short:"f",long:"data-file",valueKind:c.TEXT,description:"Read JSON body from file. '-' for stdin."}),new p({long:"kv",valueKind:c.TEXT,description:"Shorthand body fields, comma-separated, e.g. keyword=seo,location_code=2840."}),new p({long:"example",valueKind:c.NONE,description:"Use the spec's example body."}),new p({long:"method",valueKind:c.TEXT,description:"Override HTTP method."}),new p({long:"no-wrap",valueKind:c.NONE,description:"Don't auto-wrap a single task as [task]."}),...m],rest:new q({kind:c.TEXT,name:"kvpairs"})}),fn:async(e,o,t,a)=>{let s=t[0]??"";if(!s)return[null,new L({exitCode:2,stderr:`raw: missing <path>
|
|
686
|
+
`})];let i=Z(s),r=(y(a,"method")||i?.method||"post").toLowerCase(),d=await Qa(a,i?.example,t.slice(1)),l;if(r==="get")l=await R(s);else l=await v(s,d,{wrapAsTaskArray:!G(a,"no-wrap")});return f(l,a)}});async function Qa(e,o,t){if(G(e,"example")){if(o===void 0)throw Error("No example body in spec for this endpoint.");return o}let a=y(e,"data");if(a)return JSON.parse(a);let s=y(e,"data-file");if(s){let r=s==="-"?await es():ja(s,"utf8");return JSON.parse(r)}let i=y(e,"kv"),n=[];if(i)n.push(...i.split(","));if(n.push(...t.filter((r)=>r.includes("="))),n.length>0)return Va(n);return}function Va(e){let o={};for(let t of e){let a=t.indexOf("=");if(a===-1)continue;o[t.slice(0,a).trim()]=Za(t.slice(a+1))}return o}function Za(e){if(e==="true")return!0;if(e==="false")return!1;if(e==="null")return null;if(/^-?\d+$/.test(e))return Number(e);if(/^-?\d*\.\d+$/.test(e))return Number(e);if(e.startsWith("[")&&e.endsWith("]")||e.startsWith("{")&&e.endsWith("}"))try{return JSON.parse(e)}catch{return e}return e}async function es(){let e=[];for await(let o of process.stdin)e.push(o);return Buffer.concat(e).toString("utf8")}function W(e){let o={};if(e.locationCode!==void 0)o.location_code=e.locationCode;else o.location_name=e.locationName??"United States";if(e.languageCode!==void 0)o.language_code=e.languageCode;else o.language_name=e.languageName??"English";return o}async function Ko(e){let o=e.advanced?"serp/google/organic/live/advanced":"serp/google/organic/live/regular";return v(o,{...W(e),keyword:e.keyword,device:e.device??"desktop",depth:e.depth??100})}async function Co(e){return v("serp/google/maps/live/advanced",{...W(e),keyword:e.keyword,device:e.device??"desktop",depth:e.depth??100})}async function No(e){return v("serp/youtube/organic/live/advanced",{...W(e),keyword:e.keyword,depth:e.depth??100})}async function Ho(e){return v("serp/google/news/live/advanced",{...W(e),keyword:e.keyword,device:e.device??"desktop",depth:e.depth??100})}async function Xo(e){return v("serp/google/images/live/advanced",{...W(e),keyword:e.keyword,device:e.device??"desktop",depth:e.depth??100})}var J="ram",j=[...w,new p({long:"device",valueKind:c.TEXT,description:"desktop | mobile.",defaultValue:"desktop"}),new p({long:"depth",valueKind:c.TEXT,description:"Result depth.",defaultValue:"100"})],os=g({name:"organic",resource:J,spec:new h({description:"Live Google organic SERP for a keyword.",positional:[u("keyword")],options:[...j,new p({long:"advanced",valueKind:c.NONE,description:"Use the advanced endpoint with featured snippet detail."}),...m]}),fn:async(e,o,t,a)=>{let s=await Ko({...k(a),keyword:t[0]??"",device:y(a,"device","desktop"),depth:I(a,"depth",100),advanced:G(a,"advanced")});return f(s,a)}}),ts=g({name:"maps",resource:J,spec:new h({description:"Google Maps / local pack results.",positional:[u("keyword")],options:[...j,...m]}),fn:async(e,o,t,a)=>{let s=await Co({...k(a),keyword:t[0]??"",device:y(a,"device","desktop"),depth:I(a,"depth",100)});return f(s,a)}}),as=g({name:"news",resource:J,spec:new h({description:"Google News results for a keyword.",positional:[u("keyword")],options:[...j,...m]}),fn:async(e,o,t,a)=>{let s=await Ho({...k(a),keyword:t[0]??"",device:y(a,"device","desktop"),depth:I(a,"depth",100)});return f(s,a)}}),ss=g({name:"images",resource:J,spec:new h({description:"Google Images results for a keyword.",positional:[u("keyword")],options:[...j,...m]}),fn:async(e,o,t,a)=>{let s=await Xo({...k(a),keyword:t[0]??"",device:y(a,"device","desktop"),depth:I(a,"depth",100)});return f(s,a)}}),is=g({name:"organic",resource:J,spec:new h({description:"YouTube organic search results.",positional:[u("keyword")],options:[...j,...m]}),fn:async(e,o,t,a)=>{let s=await No({...k(a),keyword:t[0]??"",depth:I(a,"depth",100)});return f(s,a)}}),Wo=A({name:"serp",description:"SERP queries against Google / YouTube.",groups:[A({name:"google",description:"Google SERPs.",commands:[os,ts,as,ss]}),A({name:"youtube",description:"YouTube SERPs.",commands:[is]})]});function ye(e){let o={};if(e.locationCode!==void 0)o.location_code=e.locationCode;else o.location_name=e.locationName??"United States";if(e.languageCode!==void 0)o.language_code=e.languageCode;return o}async function Jo(e){return v("keywords_data/google_trends/explore/live",{...ye(e),keywords:e.keywords,type:e.type??"web",date_from:e.dateFrom,date_to:e.dateTo})}async function jo(e){return v("keywords_data/dataforseo_trends/demography/live",{...ye(e),keywords:e.keywords})}async function $o(e){return v("keywords_data/dataforseo_trends/subregion_interests/live",{...ye(e),keywords:e.keywords})}var ke="ram",rs=g({name:"explore",resource:ke,spec:new h({description:"Google Trends 'Explore' — popularity time series for keywords.",positional:[u("keywords",{variadic:!0})],options:[...w,new p({long:"type",valueKind:c.TEXT,description:"web | news | youtube | images | shopping.",defaultValue:"web"}),new p({long:"date-from",valueKind:c.TEXT,description:"Start date (YYYY-MM-DD)."}),new p({long:"date-to",valueKind:c.TEXT,description:"End date (YYYY-MM-DD)."}),...m]}),fn:async(e,o,t,a)=>{let s=await Jo({...k(a),keywords:[...t],type:y(a,"type","web"),dateFrom:y(a,"date-from")||void 0,dateTo:y(a,"date-to")||void 0});return f(s,a)}}),ns=g({name:"demography",resource:ke,spec:new h({description:"Age/gender demographics for keyword interest (DataForSEO Trends).",positional:[u("keywords",{variadic:!0})],options:[...w,...m]}),fn:async(e,o,t,a)=>{let s=await jo({...k(a),keywords:[...t]});return f(s,a)}}),ds=g({name:"subregion",resource:ke,spec:new h({description:"Regional popularity heatmap for keywords (DataForSEO Trends).",positional:[u("keywords",{variadic:!0})],options:[...w,...m]}),fn:async(e,o,t,a)=>{let s=await $o({...k(a),keywords:[...t]});return f(s,a)}}),Qo=A({name:"trends",description:"Google Trends + DataForSEO Trends (time series, demography, region).",commands:[rs,ns,ds]});function Vo(){let e=new N;return e.name("dfs").description("Ergonomic CLI for the DataForSEO API.\n\nCurated commands cover ~40 high-value endpoints.\nUse `dfs raw <path>` to hit any of the 437 endpoints by path,\nand `dfs endpoints list` / `dfs endpoints show` to discover them.").version("0.3.0"),e.addCommand(x(Ro)),e.addCommand(x(Eo)),e.addCommand(x(Yo)),e.addCommand(x(qo)),e.addCommand(x(Fo)),e.addCommand(x(Mo)),P(e,ko),P(e,Wo),P(e,lo),P(e,Po),P(e,to),P(e,Qo),P(e,fo),e}Vo().parseAsync(process.argv).catch((e)=>{let o=e instanceof Error?e.message:String(e);process.stderr.write(JSON.stringify({error:o})+`
|
|
687
|
+
`),process.exit(1)});
|