dataforseo-client 1.0.28 → 1.0.29

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.
Files changed (5) hide show
  1. package/main.d.ts +1917 -989
  2. package/main.js +2220 -1165
  3. package/main.js.map +1 -1
  4. package/main.ts +7300 -5331
  5. package/package.json +1 -1
package/main.d.ts CHANGED
@@ -1084,6 +1084,31 @@ export declare class SerpApi {
1084
1084
  */
1085
1085
  googleFinanceQuoteLiveHtml(body: (SerpGoogleFinanceQuoteLiveHtmlRequestInfo | undefined)[] | undefined): Promise<SerpGoogleFinanceQuoteLiveHtmlResponseInfo | null>;
1086
1086
  protected processGoogleFinanceQuoteLiveHtml(response: Response): Promise<SerpGoogleFinanceQuoteLiveHtmlResponseInfo | null>;
1087
+ /**
1088
+ * @param body (optional)
1089
+ * @return Successful operation
1090
+ */
1091
+ googleFinanceTickerSearchTaskPost(body: (SerpGoogleFinanceTickerSearchTaskPostRequestInfo | undefined)[] | undefined): Promise<SerpGoogleFinanceTickerSearchTaskPostResponseInfo | null>;
1092
+ protected processGoogleFinanceTickerSearchTaskPost(response: Response): Promise<SerpGoogleFinanceTickerSearchTaskPostResponseInfo | null>;
1093
+ /**
1094
+ * @return Successful operation
1095
+ */
1096
+ googleFinanceTickerSearchTasksReady(): Promise<SerpGoogleFinanceTickerSearchTasksReadyResponseInfo | null>;
1097
+ protected processGoogleFinanceTickerSearchTasksReady(response: Response): Promise<SerpGoogleFinanceTickerSearchTasksReadyResponseInfo | null>;
1098
+ /**
1099
+ * @param id task identifier
1100
+ unique task identifier in our system in the UUID format
1101
+ you will be able to use it within 30 days to request the results of the task at any time
1102
+ * @return Successful operation
1103
+ */
1104
+ googleFinanceTickerSearchTaskGetAdvanced(id: string): Promise<SerpGoogleFinanceTickerSearchTaskGetAdvancedResponseInfo | null>;
1105
+ protected processGoogleFinanceTickerSearchTaskGetAdvanced(response: Response): Promise<SerpGoogleFinanceTickerSearchTaskGetAdvancedResponseInfo | null>;
1106
+ /**
1107
+ * @param body (optional)
1108
+ * @return Successful operation
1109
+ */
1110
+ googleFinanceTickerSearchLiveAdvanced(body: (SerpGoogleFinanceTickerSearchLiveAdvancedRequestInfo | undefined)[] | undefined): Promise<SerpGoogleFinanceTickerSearchLiveAdvancedResponseInfo | null>;
1111
+ protected processGoogleFinanceTickerSearchLiveAdvanced(response: Response): Promise<SerpGoogleFinanceTickerSearchLiveAdvancedResponseInfo | null>;
1087
1112
  }
1088
1113
  export declare class DomainAnalyticsApi {
1089
1114
  private http;
@@ -1240,12 +1265,6 @@ export declare class DataforseoLabsApi {
1240
1265
  */
1241
1266
  googleKeywordIdeasLive(body: (DataforseoLabsGoogleKeywordIdeasLiveRequestInfo | undefined)[] | undefined): Promise<DataforseoLabsGoogleKeywordIdeasLiveResponseInfo | null>;
1242
1267
  protected processGoogleKeywordIdeasLive(response: Response): Promise<DataforseoLabsGoogleKeywordIdeasLiveResponseInfo | null>;
1243
- /**
1244
- * @param body (optional)
1245
- * @return Successful operation
1246
- */
1247
- googleHistoricalSearchVolumeLive(body: (DataforseoLabsGoogleHistoricalSearchVolumeLiveRequestInfo | undefined)[] | undefined): Promise<DataforseoLabsGoogleHistoricalSearchVolumeLiveResponseInfo | null>;
1248
- protected processGoogleHistoricalSearchVolumeLive(response: Response): Promise<DataforseoLabsGoogleHistoricalSearchVolumeLiveResponseInfo | null>;
1249
1268
  /**
1250
1269
  * @param body (optional)
1251
1270
  * @return Successful operation
@@ -1371,6 +1390,18 @@ export declare class DataforseoLabsApi {
1371
1390
  */
1372
1391
  googleHistoricalBulkTrafficEstimationLive(body: (DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveRequestInfo | undefined)[] | undefined): Promise<DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResponseInfo | null>;
1373
1392
  protected processGoogleHistoricalBulkTrafficEstimationLive(response: Response): Promise<DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResponseInfo | null>;
1393
+ /**
1394
+ * @param body (optional)
1395
+ * @return Successful operation
1396
+ */
1397
+ googleHistoricalKeywordDataLive(body: (DataforseoLabsGoogleHistoricalKeywordDataLiveRequestInfo | undefined)[] | undefined): Promise<DataforseoLabsGoogleHistoricalKeywordDataLiveResponseInfo | null>;
1398
+ protected processGoogleHistoricalKeywordDataLive(response: Response): Promise<DataforseoLabsGoogleHistoricalKeywordDataLiveResponseInfo | null>;
1399
+ /**
1400
+ * @param body (optional)
1401
+ * @return Successful operation
1402
+ */
1403
+ googleKeywordOverviewLive(body: (DataforseoLabsGoogleKeywordOverviewLiveRequestInfo | undefined)[] | undefined): Promise<DataforseoLabsGoogleKeywordOverviewLiveResponseInfo | null>;
1404
+ protected processGoogleKeywordOverviewLive(response: Response): Promise<DataforseoLabsGoogleKeywordOverviewLiveResponseInfo | null>;
1374
1405
  /**
1375
1406
  * @param body (optional)
1376
1407
  * @return Successful operation
@@ -3411,6 +3442,77 @@ export interface IBaseGoogleFinanceSerpElementItem {
3411
3442
  /** type of element */
3412
3443
  type?: string | undefined;
3413
3444
  }
3445
+ export declare class BaseGoogleFinanceTickerSearchSerpElementItem implements IBaseGoogleFinanceTickerSearchSerpElementItem {
3446
+ /** type of element */
3447
+ type?: string | undefined;
3448
+ /** group rank in SERP
3449
+ position within a group of elements with identical type values
3450
+ positions of elements with different type values are omitted from rank_group */
3451
+ rank_group?: number | undefined;
3452
+ /** absolute rank in SERP
3453
+ absolute position among all the elements in SERP */
3454
+ rank_absolute?: number | undefined;
3455
+ /** identifier of the element
3456
+ full identifier of the element that consists from ticker and market_identifier
3457
+ example: PX1:INDEXDB */
3458
+ identifier?: string | undefined;
3459
+ /** name of the market index as displayed on Google Finance
3460
+ example: CAC 40 */
3461
+ displayed_name?: string | undefined;
3462
+ /** URL to the page of the market index on Google Finance */
3463
+ url?: string | undefined;
3464
+ /** location of the market index
3465
+ example: Europe/Paris */
3466
+ location?: string | undefined;
3467
+ /** growth trend of the market index
3468
+ possible values: up, down, stable */
3469
+ trend?: string | undefined;
3470
+ /** date and time of the value readout
3471
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
3472
+ example:
3473
+ 2025-02-10 09:40:00 +00:00 */
3474
+ timestamp?: string | undefined;
3475
+ /** percentage of change in value of the market index */
3476
+ percentage_delta?: number | undefined;
3477
+ protected _discriminator: string;
3478
+ constructor(data?: IBaseGoogleFinanceTickerSearchSerpElementItem);
3479
+ init(_data?: any): void;
3480
+ static fromJS(data: any): BaseGoogleFinanceTickerSearchSerpElementItem;
3481
+ toJSON(data?: any): any;
3482
+ }
3483
+ export interface IBaseGoogleFinanceTickerSearchSerpElementItem {
3484
+ /** type of element */
3485
+ type?: string | undefined;
3486
+ /** group rank in SERP
3487
+ position within a group of elements with identical type values
3488
+ positions of elements with different type values are omitted from rank_group */
3489
+ rank_group?: number | undefined;
3490
+ /** absolute rank in SERP
3491
+ absolute position among all the elements in SERP */
3492
+ rank_absolute?: number | undefined;
3493
+ /** identifier of the element
3494
+ full identifier of the element that consists from ticker and market_identifier
3495
+ example: PX1:INDEXDB */
3496
+ identifier?: string | undefined;
3497
+ /** name of the market index as displayed on Google Finance
3498
+ example: CAC 40 */
3499
+ displayed_name?: string | undefined;
3500
+ /** URL to the page of the market index on Google Finance */
3501
+ url?: string | undefined;
3502
+ /** location of the market index
3503
+ example: Europe/Paris */
3504
+ location?: string | undefined;
3505
+ /** growth trend of the market index
3506
+ possible values: up, down, stable */
3507
+ trend?: string | undefined;
3508
+ /** date and time of the value readout
3509
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
3510
+ example:
3511
+ 2025-02-10 09:40:00 +00:00 */
3512
+ timestamp?: string | undefined;
3513
+ /** percentage of change in value of the market index */
3514
+ percentage_delta?: number | undefined;
3515
+ }
3414
3516
  export declare class BaseDataforseoLabsSerpElementItem implements IBaseDataforseoLabsSerpElementItem {
3415
3517
  /** type of element */
3416
3518
  type?: string | undefined;
@@ -4828,7 +4930,8 @@ you can find the full list of general informational messages here */
4828
4930
  [key: string]: any;
4829
4931
  }
4830
4932
  export declare class SectionContentItemInfo implements ISectionContentItemInfo {
4831
- /** content text */
4933
+ /** secondary content on the page
4934
+ you can find more information about content priority calculation in this help center article */
4832
4935
  text?: string | undefined;
4833
4936
  /** page URL.
4834
4937
  displayed in case the text is a link anchor */
@@ -4842,7 +4945,8 @@ displayed in case the text is a link anchor */
4842
4945
  toJSON(data?: any): any;
4843
4946
  }
4844
4947
  export interface ISectionContentItemInfo {
4845
- /** content text */
4948
+ /** secondary content on the page
4949
+ you can find more information about content priority calculation in this help center article */
4846
4950
  text?: string | undefined;
4847
4951
  /** page URL.
4848
4952
  displayed in case the text is a link anchor */
@@ -4851,6 +4955,42 @@ displayed in case the text is a link anchor */
4851
4955
  urls?: (ContentUrlInfo | undefined)[] | undefined;
4852
4956
  [key: string]: any;
4853
4957
  }
4958
+ export declare class KeywordInfoNormalizedWithInfo implements IKeywordInfoNormalizedWithInfo {
4959
+ /** date and time when the dataset was updated
4960
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
4961
+ example:
4962
+ 2019-11-15 12:57:46 +00:00 */
4963
+ last_updated_time?: string | undefined;
4964
+ /** current search volume rate of a keyword */
4965
+ search_volume?: string | undefined;
4966
+ /** keyword info is normalized
4967
+ if true, values are normalized with Bing data */
4968
+ is_normalized?: string | undefined;
4969
+ /** monthly search volume rates
4970
+ array of objects with search volume rates in a certain month of a year */
4971
+ monthly_searches?: (MonthlySearches | undefined)[] | undefined;
4972
+ [key: string]: any;
4973
+ constructor(data?: IKeywordInfoNormalizedWithInfo);
4974
+ init(_data?: any): void;
4975
+ static fromJS(data: any): KeywordInfoNormalizedWithInfo;
4976
+ toJSON(data?: any): any;
4977
+ }
4978
+ export interface IKeywordInfoNormalizedWithInfo {
4979
+ /** date and time when the dataset was updated
4980
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
4981
+ example:
4982
+ 2019-11-15 12:57:46 +00:00 */
4983
+ last_updated_time?: string | undefined;
4984
+ /** current search volume rate of a keyword */
4985
+ search_volume?: string | undefined;
4986
+ /** keyword info is normalized
4987
+ if true, values are normalized with Bing data */
4988
+ is_normalized?: string | undefined;
4989
+ /** monthly search volume rates
4990
+ array of objects with search volume rates in a certain month of a year */
4991
+ monthly_searches?: (MonthlySearches | undefined)[] | undefined;
4992
+ [key: string]: any;
4993
+ }
4854
4994
  export declare class ContentUrlInfo implements IContentUrlInfo {
4855
4995
  /** contains other URLs and anchors found in the content element */
4856
4996
  url?: string | undefined;
@@ -6320,7 +6460,7 @@ unique task identifier in our system in the UUID format */
6320
6460
  /** search engine specified when setting the task */
6321
6461
  se?: string | undefined;
6322
6462
  /** type of search engine
6323
- example: finance_quote */
6463
+ example: finance_ticker_search */
6324
6464
  se_type?: string | undefined;
6325
6465
  /** date when the task was posted (in the UTC format) */
6326
6466
  date_posted?: string | undefined;
@@ -6348,7 +6488,7 @@ unique task identifier in our system in the UUID format */
6348
6488
  /** search engine specified when setting the task */
6349
6489
  se?: string | undefined;
6350
6490
  /** type of search engine
6351
- example: finance_quote */
6491
+ example: finance_ticker_search */
6352
6492
  se_type?: string | undefined;
6353
6493
  /** date when the task was posted (in the UTC format) */
6354
6494
  date_posted?: string | undefined;
@@ -16157,7 +16297,7 @@ top_stories, news_search */
16157
16297
  se_results_count?: number | undefined;
16158
16298
  /** the number of results returned in the items array */
16159
16299
  items_count?: number | undefined;
16160
- /** items of the element */
16300
+ /** elements of search results found in SERP */
16161
16301
  items?: (BaseGoogleNewsSerpElementItem | undefined)[] | undefined;
16162
16302
  [key: string]: any;
16163
16303
  constructor(data?: ISerpGoogleNewsLiveAdvancedResultInfo);
@@ -16199,7 +16339,7 @@ top_stories, news_search */
16199
16339
  se_results_count?: number | undefined;
16200
16340
  /** the number of results returned in the items array */
16201
16341
  items_count?: number | undefined;
16202
- /** items of the element */
16342
+ /** elements of search results found in SERP */
16203
16343
  items?: (BaseGoogleNewsSerpElementItem | undefined)[] | undefined;
16204
16344
  [key: string]: any;
16205
16345
  }
@@ -36936,20 +37076,942 @@ you can receive the list of available languages of the search engine with their
36936
37076
  example:
36937
37077
  en */
36938
37078
  language_code?: string | undefined;
36939
- /** device type
36940
- optional field
36941
- possible value: desktop */
36942
- device?: string | undefined;
36943
- /** device operating system
36944
- optional field
36945
- possible values: windows */
36946
- os?: string | undefined;
36947
- /** time window for google_finance_quote graph
37079
+ /** device type
37080
+ optional field
37081
+ possible value: desktop */
37082
+ device?: string | undefined;
37083
+ /** device operating system
37084
+ optional field
37085
+ possible values: windows */
37086
+ os?: string | undefined;
37087
+ /** time window for google_finance_quote graph
37088
+ optional field
37089
+ possible values: 1D, 5D, 1M, 6M, YTD, 1Y, 5Y, MAX
37090
+ default value: 1D
37091
+ Note: if you specify a value that is different from 1D, the charge per task will be multiplied by 2 */
37092
+ window?: string | undefined;
37093
+ /** user-defined task identifier
37094
+ optional field
37095
+ the character limit is 255
37096
+ you can use this parameter to identify the task and match it with the result
37097
+ you will find the specified tag value in the data object of the response */
37098
+ tag?: string | undefined;
37099
+ [key: string]: any;
37100
+ }
37101
+ export declare class SerpGoogleFinanceQuoteLiveAdvancedResultInfo implements ISerpGoogleFinanceQuoteLiveAdvancedResultInfo {
37102
+ /** keyword received in a POST array
37103
+ the keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
37104
+ keyword?: string | undefined;
37105
+ /** type of element */
37106
+ type?: string | undefined;
37107
+ /** search engine domain in a POST array */
37108
+ se_domain?: string | undefined;
37109
+ /** location code in a POST array */
37110
+ location_code?: string | undefined;
37111
+ /** language code in a POST array */
37112
+ language_code?: string | undefined;
37113
+ /** direct URL to search engine results
37114
+ you can use it to make sure that we provided accurate results */
37115
+ check_url?: string | undefined;
37116
+ /** date and time when the result was received
37117
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
37118
+ example:
37119
+ 2019-11-15 12:57:46 +00:00 */
37120
+ datetime?: string | undefined;
37121
+ /** autocorrection of the search engine
37122
+ if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection */
37123
+ spell?: SpellInfo | undefined;
37124
+ /** search refinement chips
37125
+ in this case, the value will be null */
37126
+ refinement_chips?: RefinementChipsInfo | undefined;
37127
+ /** types of search results in SERP
37128
+ contains types of search results (items) found in SERP;
37129
+ possible item types: google_finance_hero_groups, google_finance_quote, google_finance_compare_to, google_finance_news, google_finance_financial, google_finance_futures_chain, google_finance_details, google_finance_about, google_finance_interested, google_finance_people_also_search */
37130
+ item_types?: (string | undefined)[] | undefined;
37131
+ /** total number of results in SERP */
37132
+ se_results_count?: number | undefined;
37133
+ /** the number of results returned in the items array */
37134
+ items_count?: number | undefined;
37135
+ /** market indexes related to the market trends element */
37136
+ items?: (BaseGoogleFinanceSerpElementItem | undefined)[] | undefined;
37137
+ [key: string]: any;
37138
+ constructor(data?: ISerpGoogleFinanceQuoteLiveAdvancedResultInfo);
37139
+ init(_data?: any): void;
37140
+ static fromJS(data: any): SerpGoogleFinanceQuoteLiveAdvancedResultInfo;
37141
+ toJSON(data?: any): any;
37142
+ }
37143
+ export interface ISerpGoogleFinanceQuoteLiveAdvancedResultInfo {
37144
+ /** keyword received in a POST array
37145
+ the keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
37146
+ keyword?: string | undefined;
37147
+ /** type of element */
37148
+ type?: string | undefined;
37149
+ /** search engine domain in a POST array */
37150
+ se_domain?: string | undefined;
37151
+ /** location code in a POST array */
37152
+ location_code?: string | undefined;
37153
+ /** language code in a POST array */
37154
+ language_code?: string | undefined;
37155
+ /** direct URL to search engine results
37156
+ you can use it to make sure that we provided accurate results */
37157
+ check_url?: string | undefined;
37158
+ /** date and time when the result was received
37159
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
37160
+ example:
37161
+ 2019-11-15 12:57:46 +00:00 */
37162
+ datetime?: string | undefined;
37163
+ /** autocorrection of the search engine
37164
+ if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection */
37165
+ spell?: SpellInfo | undefined;
37166
+ /** search refinement chips
37167
+ in this case, the value will be null */
37168
+ refinement_chips?: RefinementChipsInfo | undefined;
37169
+ /** types of search results in SERP
37170
+ contains types of search results (items) found in SERP;
37171
+ possible item types: google_finance_hero_groups, google_finance_quote, google_finance_compare_to, google_finance_news, google_finance_financial, google_finance_futures_chain, google_finance_details, google_finance_about, google_finance_interested, google_finance_people_also_search */
37172
+ item_types?: (string | undefined)[] | undefined;
37173
+ /** total number of results in SERP */
37174
+ se_results_count?: number | undefined;
37175
+ /** the number of results returned in the items array */
37176
+ items_count?: number | undefined;
37177
+ /** market indexes related to the market trends element */
37178
+ items?: (BaseGoogleFinanceSerpElementItem | undefined)[] | undefined;
37179
+ [key: string]: any;
37180
+ }
37181
+ export declare class SerpGoogleFinanceQuoteLiveAdvancedTaskInfo extends BaseResponseTaskInfo implements ISerpGoogleFinanceQuoteLiveAdvancedTaskInfo {
37182
+ /** array of results */
37183
+ result?: (SerpGoogleFinanceQuoteLiveAdvancedResultInfo | undefined)[] | undefined;
37184
+ [key: string]: any;
37185
+ constructor(data?: ISerpGoogleFinanceQuoteLiveAdvancedTaskInfo);
37186
+ init(_data?: any): void;
37187
+ static fromJS(data: any): SerpGoogleFinanceQuoteLiveAdvancedTaskInfo;
37188
+ toJSON(data?: any): any;
37189
+ }
37190
+ export interface ISerpGoogleFinanceQuoteLiveAdvancedTaskInfo extends IBaseResponseTaskInfo {
37191
+ /** array of results */
37192
+ result?: (SerpGoogleFinanceQuoteLiveAdvancedResultInfo | undefined)[] | undefined;
37193
+ [key: string]: any;
37194
+ }
37195
+ export declare class SerpGoogleFinanceQuoteLiveAdvancedResponseInfo extends BaseResponseInfo implements ISerpGoogleFinanceQuoteLiveAdvancedResponseInfo {
37196
+ /** array of tasks */
37197
+ tasks?: (SerpGoogleFinanceQuoteLiveAdvancedTaskInfo | undefined)[] | undefined;
37198
+ [key: string]: any;
37199
+ constructor(data?: ISerpGoogleFinanceQuoteLiveAdvancedResponseInfo);
37200
+ init(_data?: any): void;
37201
+ static fromJS(data: any): SerpGoogleFinanceQuoteLiveAdvancedResponseInfo;
37202
+ toJSON(data?: any): any;
37203
+ }
37204
+ export interface ISerpGoogleFinanceQuoteLiveAdvancedResponseInfo extends IBaseResponseInfo {
37205
+ /** array of tasks */
37206
+ tasks?: (SerpGoogleFinanceQuoteLiveAdvancedTaskInfo | undefined)[] | undefined;
37207
+ [key: string]: any;
37208
+ }
37209
+ export declare class SerpGoogleFinanceQuoteLiveHtmlRequestInfo implements ISerpGoogleFinanceQuoteLiveHtmlRequestInfo {
37210
+ /** ticker or stock symbol
37211
+ required field
37212
+ in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange;
37213
+ you can specify up to 700 characters in the keyword field;
37214
+ all %## will be decoded (plus character ‘+’ will be decoded to a space character)
37215
+ if you need to use the “%” character for your keyword, please specify it as “%25”;
37216
+ if you need to use the “+” character for your keyword, please specify it as “%2B”;
37217
+ learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
37218
+ keyword?: string;
37219
+ /** full name of search engine location
37220
+ required field if you don’t specify location_code
37221
+ if you use this field, you don’t need to specify location_code
37222
+ you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/serp/google/locations
37223
+ example:
37224
+ London,England,United Kingdom */
37225
+ location_name?: string | undefined;
37226
+ /** search engine location code
37227
+ required field if you don’t specify location_name
37228
+ if you use this field, you don’t need to specify location_name
37229
+ you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/serp/google/locations
37230
+ example:
37231
+ 2840 */
37232
+ location_code?: number | undefined;
37233
+ /** full name of search engine language
37234
+ required field if you don’t specify language_code
37235
+ if you use this field, you don’t need to specify language_code
37236
+ you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages
37237
+ example:
37238
+ English */
37239
+ language_name?: string | undefined;
37240
+ /** search engine language code
37241
+ required field if you don’t specify language_name
37242
+ if you use this field, you don’t need to specify language_name
37243
+ you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages
37244
+ example:
37245
+ en */
37246
+ language_code?: string | undefined;
37247
+ /** device type
37248
+ optional field
37249
+ possible value: desktop */
37250
+ device?: string | undefined;
37251
+ /** device operating system
37252
+ optional field
37253
+ possible values: windows */
37254
+ os?: string | undefined;
37255
+ /** time window for google_finance_quote graph
37256
+ optional field
37257
+ possible values: 1D, 5D, 1M, 6M, YTD, 1Y, 5Y, MAX
37258
+ default value: 1D */
37259
+ window?: string | undefined;
37260
+ /** user-defined task identifier
37261
+ optional field
37262
+ the character limit is 255
37263
+ you can use this parameter to identify the task and match it with the result
37264
+ you will find the specified tag value in the data object of the response */
37265
+ tag?: string | undefined;
37266
+ [key: string]: any;
37267
+ constructor(data?: ISerpGoogleFinanceQuoteLiveHtmlRequestInfo);
37268
+ init(_data?: any): void;
37269
+ static fromJS(data: any): SerpGoogleFinanceQuoteLiveHtmlRequestInfo;
37270
+ toJSON(data?: any): any;
37271
+ }
37272
+ export interface ISerpGoogleFinanceQuoteLiveHtmlRequestInfo {
37273
+ /** ticker or stock symbol
37274
+ required field
37275
+ in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange;
37276
+ you can specify up to 700 characters in the keyword field;
37277
+ all %## will be decoded (plus character ‘+’ will be decoded to a space character)
37278
+ if you need to use the “%” character for your keyword, please specify it as “%25”;
37279
+ if you need to use the “+” character for your keyword, please specify it as “%2B”;
37280
+ learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
37281
+ keyword?: string;
37282
+ /** full name of search engine location
37283
+ required field if you don’t specify location_code
37284
+ if you use this field, you don’t need to specify location_code
37285
+ you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/serp/google/locations
37286
+ example:
37287
+ London,England,United Kingdom */
37288
+ location_name?: string | undefined;
37289
+ /** search engine location code
37290
+ required field if you don’t specify location_name
37291
+ if you use this field, you don’t need to specify location_name
37292
+ you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/serp/google/locations
37293
+ example:
37294
+ 2840 */
37295
+ location_code?: number | undefined;
37296
+ /** full name of search engine language
37297
+ required field if you don’t specify language_code
37298
+ if you use this field, you don’t need to specify language_code
37299
+ you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages
37300
+ example:
37301
+ English */
37302
+ language_name?: string | undefined;
37303
+ /** search engine language code
37304
+ required field if you don’t specify language_name
37305
+ if you use this field, you don’t need to specify language_name
37306
+ you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages
37307
+ example:
37308
+ en */
37309
+ language_code?: string | undefined;
37310
+ /** device type
37311
+ optional field
37312
+ possible value: desktop */
37313
+ device?: string | undefined;
37314
+ /** device operating system
37315
+ optional field
37316
+ possible values: windows */
37317
+ os?: string | undefined;
37318
+ /** time window for google_finance_quote graph
37319
+ optional field
37320
+ possible values: 1D, 5D, 1M, 6M, YTD, 1Y, 5Y, MAX
37321
+ default value: 1D */
37322
+ window?: string | undefined;
37323
+ /** user-defined task identifier
37324
+ optional field
37325
+ the character limit is 255
37326
+ you can use this parameter to identify the task and match it with the result
37327
+ you will find the specified tag value in the data object of the response */
37328
+ tag?: string | undefined;
37329
+ [key: string]: any;
37330
+ }
37331
+ export declare class SerpGoogleFinanceQuoteLiveHtmlResultInfo implements ISerpGoogleFinanceQuoteLiveHtmlResultInfo {
37332
+ /** keyword received in a POST array
37333
+ keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
37334
+ keyword?: string | undefined;
37335
+ /** type of element */
37336
+ type?: string | undefined;
37337
+ /** search engine domain in a POST array */
37338
+ se_domain?: string | undefined;
37339
+ /** location code in a POST array */
37340
+ location_code?: number | undefined;
37341
+ /** language code in a POST array */
37342
+ language_code?: string | undefined;
37343
+ /** date and time when the result was received
37344
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
37345
+ example:
37346
+ 2019-11-15 12:57:46 +00:00 */
37347
+ datetime?: string | undefined;
37348
+ /** the number of results returned in the items array */
37349
+ items_count?: number | undefined;
37350
+ /** elements of search results found in SERP */
37351
+ items?: (HtmlItem | undefined)[] | undefined;
37352
+ [key: string]: any;
37353
+ constructor(data?: ISerpGoogleFinanceQuoteLiveHtmlResultInfo);
37354
+ init(_data?: any): void;
37355
+ static fromJS(data: any): SerpGoogleFinanceQuoteLiveHtmlResultInfo;
37356
+ toJSON(data?: any): any;
37357
+ }
37358
+ export interface ISerpGoogleFinanceQuoteLiveHtmlResultInfo {
37359
+ /** keyword received in a POST array
37360
+ keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
37361
+ keyword?: string | undefined;
37362
+ /** type of element */
37363
+ type?: string | undefined;
37364
+ /** search engine domain in a POST array */
37365
+ se_domain?: string | undefined;
37366
+ /** location code in a POST array */
37367
+ location_code?: number | undefined;
37368
+ /** language code in a POST array */
37369
+ language_code?: string | undefined;
37370
+ /** date and time when the result was received
37371
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
37372
+ example:
37373
+ 2019-11-15 12:57:46 +00:00 */
37374
+ datetime?: string | undefined;
37375
+ /** the number of results returned in the items array */
37376
+ items_count?: number | undefined;
37377
+ /** elements of search results found in SERP */
37378
+ items?: (HtmlItem | undefined)[] | undefined;
37379
+ [key: string]: any;
37380
+ }
37381
+ export declare class SerpGoogleFinanceQuoteLiveHtmlTaskInfo extends BaseResponseTaskInfo implements ISerpGoogleFinanceQuoteLiveHtmlTaskInfo {
37382
+ /** array of results */
37383
+ result?: (SerpGoogleFinanceQuoteLiveHtmlResultInfo | undefined)[] | undefined;
37384
+ [key: string]: any;
37385
+ constructor(data?: ISerpGoogleFinanceQuoteLiveHtmlTaskInfo);
37386
+ init(_data?: any): void;
37387
+ static fromJS(data: any): SerpGoogleFinanceQuoteLiveHtmlTaskInfo;
37388
+ toJSON(data?: any): any;
37389
+ }
37390
+ export interface ISerpGoogleFinanceQuoteLiveHtmlTaskInfo extends IBaseResponseTaskInfo {
37391
+ /** array of results */
37392
+ result?: (SerpGoogleFinanceQuoteLiveHtmlResultInfo | undefined)[] | undefined;
37393
+ [key: string]: any;
37394
+ }
37395
+ export declare class SerpGoogleFinanceQuoteLiveHtmlResponseInfo extends BaseResponseInfo implements ISerpGoogleFinanceQuoteLiveHtmlResponseInfo {
37396
+ /** array of tasks */
37397
+ tasks?: (SerpGoogleFinanceQuoteLiveHtmlTaskInfo | undefined)[] | undefined;
37398
+ [key: string]: any;
37399
+ constructor(data?: ISerpGoogleFinanceQuoteLiveHtmlResponseInfo);
37400
+ init(_data?: any): void;
37401
+ static fromJS(data: any): SerpGoogleFinanceQuoteLiveHtmlResponseInfo;
37402
+ toJSON(data?: any): any;
37403
+ }
37404
+ export interface ISerpGoogleFinanceQuoteLiveHtmlResponseInfo extends IBaseResponseInfo {
37405
+ /** array of tasks */
37406
+ tasks?: (SerpGoogleFinanceQuoteLiveHtmlTaskInfo | undefined)[] | undefined;
37407
+ [key: string]: any;
37408
+ }
37409
+ export declare class SerpGoogleFinanceTickerSearchTaskPostRequestInfo implements ISerpGoogleFinanceTickerSearchTaskPostRequestInfo {
37410
+ /** company or financial instrument name
37411
+ required field
37412
+ in this field, you can enter the name of a company or financial instrument to search for relevant tickers;
37413
+ you can specify up to 700 characters in the keyword field;
37414
+ all %## will be decoded (plus character ‘+’ will be decoded to a space character)
37415
+ if you need to use the “%” character for your keyword, please specify it as “%25”;
37416
+ if you need to use the “+” character for your keyword, please specify it as “%2B”;
37417
+ learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
37418
+ keyword?: string;
37419
+ /** full name of search engine location
37420
+ required field if you don’t specify location_code
37421
+ if you use this field, you don’t need to specify location_code
37422
+ you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/serp/google/locations
37423
+ example:
37424
+ London,England,United Kingdom */
37425
+ location_name?: string | undefined;
37426
+ /** search engine location code
37427
+ required field if you don’t specify location_name
37428
+ if you use this field, you don’t need to specify location_name
37429
+ you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/serp/google/locations
37430
+ example:
37431
+ 2840 */
37432
+ location_code?: number | undefined;
37433
+ /** full name of search engine language
37434
+ required field if you don’t specify language_code
37435
+ if you use this field, you don’t need to specify language_code
37436
+ you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages
37437
+ example:
37438
+ English */
37439
+ language_name?: string | undefined;
37440
+ /** search engine language code
37441
+ required field if you don’t specify language_name
37442
+ if you use this field, you don’t need to specify language_name
37443
+ you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages
37444
+ example:
37445
+ en */
37446
+ language_code?: string | undefined;
37447
+ /** task priority
37448
+ optional field
37449
+ can take the following values:
37450
+ 1 – normal execution priority (set by default);
37451
+ 2 – high execution priority
37452
+ You will be additionally charged for the tasks with high execution priority;
37453
+ The cost can be calculated on the Pricing page */
37454
+ priority?: number | undefined;
37455
+ /** category of financial instruments to search for
37456
+ optional field
37457
+ possible values: all, stock, index, mutual_fund, currency, futures
37458
+ default value: all */
37459
+ category?: string | undefined;
37460
+ /** user-defined task identifier
37461
+ optional field
37462
+ the character limit is 255
37463
+ you can use this parameter to identify the task and match it with the result
37464
+ you will find the specified tag value in the data object of the response */
37465
+ tag?: string | undefined;
37466
+ /** return URL for sending task results
37467
+ optional field
37468
+ once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
37469
+ you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request
37470
+ example:
37471
+ http://your-server.com/postbackscript?id=$id
37472
+ http://your-server.com/postbackscript?id=$id&tag=$tag
37473
+ Note: special characters in postback_url will be urlencoded;
37474
+ i.a., the # character will be encoded into %23
37475
+ learn more on our Help Center */
37476
+ postback_url?: string | undefined;
37477
+ /** postback_url datatype
37478
+ required field if you specify postback_url
37479
+ corresponds to the datatype that will be sent to your server
37480
+ possible values:: advanced, html */
37481
+ postback_data?: string | undefined;
37482
+ /** notification URL of a completed task
37483
+ optional field
37484
+ when a task is completed we will notify you by GET request sent to the URL you have specified
37485
+ you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
37486
+ example:
37487
+ http://your-server.com/pingscript?id=$id
37488
+ http://your-server.com/pingscript?id=$id&tag=$tag
37489
+ Note: special characters in pingback_url will be urlencoded;
37490
+ i.a., the # character will be encoded into %23
37491
+ learn more on our Help Center */
37492
+ pingback_url?: string | undefined;
37493
+ [key: string]: any;
37494
+ constructor(data?: ISerpGoogleFinanceTickerSearchTaskPostRequestInfo);
37495
+ init(_data?: any): void;
37496
+ static fromJS(data: any): SerpGoogleFinanceTickerSearchTaskPostRequestInfo;
37497
+ toJSON(data?: any): any;
37498
+ }
37499
+ export interface ISerpGoogleFinanceTickerSearchTaskPostRequestInfo {
37500
+ /** company or financial instrument name
37501
+ required field
37502
+ in this field, you can enter the name of a company or financial instrument to search for relevant tickers;
37503
+ you can specify up to 700 characters in the keyword field;
37504
+ all %## will be decoded (plus character ‘+’ will be decoded to a space character)
37505
+ if you need to use the “%” character for your keyword, please specify it as “%25”;
37506
+ if you need to use the “+” character for your keyword, please specify it as “%2B”;
37507
+ learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
37508
+ keyword?: string;
37509
+ /** full name of search engine location
37510
+ required field if you don’t specify location_code
37511
+ if you use this field, you don’t need to specify location_code
37512
+ you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/serp/google/locations
37513
+ example:
37514
+ London,England,United Kingdom */
37515
+ location_name?: string | undefined;
37516
+ /** search engine location code
37517
+ required field if you don’t specify location_name
37518
+ if you use this field, you don’t need to specify location_name
37519
+ you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/serp/google/locations
37520
+ example:
37521
+ 2840 */
37522
+ location_code?: number | undefined;
37523
+ /** full name of search engine language
37524
+ required field if you don’t specify language_code
37525
+ if you use this field, you don’t need to specify language_code
37526
+ you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages
37527
+ example:
37528
+ English */
37529
+ language_name?: string | undefined;
37530
+ /** search engine language code
37531
+ required field if you don’t specify language_name
37532
+ if you use this field, you don’t need to specify language_name
37533
+ you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages
37534
+ example:
37535
+ en */
37536
+ language_code?: string | undefined;
37537
+ /** task priority
37538
+ optional field
37539
+ can take the following values:
37540
+ 1 – normal execution priority (set by default);
37541
+ 2 – high execution priority
37542
+ You will be additionally charged for the tasks with high execution priority;
37543
+ The cost can be calculated on the Pricing page */
37544
+ priority?: number | undefined;
37545
+ /** category of financial instruments to search for
37546
+ optional field
37547
+ possible values: all, stock, index, mutual_fund, currency, futures
37548
+ default value: all */
37549
+ category?: string | undefined;
37550
+ /** user-defined task identifier
37551
+ optional field
37552
+ the character limit is 255
37553
+ you can use this parameter to identify the task and match it with the result
37554
+ you will find the specified tag value in the data object of the response */
37555
+ tag?: string | undefined;
37556
+ /** return URL for sending task results
37557
+ optional field
37558
+ once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified
37559
+ you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request
37560
+ example:
37561
+ http://your-server.com/postbackscript?id=$id
37562
+ http://your-server.com/postbackscript?id=$id&tag=$tag
37563
+ Note: special characters in postback_url will be urlencoded;
37564
+ i.a., the # character will be encoded into %23
37565
+ learn more on our Help Center */
37566
+ postback_url?: string | undefined;
37567
+ /** postback_url datatype
37568
+ required field if you specify postback_url
37569
+ corresponds to the datatype that will be sent to your server
37570
+ possible values:: advanced, html */
37571
+ postback_data?: string | undefined;
37572
+ /** notification URL of a completed task
37573
+ optional field
37574
+ when a task is completed we will notify you by GET request sent to the URL you have specified
37575
+ you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request.
37576
+ example:
37577
+ http://your-server.com/pingscript?id=$id
37578
+ http://your-server.com/pingscript?id=$id&tag=$tag
37579
+ Note: special characters in pingback_url will be urlencoded;
37580
+ i.a., the # character will be encoded into %23
37581
+ learn more on our Help Center */
37582
+ pingback_url?: string | undefined;
37583
+ [key: string]: any;
37584
+ }
37585
+ export declare class SerpGoogleFinanceTickerSearchTaskPostTaskInfo extends BaseResponseTaskInfo implements ISerpGoogleFinanceTickerSearchTaskPostTaskInfo {
37586
+ /** array of results
37587
+ in this case, the value will be null */
37588
+ result?: any | undefined;
37589
+ [key: string]: any;
37590
+ constructor(data?: ISerpGoogleFinanceTickerSearchTaskPostTaskInfo);
37591
+ init(_data?: any): void;
37592
+ static fromJS(data: any): SerpGoogleFinanceTickerSearchTaskPostTaskInfo;
37593
+ toJSON(data?: any): any;
37594
+ }
37595
+ export interface ISerpGoogleFinanceTickerSearchTaskPostTaskInfo extends IBaseResponseTaskInfo {
37596
+ /** array of results
37597
+ in this case, the value will be null */
37598
+ result?: any | undefined;
37599
+ [key: string]: any;
37600
+ }
37601
+ export declare class SerpGoogleFinanceTickerSearchTaskPostResponseInfo extends BaseResponseInfo implements ISerpGoogleFinanceTickerSearchTaskPostResponseInfo {
37602
+ /** array of tasks */
37603
+ tasks?: (SerpGoogleFinanceTickerSearchTaskPostTaskInfo | undefined)[] | undefined;
37604
+ [key: string]: any;
37605
+ constructor(data?: ISerpGoogleFinanceTickerSearchTaskPostResponseInfo);
37606
+ init(_data?: any): void;
37607
+ static fromJS(data: any): SerpGoogleFinanceTickerSearchTaskPostResponseInfo;
37608
+ toJSON(data?: any): any;
37609
+ }
37610
+ export interface ISerpGoogleFinanceTickerSearchTaskPostResponseInfo extends IBaseResponseInfo {
37611
+ /** array of tasks */
37612
+ tasks?: (SerpGoogleFinanceTickerSearchTaskPostTaskInfo | undefined)[] | undefined;
37613
+ [key: string]: any;
37614
+ }
37615
+ export declare class SerpGoogleFinanceTickerSearchTasksReadyResultInfo implements ISerpGoogleFinanceTickerSearchTasksReadyResultInfo {
37616
+ /** task identifier of the completed task
37617
+ unique task identifier in our system in the UUID format */
37618
+ id?: string | undefined;
37619
+ /** search engine specified when setting the task */
37620
+ se?: string | undefined;
37621
+ /** type of search engine
37622
+ example: finance_ticker_search */
37623
+ se_type?: string | undefined;
37624
+ /** date when the task was posted (in the UTC format) */
37625
+ date_posted?: string | undefined;
37626
+ /** user-defined task identifier */
37627
+ tag?: string | undefined;
37628
+ /** URL for collecting the results of the SERP Regular task
37629
+ if SERP Regular is not supported in the specified endpoint, the value will be null */
37630
+ endpoint_regular?: string | undefined;
37631
+ /** URL for collecting the results of the SERP Advanced task
37632
+ if SERP Advanced is not supported in the specified endpoint, the value will be null */
37633
+ endpoint_advanced?: string | undefined;
37634
+ /** URL for collecting the results of the SERP HTML task
37635
+ if SERP HTML is not supported in the specified endpoint, the value will be null */
37636
+ endpoint_html?: string | undefined;
37637
+ [key: string]: any;
37638
+ constructor(data?: ISerpGoogleFinanceTickerSearchTasksReadyResultInfo);
37639
+ init(_data?: any): void;
37640
+ static fromJS(data: any): SerpGoogleFinanceTickerSearchTasksReadyResultInfo;
37641
+ toJSON(data?: any): any;
37642
+ }
37643
+ export interface ISerpGoogleFinanceTickerSearchTasksReadyResultInfo {
37644
+ /** task identifier of the completed task
37645
+ unique task identifier in our system in the UUID format */
37646
+ id?: string | undefined;
37647
+ /** search engine specified when setting the task */
37648
+ se?: string | undefined;
37649
+ /** type of search engine
37650
+ example: finance_ticker_search */
37651
+ se_type?: string | undefined;
37652
+ /** date when the task was posted (in the UTC format) */
37653
+ date_posted?: string | undefined;
37654
+ /** user-defined task identifier */
37655
+ tag?: string | undefined;
37656
+ /** URL for collecting the results of the SERP Regular task
37657
+ if SERP Regular is not supported in the specified endpoint, the value will be null */
37658
+ endpoint_regular?: string | undefined;
37659
+ /** URL for collecting the results of the SERP Advanced task
37660
+ if SERP Advanced is not supported in the specified endpoint, the value will be null */
37661
+ endpoint_advanced?: string | undefined;
37662
+ /** URL for collecting the results of the SERP HTML task
37663
+ if SERP HTML is not supported in the specified endpoint, the value will be null */
37664
+ endpoint_html?: string | undefined;
37665
+ [key: string]: any;
37666
+ }
37667
+ export declare class SerpGoogleFinanceTickerSearchTasksReadyTaskInfo extends BaseResponseTaskInfo implements ISerpGoogleFinanceTickerSearchTasksReadyTaskInfo {
37668
+ /** array of results */
37669
+ result?: (SerpGoogleFinanceTickerSearchTasksReadyResultInfo | undefined)[] | undefined;
37670
+ [key: string]: any;
37671
+ constructor(data?: ISerpGoogleFinanceTickerSearchTasksReadyTaskInfo);
37672
+ init(_data?: any): void;
37673
+ static fromJS(data: any): SerpGoogleFinanceTickerSearchTasksReadyTaskInfo;
37674
+ toJSON(data?: any): any;
37675
+ }
37676
+ export interface ISerpGoogleFinanceTickerSearchTasksReadyTaskInfo extends IBaseResponseTaskInfo {
37677
+ /** array of results */
37678
+ result?: (SerpGoogleFinanceTickerSearchTasksReadyResultInfo | undefined)[] | undefined;
37679
+ [key: string]: any;
37680
+ }
37681
+ export declare class SerpGoogleFinanceTickerSearchTasksReadyResponseInfo extends BaseResponseInfo implements ISerpGoogleFinanceTickerSearchTasksReadyResponseInfo {
37682
+ /** array of tasks */
37683
+ tasks?: (SerpGoogleFinanceTickerSearchTasksReadyTaskInfo | undefined)[] | undefined;
37684
+ [key: string]: any;
37685
+ constructor(data?: ISerpGoogleFinanceTickerSearchTasksReadyResponseInfo);
37686
+ init(_data?: any): void;
37687
+ static fromJS(data: any): SerpGoogleFinanceTickerSearchTasksReadyResponseInfo;
37688
+ toJSON(data?: any): any;
37689
+ }
37690
+ export interface ISerpGoogleFinanceTickerSearchTasksReadyResponseInfo extends IBaseResponseInfo {
37691
+ /** array of tasks */
37692
+ tasks?: (SerpGoogleFinanceTickerSearchTasksReadyTaskInfo | undefined)[] | undefined;
37693
+ [key: string]: any;
37694
+ }
37695
+ export declare class GoogleFinanceAssetPairSerpElementItem extends BaseGoogleFinanceTickerSearchSerpElementItem implements IGoogleFinanceAssetPairSerpElementItem {
37696
+ /** identifier of the base asset in a pair
37697
+ example: EUR */
37698
+ base_symbol?: string | undefined;
37699
+ /** identifier of the quote asset in a pair
37700
+ example: USD */
37701
+ quote_symbol?: string | undefined;
37702
+ /** full name of the base asset in a pair
37703
+ example: Euro */
37704
+ base_display_name?: string | undefined;
37705
+ /** full name of the base asset in a pair
37706
+ example: Euro */
37707
+ quote_display_name?: string | undefined;
37708
+ /** value of the base asset compared to the quote asset */
37709
+ price?: number | undefined;
37710
+ /** change in price
37711
+ change in price at a given timestamp */
37712
+ price_delta?: number | undefined;
37713
+ [key: string]: any;
37714
+ constructor(data?: IGoogleFinanceAssetPairSerpElementItem);
37715
+ init(_data?: any): void;
37716
+ static fromJS(data: any): GoogleFinanceAssetPairSerpElementItem;
37717
+ toJSON(data?: any): any;
37718
+ }
37719
+ export interface IGoogleFinanceAssetPairSerpElementItem extends IBaseGoogleFinanceTickerSearchSerpElementItem {
37720
+ /** identifier of the base asset in a pair
37721
+ example: EUR */
37722
+ base_symbol?: string | undefined;
37723
+ /** identifier of the quote asset in a pair
37724
+ example: USD */
37725
+ quote_symbol?: string | undefined;
37726
+ /** full name of the base asset in a pair
37727
+ example: Euro */
37728
+ base_display_name?: string | undefined;
37729
+ /** full name of the base asset in a pair
37730
+ example: Euro */
37731
+ quote_display_name?: string | undefined;
37732
+ /** value of the base asset compared to the quote asset */
37733
+ price?: number | undefined;
37734
+ /** change in price
37735
+ change in price at a given timestamp */
37736
+ price_delta?: number | undefined;
37737
+ [key: string]: any;
37738
+ }
37739
+ export declare class GoogleFinanceMarketInstrumentSerpElementItem extends BaseGoogleFinanceTickerSearchSerpElementItem implements IGoogleFinanceMarketInstrumentSerpElementItem {
37740
+ /** ticker of the market index
37741
+ example: DAX */
37742
+ ticker?: string | undefined;
37743
+ /** value of the base asset compared to the quote asset */
37744
+ price?: number | undefined;
37745
+ /** change in price
37746
+ change in price at a given timestamp */
37747
+ price_delta?: number | undefined;
37748
+ /** price currency
37749
+ example: USD */
37750
+ price_currency?: string | undefined;
37751
+ [key: string]: any;
37752
+ constructor(data?: IGoogleFinanceMarketInstrumentSerpElementItem);
37753
+ init(_data?: any): void;
37754
+ static fromJS(data: any): GoogleFinanceMarketInstrumentSerpElementItem;
37755
+ toJSON(data?: any): any;
37756
+ }
37757
+ export interface IGoogleFinanceMarketInstrumentSerpElementItem extends IBaseGoogleFinanceTickerSearchSerpElementItem {
37758
+ /** ticker of the market index
37759
+ example: DAX */
37760
+ ticker?: string | undefined;
37761
+ /** value of the base asset compared to the quote asset */
37762
+ price?: number | undefined;
37763
+ /** change in price
37764
+ change in price at a given timestamp */
37765
+ price_delta?: number | undefined;
37766
+ /** price currency
37767
+ example: USD */
37768
+ price_currency?: string | undefined;
37769
+ [key: string]: any;
37770
+ }
37771
+ export declare class GoogleFinanceMarketIndexSerpElementItem extends BaseGoogleFinanceTickerSearchSerpElementItem implements IGoogleFinanceMarketIndexSerpElementItem {
37772
+ /** ticker of the market index
37773
+ example: DAX */
37774
+ ticker?: string | undefined;
37775
+ /** market identifier
37776
+ example: INDEXDB */
37777
+ market_identifier?: string | undefined;
37778
+ /** value of the market index
37779
+ numerical value of the index at a given timestamp */
37780
+ index_value?: number | undefined;
37781
+ /** change in value of the market index
37782
+ change in the index_value at a given timestamp */
37783
+ index_value_delta?: number | undefined;
37784
+ [key: string]: any;
37785
+ constructor(data?: IGoogleFinanceMarketIndexSerpElementItem);
37786
+ init(_data?: any): void;
37787
+ static fromJS(data: any): GoogleFinanceMarketIndexSerpElementItem;
37788
+ toJSON(data?: any): any;
37789
+ }
37790
+ export interface IGoogleFinanceMarketIndexSerpElementItem extends IBaseGoogleFinanceTickerSearchSerpElementItem {
37791
+ /** ticker of the market index
37792
+ example: DAX */
37793
+ ticker?: string | undefined;
37794
+ /** market identifier
37795
+ example: INDEXDB */
37796
+ market_identifier?: string | undefined;
37797
+ /** value of the market index
37798
+ numerical value of the index at a given timestamp */
37799
+ index_value?: number | undefined;
37800
+ /** change in value of the market index
37801
+ change in the index_value at a given timestamp */
37802
+ index_value_delta?: number | undefined;
37803
+ [key: string]: any;
37804
+ }
37805
+ export declare class SerpGoogleFinanceTickerSearchTaskGetAdvancedResultInfo implements ISerpGoogleFinanceTickerSearchTaskGetAdvancedResultInfo {
37806
+ /** keyword received in a POST array
37807
+ the keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
37808
+ keyword?: string | undefined;
37809
+ /** type of element */
37810
+ type?: string | undefined;
37811
+ /** search engine domain in a POST array */
37812
+ se_domain?: string | undefined;
37813
+ /** location code in a POST array */
37814
+ location_code?: string | undefined;
37815
+ /** language code in a POST array */
37816
+ language_code?: string | undefined;
37817
+ /** direct URL to search engine results
37818
+ you can use it to make sure that we provided accurate results */
37819
+ check_url?: string | undefined;
37820
+ /** date and time when the result was received
37821
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
37822
+ example:
37823
+ 2019-11-15 12:57:46 +00:00 */
37824
+ datetime?: string | undefined;
37825
+ /** autocorrection of the search engine
37826
+ if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection */
37827
+ spell?: SpellInfo | undefined;
37828
+ /** search refinement chips
37829
+ in this case, the value will be null */
37830
+ refinement_chips?: RefinementChipsInfo | undefined;
37831
+ /** types of search results in SERP
37832
+ contains types of search results (items) found in SERP;
37833
+ possible item types: google_finance_market_index, google_finance_asset_pair, google_finance_market_instrument */
37834
+ item_types?: (string | undefined)[] | undefined;
37835
+ /** total number of results in SERP */
37836
+ se_results_count?: number | undefined;
37837
+ /** the number of results returned in the items array */
37838
+ items_count?: number | undefined;
37839
+ /** items of search results found in SERP
37840
+ array of items containing market indexes data;
37841
+ possible type of items: google_finance_market_index, google_finance_asset_pair, google_finance_market_instrument */
37842
+ items?: (BaseGoogleFinanceTickerSearchSerpElementItem | undefined)[] | undefined;
37843
+ [key: string]: any;
37844
+ constructor(data?: ISerpGoogleFinanceTickerSearchTaskGetAdvancedResultInfo);
37845
+ init(_data?: any): void;
37846
+ static fromJS(data: any): SerpGoogleFinanceTickerSearchTaskGetAdvancedResultInfo;
37847
+ toJSON(data?: any): any;
37848
+ }
37849
+ export interface ISerpGoogleFinanceTickerSearchTaskGetAdvancedResultInfo {
37850
+ /** keyword received in a POST array
37851
+ the keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
37852
+ keyword?: string | undefined;
37853
+ /** type of element */
37854
+ type?: string | undefined;
37855
+ /** search engine domain in a POST array */
37856
+ se_domain?: string | undefined;
37857
+ /** location code in a POST array */
37858
+ location_code?: string | undefined;
37859
+ /** language code in a POST array */
37860
+ language_code?: string | undefined;
37861
+ /** direct URL to search engine results
37862
+ you can use it to make sure that we provided accurate results */
37863
+ check_url?: string | undefined;
37864
+ /** date and time when the result was received
37865
+ in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
37866
+ example:
37867
+ 2019-11-15 12:57:46 +00:00 */
37868
+ datetime?: string | undefined;
37869
+ /** autocorrection of the search engine
37870
+ if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection */
37871
+ spell?: SpellInfo | undefined;
37872
+ /** search refinement chips
37873
+ in this case, the value will be null */
37874
+ refinement_chips?: RefinementChipsInfo | undefined;
37875
+ /** types of search results in SERP
37876
+ contains types of search results (items) found in SERP;
37877
+ possible item types: google_finance_market_index, google_finance_asset_pair, google_finance_market_instrument */
37878
+ item_types?: (string | undefined)[] | undefined;
37879
+ /** total number of results in SERP */
37880
+ se_results_count?: number | undefined;
37881
+ /** the number of results returned in the items array */
37882
+ items_count?: number | undefined;
37883
+ /** items of search results found in SERP
37884
+ array of items containing market indexes data;
37885
+ possible type of items: google_finance_market_index, google_finance_asset_pair, google_finance_market_instrument */
37886
+ items?: (BaseGoogleFinanceTickerSearchSerpElementItem | undefined)[] | undefined;
37887
+ [key: string]: any;
37888
+ }
37889
+ export declare class SerpGoogleFinanceTickerSearchTaskGetAdvancedTaskInfo extends BaseResponseTaskInfo implements ISerpGoogleFinanceTickerSearchTaskGetAdvancedTaskInfo {
37890
+ /** array of results */
37891
+ result?: (SerpGoogleFinanceTickerSearchTaskGetAdvancedResultInfo | undefined)[] | undefined;
37892
+ [key: string]: any;
37893
+ constructor(data?: ISerpGoogleFinanceTickerSearchTaskGetAdvancedTaskInfo);
37894
+ init(_data?: any): void;
37895
+ static fromJS(data: any): SerpGoogleFinanceTickerSearchTaskGetAdvancedTaskInfo;
37896
+ toJSON(data?: any): any;
37897
+ }
37898
+ export interface ISerpGoogleFinanceTickerSearchTaskGetAdvancedTaskInfo extends IBaseResponseTaskInfo {
37899
+ /** array of results */
37900
+ result?: (SerpGoogleFinanceTickerSearchTaskGetAdvancedResultInfo | undefined)[] | undefined;
37901
+ [key: string]: any;
37902
+ }
37903
+ export declare class SerpGoogleFinanceTickerSearchTaskGetAdvancedResponseInfo extends BaseResponseInfo implements ISerpGoogleFinanceTickerSearchTaskGetAdvancedResponseInfo {
37904
+ /** array of tasks */
37905
+ tasks?: (SerpGoogleFinanceTickerSearchTaskGetAdvancedTaskInfo | undefined)[] | undefined;
37906
+ [key: string]: any;
37907
+ constructor(data?: ISerpGoogleFinanceTickerSearchTaskGetAdvancedResponseInfo);
37908
+ init(_data?: any): void;
37909
+ static fromJS(data: any): SerpGoogleFinanceTickerSearchTaskGetAdvancedResponseInfo;
37910
+ toJSON(data?: any): any;
37911
+ }
37912
+ export interface ISerpGoogleFinanceTickerSearchTaskGetAdvancedResponseInfo extends IBaseResponseInfo {
37913
+ /** array of tasks */
37914
+ tasks?: (SerpGoogleFinanceTickerSearchTaskGetAdvancedTaskInfo | undefined)[] | undefined;
37915
+ [key: string]: any;
37916
+ }
37917
+ export declare class SerpGoogleFinanceTickerSearchLiveAdvancedRequestInfo implements ISerpGoogleFinanceTickerSearchLiveAdvancedRequestInfo {
37918
+ /** company or financial instrument name
37919
+ required field
37920
+ in this field, you can enter the name of a company or financial instrument to search for relevant tickers;
37921
+ you can specify up to 700 characters in the keyword field;
37922
+ all %## will be decoded (plus character ‘+’ will be decoded to a space character)
37923
+ if you need to use the “%” character for your keyword, please specify it as “%25”;
37924
+ if you need to use the “+” character for your keyword, please specify it as “%2B”;
37925
+ learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
37926
+ keyword?: string;
37927
+ /** full name of search engine location
37928
+ required field if you don’t specify location_code
37929
+ if you use this field, you don’t need to specify location_code
37930
+ you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/serp/google/locations
37931
+ example:
37932
+ London,England,United Kingdom */
37933
+ location_name?: string | undefined;
37934
+ /** search engine location code
37935
+ required field if you don’t specify location_name
37936
+ if you use this field, you don’t need to specify location_name
37937
+ you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/serp/google/locations
37938
+ example:
37939
+ 2840 */
37940
+ location_code?: number | undefined;
37941
+ /** full name of search engine language
37942
+ required field if you don’t specify language_code
37943
+ if you use this field, you don’t need to specify language_code
37944
+ you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages
37945
+ example:
37946
+ English */
37947
+ language_name?: string | undefined;
37948
+ /** search engine language code
37949
+ required field if you don’t specify language_name
37950
+ if you use this field, you don’t need to specify language_name
37951
+ you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages
37952
+ example:
37953
+ en */
37954
+ language_code?: string | undefined;
37955
+ /** category of financial instruments to search for
37956
+ optional field
37957
+ possible values: all, stock, index, mutual_fund, currency, futures
37958
+ default value: all */
37959
+ category?: string | undefined;
37960
+ /** user-defined task identifier
37961
+ optional field
37962
+ the character limit is 255
37963
+ you can use this parameter to identify the task and match it with the result
37964
+ you will find the specified tag value in the data object of the response */
37965
+ tag?: string | undefined;
37966
+ [key: string]: any;
37967
+ constructor(data?: ISerpGoogleFinanceTickerSearchLiveAdvancedRequestInfo);
37968
+ init(_data?: any): void;
37969
+ static fromJS(data: any): SerpGoogleFinanceTickerSearchLiveAdvancedRequestInfo;
37970
+ toJSON(data?: any): any;
37971
+ }
37972
+ export interface ISerpGoogleFinanceTickerSearchLiveAdvancedRequestInfo {
37973
+ /** company or financial instrument name
37974
+ required field
37975
+ in this field, you can enter the name of a company or financial instrument to search for relevant tickers;
37976
+ you can specify up to 700 characters in the keyword field;
37977
+ all %## will be decoded (plus character ‘+’ will be decoded to a space character)
37978
+ if you need to use the “%” character for your keyword, please specify it as “%25”;
37979
+ if you need to use the “+” character for your keyword, please specify it as “%2B”;
37980
+ learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
37981
+ keyword?: string;
37982
+ /** full name of search engine location
37983
+ required field if you don’t specify location_code
37984
+ if you use this field, you don’t need to specify location_code
37985
+ you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/serp/google/locations
37986
+ example:
37987
+ London,England,United Kingdom */
37988
+ location_name?: string | undefined;
37989
+ /** search engine location code
37990
+ required field if you don’t specify location_name
37991
+ if you use this field, you don’t need to specify location_name
37992
+ you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/serp/google/locations
37993
+ example:
37994
+ 2840 */
37995
+ location_code?: number | undefined;
37996
+ /** full name of search engine language
37997
+ required field if you don’t specify language_code
37998
+ if you use this field, you don’t need to specify language_code
37999
+ you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages
38000
+ example:
38001
+ English */
38002
+ language_name?: string | undefined;
38003
+ /** search engine language code
38004
+ required field if you don’t specify language_name
38005
+ if you use this field, you don’t need to specify language_name
38006
+ you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages
38007
+ example:
38008
+ en */
38009
+ language_code?: string | undefined;
38010
+ /** category of financial instruments to search for
36948
38011
  optional field
36949
- possible values: 1D, 5D, 1M, 6M, YTD, 1Y, 5Y, MAX
36950
- default value: 1D
36951
- Note: if you specify a value that is different from 1D, the charge per task will be multiplied by 2 */
36952
- window?: string | undefined;
38012
+ possible values: all, stock, index, mutual_fund, currency, futures
38013
+ default value: all */
38014
+ category?: string | undefined;
36953
38015
  /** user-defined task identifier
36954
38016
  optional field
36955
38017
  the character limit is 255
@@ -36958,7 +38020,7 @@ you will find the specified tag value in the data object of the response */
36958
38020
  tag?: string | undefined;
36959
38021
  [key: string]: any;
36960
38022
  }
36961
- export declare class SerpGoogleFinanceQuoteLiveAdvancedResultInfo implements ISerpGoogleFinanceQuoteLiveAdvancedResultInfo {
38023
+ export declare class SerpGoogleFinanceTickerSearchLiveAdvancedResultInfo implements ISerpGoogleFinanceTickerSearchLiveAdvancedResultInfo {
36962
38024
  /** keyword received in a POST array
36963
38025
  the keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
36964
38026
  keyword?: string | undefined;
@@ -36986,21 +38048,23 @@ in this case, the value will be null */
36986
38048
  refinement_chips?: RefinementChipsInfo | undefined;
36987
38049
  /** types of search results in SERP
36988
38050
  contains types of search results (items) found in SERP;
36989
- possible item types: google_finance_hero_groups, google_finance_quote, google_finance_compare_to, google_finance_news, google_finance_financial, google_finance_futures_chain, google_finance_details, google_finance_about, google_finance_interested, google_finance_people_also_search */
38051
+ possible item types: google_finance_market_index, google_finance_asset_pair, google_finance_market_instrument */
36990
38052
  item_types?: (string | undefined)[] | undefined;
36991
38053
  /** total number of results in SERP */
36992
38054
  se_results_count?: number | undefined;
36993
38055
  /** the number of results returned in the items array */
36994
38056
  items_count?: number | undefined;
36995
- /** market indexes related to the market trends element */
36996
- items?: (BaseGoogleFinanceSerpElementItem | undefined)[] | undefined;
38057
+ /** items of search results found in SERP
38058
+ array of items containing market indexes data;
38059
+ possible type of items: google_finance_market_index, google_finance_asset_pair, google_finance_market_instrument */
38060
+ items?: (BaseGoogleFinanceTickerSearchSerpElementItem | undefined)[] | undefined;
36997
38061
  [key: string]: any;
36998
- constructor(data?: ISerpGoogleFinanceQuoteLiveAdvancedResultInfo);
38062
+ constructor(data?: ISerpGoogleFinanceTickerSearchLiveAdvancedResultInfo);
36999
38063
  init(_data?: any): void;
37000
- static fromJS(data: any): SerpGoogleFinanceQuoteLiveAdvancedResultInfo;
38064
+ static fromJS(data: any): SerpGoogleFinanceTickerSearchLiveAdvancedResultInfo;
37001
38065
  toJSON(data?: any): any;
37002
38066
  }
37003
- export interface ISerpGoogleFinanceQuoteLiveAdvancedResultInfo {
38067
+ export interface ISerpGoogleFinanceTickerSearchLiveAdvancedResultInfo {
37004
38068
  /** keyword received in a POST array
37005
38069
  the keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
37006
38070
  keyword?: string | undefined;
@@ -37028,242 +38092,44 @@ in this case, the value will be null */
37028
38092
  refinement_chips?: RefinementChipsInfo | undefined;
37029
38093
  /** types of search results in SERP
37030
38094
  contains types of search results (items) found in SERP;
37031
- possible item types: google_finance_hero_groups, google_finance_quote, google_finance_compare_to, google_finance_news, google_finance_financial, google_finance_futures_chain, google_finance_details, google_finance_about, google_finance_interested, google_finance_people_also_search */
38095
+ possible item types: google_finance_market_index, google_finance_asset_pair, google_finance_market_instrument */
37032
38096
  item_types?: (string | undefined)[] | undefined;
37033
38097
  /** total number of results in SERP */
37034
38098
  se_results_count?: number | undefined;
37035
38099
  /** the number of results returned in the items array */
37036
38100
  items_count?: number | undefined;
37037
- /** market indexes related to the market trends element */
37038
- items?: (BaseGoogleFinanceSerpElementItem | undefined)[] | undefined;
37039
- [key: string]: any;
37040
- }
37041
- export declare class SerpGoogleFinanceQuoteLiveAdvancedTaskInfo extends BaseResponseTaskInfo implements ISerpGoogleFinanceQuoteLiveAdvancedTaskInfo {
37042
- /** array of results */
37043
- result?: (SerpGoogleFinanceQuoteLiveAdvancedResultInfo | undefined)[] | undefined;
37044
- [key: string]: any;
37045
- constructor(data?: ISerpGoogleFinanceQuoteLiveAdvancedTaskInfo);
37046
- init(_data?: any): void;
37047
- static fromJS(data: any): SerpGoogleFinanceQuoteLiveAdvancedTaskInfo;
37048
- toJSON(data?: any): any;
37049
- }
37050
- export interface ISerpGoogleFinanceQuoteLiveAdvancedTaskInfo extends IBaseResponseTaskInfo {
37051
- /** array of results */
37052
- result?: (SerpGoogleFinanceQuoteLiveAdvancedResultInfo | undefined)[] | undefined;
37053
- [key: string]: any;
37054
- }
37055
- export declare class SerpGoogleFinanceQuoteLiveAdvancedResponseInfo extends BaseResponseInfo implements ISerpGoogleFinanceQuoteLiveAdvancedResponseInfo {
37056
- /** array of tasks */
37057
- tasks?: (SerpGoogleFinanceQuoteLiveAdvancedTaskInfo | undefined)[] | undefined;
37058
- [key: string]: any;
37059
- constructor(data?: ISerpGoogleFinanceQuoteLiveAdvancedResponseInfo);
37060
- init(_data?: any): void;
37061
- static fromJS(data: any): SerpGoogleFinanceQuoteLiveAdvancedResponseInfo;
37062
- toJSON(data?: any): any;
37063
- }
37064
- export interface ISerpGoogleFinanceQuoteLiveAdvancedResponseInfo extends IBaseResponseInfo {
37065
- /** array of tasks */
37066
- tasks?: (SerpGoogleFinanceQuoteLiveAdvancedTaskInfo | undefined)[] | undefined;
37067
- [key: string]: any;
37068
- }
37069
- export declare class SerpGoogleFinanceQuoteLiveHtmlRequestInfo implements ISerpGoogleFinanceQuoteLiveHtmlRequestInfo {
37070
- /** ticker or stock symbol
37071
- required field
37072
- in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange;
37073
- you can specify up to 700 characters in the keyword field;
37074
- all %## will be decoded (plus character ‘+’ will be decoded to a space character)
37075
- if you need to use the “%” character for your keyword, please specify it as “%25”;
37076
- if you need to use the “+” character for your keyword, please specify it as “%2B”;
37077
- learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
37078
- keyword?: string;
37079
- /** full name of search engine location
37080
- required field if you don’t specify location_code
37081
- if you use this field, you don’t need to specify location_code
37082
- you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/serp/google/locations
37083
- example:
37084
- London,England,United Kingdom */
37085
- location_name?: string | undefined;
37086
- /** search engine location code
37087
- required field if you don’t specify location_name
37088
- if you use this field, you don’t need to specify location_name
37089
- you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/serp/google/locations
37090
- example:
37091
- 2840 */
37092
- location_code?: number | undefined;
37093
- /** full name of search engine language
37094
- required field if you don’t specify language_code
37095
- if you use this field, you don’t need to specify language_code
37096
- you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages
37097
- example:
37098
- English */
37099
- language_name?: string | undefined;
37100
- /** search engine language code
37101
- required field if you don’t specify language_name
37102
- if you use this field, you don’t need to specify language_name
37103
- you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages
37104
- example:
37105
- en */
37106
- language_code?: string | undefined;
37107
- /** device type
37108
- optional field
37109
- possible value: desktop */
37110
- device?: string | undefined;
37111
- /** device operating system
37112
- optional field
37113
- possible values: windows */
37114
- os?: string | undefined;
37115
- /** time window for google_finance_quote graph
37116
- optional field
37117
- possible values: 1D, 5D, 1M, 6M, YTD, 1Y, 5Y, MAX
37118
- default value: 1D */
37119
- window?: string | undefined;
37120
- /** user-defined task identifier
37121
- optional field
37122
- the character limit is 255
37123
- you can use this parameter to identify the task and match it with the result
37124
- you will find the specified tag value in the data object of the response */
37125
- tag?: string | undefined;
37126
- [key: string]: any;
37127
- constructor(data?: ISerpGoogleFinanceQuoteLiveHtmlRequestInfo);
37128
- init(_data?: any): void;
37129
- static fromJS(data: any): SerpGoogleFinanceQuoteLiveHtmlRequestInfo;
37130
- toJSON(data?: any): any;
37131
- }
37132
- export interface ISerpGoogleFinanceQuoteLiveHtmlRequestInfo {
37133
- /** ticker or stock symbol
37134
- required field
37135
- in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange;
37136
- you can specify up to 700 characters in the keyword field;
37137
- all %## will be decoded (plus character ‘+’ will be decoded to a space character)
37138
- if you need to use the “%” character for your keyword, please specify it as “%25”;
37139
- if you need to use the “+” character for your keyword, please specify it as “%2B”;
37140
- learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
37141
- keyword?: string;
37142
- /** full name of search engine location
37143
- required field if you don’t specify location_code
37144
- if you use this field, you don’t need to specify location_code
37145
- you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/serp/google/locations
37146
- example:
37147
- London,England,United Kingdom */
37148
- location_name?: string | undefined;
37149
- /** search engine location code
37150
- required field if you don’t specify location_name
37151
- if you use this field, you don’t need to specify location_name
37152
- you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/serp/google/locations
37153
- example:
37154
- 2840 */
37155
- location_code?: number | undefined;
37156
- /** full name of search engine language
37157
- required field if you don’t specify language_code
37158
- if you use this field, you don’t need to specify language_code
37159
- you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages
37160
- example:
37161
- English */
37162
- language_name?: string | undefined;
37163
- /** search engine language code
37164
- required field if you don’t specify language_name
37165
- if you use this field, you don’t need to specify language_name
37166
- you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages
37167
- example:
37168
- en */
37169
- language_code?: string | undefined;
37170
- /** device type
37171
- optional field
37172
- possible value: desktop */
37173
- device?: string | undefined;
37174
- /** device operating system
37175
- optional field
37176
- possible values: windows */
37177
- os?: string | undefined;
37178
- /** time window for google_finance_quote graph
37179
- optional field
37180
- possible values: 1D, 5D, 1M, 6M, YTD, 1Y, 5Y, MAX
37181
- default value: 1D */
37182
- window?: string | undefined;
37183
- /** user-defined task identifier
37184
- optional field
37185
- the character limit is 255
37186
- you can use this parameter to identify the task and match it with the result
37187
- you will find the specified tag value in the data object of the response */
37188
- tag?: string | undefined;
37189
- [key: string]: any;
37190
- }
37191
- export declare class SerpGoogleFinanceQuoteLiveHtmlResultInfo implements ISerpGoogleFinanceQuoteLiveHtmlResultInfo {
37192
- /** keyword received in a POST array
37193
- keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
37194
- keyword?: string | undefined;
37195
- /** type of element */
37196
- type?: string | undefined;
37197
- /** search engine domain in a POST array */
37198
- se_domain?: string | undefined;
37199
- /** location code in a POST array */
37200
- location_code?: number | undefined;
37201
- /** language code in a POST array */
37202
- language_code?: string | undefined;
37203
- /** date and time when the result was received
37204
- in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
37205
- example:
37206
- 2019-11-15 12:57:46 +00:00 */
37207
- datetime?: string | undefined;
37208
- /** the number of results returned in the items array */
37209
- items_count?: number | undefined;
37210
- /** elements of search results found in SERP */
37211
- items?: (HtmlItem | undefined)[] | undefined;
37212
- [key: string]: any;
37213
- constructor(data?: ISerpGoogleFinanceQuoteLiveHtmlResultInfo);
37214
- init(_data?: any): void;
37215
- static fromJS(data: any): SerpGoogleFinanceQuoteLiveHtmlResultInfo;
37216
- toJSON(data?: any): any;
37217
- }
37218
- export interface ISerpGoogleFinanceQuoteLiveHtmlResultInfo {
37219
- /** keyword received in a POST array
37220
- keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
37221
- keyword?: string | undefined;
37222
- /** type of element */
37223
- type?: string | undefined;
37224
- /** search engine domain in a POST array */
37225
- se_domain?: string | undefined;
37226
- /** location code in a POST array */
37227
- location_code?: number | undefined;
37228
- /** language code in a POST array */
37229
- language_code?: string | undefined;
37230
- /** date and time when the result was received
37231
- in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
37232
- example:
37233
- 2019-11-15 12:57:46 +00:00 */
37234
- datetime?: string | undefined;
37235
- /** the number of results returned in the items array */
37236
- items_count?: number | undefined;
37237
- /** elements of search results found in SERP */
37238
- items?: (HtmlItem | undefined)[] | undefined;
38101
+ /** items of search results found in SERP
38102
+ array of items containing market indexes data;
38103
+ possible type of items: google_finance_market_index, google_finance_asset_pair, google_finance_market_instrument */
38104
+ items?: (BaseGoogleFinanceTickerSearchSerpElementItem | undefined)[] | undefined;
37239
38105
  [key: string]: any;
37240
38106
  }
37241
- export declare class SerpGoogleFinanceQuoteLiveHtmlTaskInfo extends BaseResponseTaskInfo implements ISerpGoogleFinanceQuoteLiveHtmlTaskInfo {
38107
+ export declare class SerpGoogleFinanceTickerSearchLiveAdvancedTaskInfo extends BaseResponseTaskInfo implements ISerpGoogleFinanceTickerSearchLiveAdvancedTaskInfo {
37242
38108
  /** array of results */
37243
- result?: (SerpGoogleFinanceQuoteLiveHtmlResultInfo | undefined)[] | undefined;
38109
+ result?: (SerpGoogleFinanceTickerSearchLiveAdvancedResultInfo | undefined)[] | undefined;
37244
38110
  [key: string]: any;
37245
- constructor(data?: ISerpGoogleFinanceQuoteLiveHtmlTaskInfo);
38111
+ constructor(data?: ISerpGoogleFinanceTickerSearchLiveAdvancedTaskInfo);
37246
38112
  init(_data?: any): void;
37247
- static fromJS(data: any): SerpGoogleFinanceQuoteLiveHtmlTaskInfo;
38113
+ static fromJS(data: any): SerpGoogleFinanceTickerSearchLiveAdvancedTaskInfo;
37248
38114
  toJSON(data?: any): any;
37249
38115
  }
37250
- export interface ISerpGoogleFinanceQuoteLiveHtmlTaskInfo extends IBaseResponseTaskInfo {
38116
+ export interface ISerpGoogleFinanceTickerSearchLiveAdvancedTaskInfo extends IBaseResponseTaskInfo {
37251
38117
  /** array of results */
37252
- result?: (SerpGoogleFinanceQuoteLiveHtmlResultInfo | undefined)[] | undefined;
38118
+ result?: (SerpGoogleFinanceTickerSearchLiveAdvancedResultInfo | undefined)[] | undefined;
37253
38119
  [key: string]: any;
37254
38120
  }
37255
- export declare class SerpGoogleFinanceQuoteLiveHtmlResponseInfo extends BaseResponseInfo implements ISerpGoogleFinanceQuoteLiveHtmlResponseInfo {
38121
+ export declare class SerpGoogleFinanceTickerSearchLiveAdvancedResponseInfo extends BaseResponseInfo implements ISerpGoogleFinanceTickerSearchLiveAdvancedResponseInfo {
37256
38122
  /** array of tasks */
37257
- tasks?: (SerpGoogleFinanceQuoteLiveHtmlTaskInfo | undefined)[] | undefined;
38123
+ tasks?: (SerpGoogleFinanceTickerSearchLiveAdvancedTaskInfo | undefined)[] | undefined;
37258
38124
  [key: string]: any;
37259
- constructor(data?: ISerpGoogleFinanceQuoteLiveHtmlResponseInfo);
38125
+ constructor(data?: ISerpGoogleFinanceTickerSearchLiveAdvancedResponseInfo);
37260
38126
  init(_data?: any): void;
37261
- static fromJS(data: any): SerpGoogleFinanceQuoteLiveHtmlResponseInfo;
38127
+ static fromJS(data: any): SerpGoogleFinanceTickerSearchLiveAdvancedResponseInfo;
37262
38128
  toJSON(data?: any): any;
37263
38129
  }
37264
- export interface ISerpGoogleFinanceQuoteLiveHtmlResponseInfo extends IBaseResponseInfo {
38130
+ export interface ISerpGoogleFinanceTickerSearchLiveAdvancedResponseInfo extends IBaseResponseInfo {
37265
38131
  /** array of tasks */
37266
- tasks?: (SerpGoogleFinanceQuoteLiveHtmlTaskInfo | undefined)[] | undefined;
38132
+ tasks?: (SerpGoogleFinanceTickerSearchLiveAdvancedTaskInfo | undefined)[] | undefined;
37267
38133
  [key: string]: any;
37268
38134
  }
37269
38135
  export declare class DomainAnalyticsIdListRequestInfo implements IDomainAnalyticsIdListRequestInfo {
@@ -41806,38 +42672,6 @@ you will find the specified tag value in the data object of the response */
41806
42672
  tag?: string | undefined;
41807
42673
  [key: string]: any;
41808
42674
  }
41809
- export declare class KeywordInfoNormalizedWithInfo implements IKeywordInfoNormalizedWithInfo {
41810
- /** date and time when the clickstream dataset was updated
41811
- in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” */
41812
- last_updated_time?: string | undefined;
41813
- /** monthly average clickstream search volume rate */
41814
- search_volume?: number | undefined;
41815
- /** keyword info is normalized
41816
- if true, values are normalized with Bing data */
41817
- is_normalized?: boolean | undefined;
41818
- /** monthly clickstream search volume rates
41819
- array of objects with clickstream search volume rates in a certain month of a year */
41820
- monthly_searches?: (MonthlySearches | undefined)[] | undefined;
41821
- [key: string]: any;
41822
- constructor(data?: IKeywordInfoNormalizedWithInfo);
41823
- init(_data?: any): void;
41824
- static fromJS(data: any): KeywordInfoNormalizedWithInfo;
41825
- toJSON(data?: any): any;
41826
- }
41827
- export interface IKeywordInfoNormalizedWithInfo {
41828
- /** date and time when the clickstream dataset was updated
41829
- in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” */
41830
- last_updated_time?: string | undefined;
41831
- /** monthly average clickstream search volume rate */
41832
- search_volume?: number | undefined;
41833
- /** keyword info is normalized
41834
- if true, values are normalized with Bing data */
41835
- is_normalized?: boolean | undefined;
41836
- /** monthly clickstream search volume rates
41837
- array of objects with clickstream search volume rates in a certain month of a year */
41838
- monthly_searches?: (MonthlySearches | undefined)[] | undefined;
41839
- [key: string]: any;
41840
- }
41841
42675
  export declare class DataforseoLabsRelatedKeywordsLiveItem implements IDataforseoLabsRelatedKeywordsLiveItem {
41842
42676
  /** search engine type */
41843
42677
  se_type?: string | undefined;
@@ -42634,278 +43468,6 @@ export interface IDataforseoLabsGoogleKeywordIdeasLiveResponseInfo extends IBase
42634
43468
  tasks?: (DataforseoLabsGoogleKeywordIdeasLiveTaskInfo | undefined)[] | undefined;
42635
43469
  [key: string]: any;
42636
43470
  }
42637
- export declare class DataforseoLabsGoogleHistoricalSearchVolumeLiveRequestInfo implements IDataforseoLabsGoogleHistoricalSearchVolumeLiveRequestInfo {
42638
- /** keywords
42639
- required field
42640
- The maximum number of keywords you can specify: 700
42641
- The maximum number of characters for each keyword: 80
42642
- The maximum number of words for each keyword phrase: 10
42643
- the specified keywords will be converted to lowercase format, data will be provided in a separate array
42644
- note that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn’t contain such keywords and cannot return data on them
42645
- you will not be charged for the keywords omitted in the results
42646
- learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
42647
- keywords?: string[];
42648
- /** full name of the location
42649
- required field if you don’t specify location_code
42650
- Note: it is required to specify either location_name or location_code
42651
- you can receive the list of available locations with their location_name by making a separate request to the
42652
- https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
42653
- example:
42654
- United Kingdom */
42655
- location_name?: string | undefined;
42656
- /** location code
42657
- required field if you don’t specify location_name
42658
- Note: it is required to specify either location_name or location_code
42659
- you can receive the list of available locations with their location_code by making a separate request to the
42660
- https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
42661
- example:
42662
- 2840 */
42663
- location_code?: number | undefined;
42664
- /** full name of the language
42665
- required field if you don’t specify language_code
42666
- Note: it is required to specify either language_name or language_code
42667
- you can receive the list of available locations with their language_name by making a separate request to the
42668
- https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
42669
- example:
42670
- English */
42671
- language_name?: string | undefined;
42672
- /** language code
42673
- required field if you don’t specify language_name
42674
- Note: it is required to specify either language_name or language_code
42675
- you can receive the list of available locations with their language_code by making a separate request to the
42676
- https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
42677
- example:
42678
- en */
42679
- language_code?: string | undefined;
42680
- /** include data from SERP for each keyword
42681
- optional field
42682
- if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
42683
- default value: false */
42684
- include_serp_info?: boolean | undefined;
42685
- /** include or exclude data from clickstream-based metrics in the result
42686
- optional field
42687
- if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response
42688
- default value: false
42689
- with this parameter enabled, you will be charged double the price for the request
42690
- learn more about how clickstream-based metrics are calculated in this help center article */
42691
- include_clickstream_data?: boolean | undefined;
42692
- /** user-defined task identifier
42693
- optional field
42694
- the character limit is 255
42695
- you can use this parameter to identify the task and match it with the result
42696
- you will find the specified tag value in the data object of the response */
42697
- tag?: string | undefined;
42698
- [key: string]: any;
42699
- constructor(data?: IDataforseoLabsGoogleHistoricalSearchVolumeLiveRequestInfo);
42700
- init(_data?: any): void;
42701
- static fromJS(data: any): DataforseoLabsGoogleHistoricalSearchVolumeLiveRequestInfo;
42702
- toJSON(data?: any): any;
42703
- }
42704
- export interface IDataforseoLabsGoogleHistoricalSearchVolumeLiveRequestInfo {
42705
- /** keywords
42706
- required field
42707
- The maximum number of keywords you can specify: 700
42708
- The maximum number of characters for each keyword: 80
42709
- The maximum number of words for each keyword phrase: 10
42710
- the specified keywords will be converted to lowercase format, data will be provided in a separate array
42711
- note that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn’t contain such keywords and cannot return data on them
42712
- you will not be charged for the keywords omitted in the results
42713
- learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
42714
- keywords?: string[];
42715
- /** full name of the location
42716
- required field if you don’t specify location_code
42717
- Note: it is required to specify either location_name or location_code
42718
- you can receive the list of available locations with their location_name by making a separate request to the
42719
- https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
42720
- example:
42721
- United Kingdom */
42722
- location_name?: string | undefined;
42723
- /** location code
42724
- required field if you don’t specify location_name
42725
- Note: it is required to specify either location_name or location_code
42726
- you can receive the list of available locations with their location_code by making a separate request to the
42727
- https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
42728
- example:
42729
- 2840 */
42730
- location_code?: number | undefined;
42731
- /** full name of the language
42732
- required field if you don’t specify language_code
42733
- Note: it is required to specify either language_name or language_code
42734
- you can receive the list of available locations with their language_name by making a separate request to the
42735
- https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
42736
- example:
42737
- English */
42738
- language_name?: string | undefined;
42739
- /** language code
42740
- required field if you don’t specify language_name
42741
- Note: it is required to specify either language_name or language_code
42742
- you can receive the list of available locations with their language_code by making a separate request to the
42743
- https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
42744
- example:
42745
- en */
42746
- language_code?: string | undefined;
42747
- /** include data from SERP for each keyword
42748
- optional field
42749
- if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
42750
- default value: false */
42751
- include_serp_info?: boolean | undefined;
42752
- /** include or exclude data from clickstream-based metrics in the result
42753
- optional field
42754
- if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response
42755
- default value: false
42756
- with this parameter enabled, you will be charged double the price for the request
42757
- learn more about how clickstream-based metrics are calculated in this help center article */
42758
- include_clickstream_data?: boolean | undefined;
42759
- /** user-defined task identifier
42760
- optional field
42761
- the character limit is 255
42762
- you can use this parameter to identify the task and match it with the result
42763
- you will find the specified tag value in the data object of the response */
42764
- tag?: string | undefined;
42765
- [key: string]: any;
42766
- }
42767
- export declare class DataforseoLabsGoogleHistoricalSearchVolumeLiveItem implements IDataforseoLabsGoogleHistoricalSearchVolumeLiveItem {
42768
- /** search engine type */
42769
- se_type?: string | undefined;
42770
- /** keyword
42771
- keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
42772
- keyword?: string | undefined;
42773
- /** location code in a POST array
42774
- if there is no data, then the value is null */
42775
- location_code?: number | undefined;
42776
- /** language code in a POST array */
42777
- language_code?: string | undefined;
42778
- /** indicates data for Google and partner sites
42779
- if true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;
42780
- if false, the results are returned for Google search sites only */
42781
- search_partners?: boolean | undefined;
42782
- /** keyword data for the returned keyword idea */
42783
- keyword_info?: KeywordInfo | undefined;
42784
- /** contains keyword search volume normalized with Bing search volume */
42785
- keyword_info_normalized_with_bing?: KeywordInfoNormalizedWithInfo | undefined;
42786
- /** contains keyword search volume normalized with clickstream data */
42787
- keyword_info_normalized_with_clickstream?: KeywordInfoNormalizedWithInfo | undefined;
42788
- /** clickstream data for the returned keyword
42789
- to retrieve results for this field, the parameter include_clickstream_data must be set to true */
42790
- clickstream_keyword_info?: ClickstreamKeywordInfo | undefined;
42791
- /** additional information about the keyword */
42792
- keyword_properties?: KeywordProperties | undefined;
42793
- /** impressions data for the returned keyword idea
42794
- Note that all data in the impressions_info object is deprecated and provided only as legacy to avoid maintenance issues
42795
- daily_impressions values provide a more accurate alternative to Google search volume data;
42796
- the 999 bid is used to mitigate account-specific factors Google considers when calculating impressions
42797
- learn more about impressions in this help center article */
42798
- impressions_info?: ImpressionsInfo | undefined;
42799
- /** SERP data
42800
- the value will be null if you didn’t set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database */
42801
- serp_info?: SerpInfo | undefined;
42802
- /** backlink data for the returned keyword
42803
- this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 websites ranking organically for the keyword */
42804
- avg_backlinks_info?: AvgBacklinksInfo | undefined;
42805
- [key: string]: any;
42806
- constructor(data?: IDataforseoLabsGoogleHistoricalSearchVolumeLiveItem);
42807
- init(_data?: any): void;
42808
- static fromJS(data: any): DataforseoLabsGoogleHistoricalSearchVolumeLiveItem;
42809
- toJSON(data?: any): any;
42810
- }
42811
- export interface IDataforseoLabsGoogleHistoricalSearchVolumeLiveItem {
42812
- /** search engine type */
42813
- se_type?: string | undefined;
42814
- /** keyword
42815
- keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
42816
- keyword?: string | undefined;
42817
- /** location code in a POST array
42818
- if there is no data, then the value is null */
42819
- location_code?: number | undefined;
42820
- /** language code in a POST array */
42821
- language_code?: string | undefined;
42822
- /** indicates data for Google and partner sites
42823
- if true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;
42824
- if false, the results are returned for Google search sites only */
42825
- search_partners?: boolean | undefined;
42826
- /** keyword data for the returned keyword idea */
42827
- keyword_info?: KeywordInfo | undefined;
42828
- /** contains keyword search volume normalized with Bing search volume */
42829
- keyword_info_normalized_with_bing?: KeywordInfoNormalizedWithInfo | undefined;
42830
- /** contains keyword search volume normalized with clickstream data */
42831
- keyword_info_normalized_with_clickstream?: KeywordInfoNormalizedWithInfo | undefined;
42832
- /** clickstream data for the returned keyword
42833
- to retrieve results for this field, the parameter include_clickstream_data must be set to true */
42834
- clickstream_keyword_info?: ClickstreamKeywordInfo | undefined;
42835
- /** additional information about the keyword */
42836
- keyword_properties?: KeywordProperties | undefined;
42837
- /** impressions data for the returned keyword idea
42838
- Note that all data in the impressions_info object is deprecated and provided only as legacy to avoid maintenance issues
42839
- daily_impressions values provide a more accurate alternative to Google search volume data;
42840
- the 999 bid is used to mitigate account-specific factors Google considers when calculating impressions
42841
- learn more about impressions in this help center article */
42842
- impressions_info?: ImpressionsInfo | undefined;
42843
- /** SERP data
42844
- the value will be null if you didn’t set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database */
42845
- serp_info?: SerpInfo | undefined;
42846
- /** backlink data for the returned keyword
42847
- this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 websites ranking organically for the keyword */
42848
- avg_backlinks_info?: AvgBacklinksInfo | undefined;
42849
- [key: string]: any;
42850
- }
42851
- export declare class DataforseoLabsGoogleHistoricalSearchVolumeLiveResultInfo implements IDataforseoLabsGoogleHistoricalSearchVolumeLiveResultInfo {
42852
- /** search engine type */
42853
- se_type?: string | undefined;
42854
- /** location code in a POST array */
42855
- location_code?: number | undefined;
42856
- /** language code in a POST array */
42857
- language_code?: string | undefined;
42858
- /** the number of results returned in the items array */
42859
- items_count?: number | undefined;
42860
- /** contains keywords and related data */
42861
- items?: (DataforseoLabsGoogleHistoricalSearchVolumeLiveItem | undefined)[] | undefined;
42862
- [key: string]: any;
42863
- constructor(data?: IDataforseoLabsGoogleHistoricalSearchVolumeLiveResultInfo);
42864
- init(_data?: any): void;
42865
- static fromJS(data: any): DataforseoLabsGoogleHistoricalSearchVolumeLiveResultInfo;
42866
- toJSON(data?: any): any;
42867
- }
42868
- export interface IDataforseoLabsGoogleHistoricalSearchVolumeLiveResultInfo {
42869
- /** search engine type */
42870
- se_type?: string | undefined;
42871
- /** location code in a POST array */
42872
- location_code?: number | undefined;
42873
- /** language code in a POST array */
42874
- language_code?: string | undefined;
42875
- /** the number of results returned in the items array */
42876
- items_count?: number | undefined;
42877
- /** contains keywords and related data */
42878
- items?: (DataforseoLabsGoogleHistoricalSearchVolumeLiveItem | undefined)[] | undefined;
42879
- [key: string]: any;
42880
- }
42881
- export declare class DataforseoLabsGoogleHistoricalSearchVolumeLiveTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsGoogleHistoricalSearchVolumeLiveTaskInfo {
42882
- /** array of results */
42883
- result?: (DataforseoLabsGoogleHistoricalSearchVolumeLiveResultInfo | undefined)[] | undefined;
42884
- [key: string]: any;
42885
- constructor(data?: IDataforseoLabsGoogleHistoricalSearchVolumeLiveTaskInfo);
42886
- init(_data?: any): void;
42887
- static fromJS(data: any): DataforseoLabsGoogleHistoricalSearchVolumeLiveTaskInfo;
42888
- toJSON(data?: any): any;
42889
- }
42890
- export interface IDataforseoLabsGoogleHistoricalSearchVolumeLiveTaskInfo extends IBaseResponseTaskInfo {
42891
- /** array of results */
42892
- result?: (DataforseoLabsGoogleHistoricalSearchVolumeLiveResultInfo | undefined)[] | undefined;
42893
- [key: string]: any;
42894
- }
42895
- export declare class DataforseoLabsGoogleHistoricalSearchVolumeLiveResponseInfo extends BaseResponseInfo implements IDataforseoLabsGoogleHistoricalSearchVolumeLiveResponseInfo {
42896
- /** array of tasks */
42897
- tasks?: (DataforseoLabsGoogleHistoricalSearchVolumeLiveTaskInfo | undefined)[] | undefined;
42898
- [key: string]: any;
42899
- constructor(data?: IDataforseoLabsGoogleHistoricalSearchVolumeLiveResponseInfo);
42900
- init(_data?: any): void;
42901
- static fromJS(data: any): DataforseoLabsGoogleHistoricalSearchVolumeLiveResponseInfo;
42902
- toJSON(data?: any): any;
42903
- }
42904
- export interface IDataforseoLabsGoogleHistoricalSearchVolumeLiveResponseInfo extends IBaseResponseInfo {
42905
- /** array of tasks */
42906
- tasks?: (DataforseoLabsGoogleHistoricalSearchVolumeLiveTaskInfo | undefined)[] | undefined;
42907
- [key: string]: any;
42908
- }
42909
43471
  export declare class DataforseoLabsGoogleBulkKeywordDifficultyLiveRequestInfo implements IDataforseoLabsGoogleBulkKeywordDifficultyLiveRequestInfo {
42910
43472
  /** target keywords
42911
43473
  required field
@@ -45640,7 +46202,7 @@ the popularity rate based on reviews and displayed in SERP */
45640
46202
  /** sitelinks
45641
46203
  the links shown below some of Google’s search results
45642
46204
  if there are none, equals null */
45643
- links?: any | undefined;
46205
+ links?: (LinkElement | undefined)[] | undefined;
45644
46206
  /** contains information from the ‘About this result’ panel
45645
46207
  ‘About this result’ panel provides additional context about why Google returned this result for the given query;
45646
46208
  this feature appears after clicking on the three dots next to most results */
@@ -45721,7 +46283,7 @@ the popularity rate based on reviews and displayed in SERP */
45721
46283
  /** sitelinks
45722
46284
  the links shown below some of Google’s search results
45723
46285
  if there are none, equals null */
45724
- links?: any | undefined;
46286
+ links?: (LinkElement | undefined)[] | undefined;
45725
46287
  /** contains information from the ‘About this result’ panel
45726
46288
  ‘About this result’ panel provides additional context about why Google returned this result for the given query;
45727
46289
  this feature appears after clicking on the three dots next to most results */
@@ -48116,13 +48678,47 @@ you will find the specified tag value in the data object of the response */
48116
48678
  tag?: string | undefined;
48117
48679
  [key: string]: any;
48118
48680
  }
48681
+ export declare class KnowledgeGraphLinkElementInfo implements IKnowledgeGraphLinkElementInfo {
48682
+ /** type of element */
48683
+ type?: string | undefined;
48684
+ /** title of the result in SERP */
48685
+ title?: string | undefined;
48686
+ /** sitelink URL */
48687
+ url?: string | undefined;
48688
+ /** domain in SERP */
48689
+ domain?: string | undefined;
48690
+ /** text alongside the link title */
48691
+ snippet?: string | undefined;
48692
+ /** the XPath of the element */
48693
+ xpath?: string | undefined;
48694
+ [key: string]: any;
48695
+ constructor(data?: IKnowledgeGraphLinkElementInfo);
48696
+ init(_data?: any): void;
48697
+ static fromJS(data: any): KnowledgeGraphLinkElementInfo;
48698
+ toJSON(data?: any): any;
48699
+ }
48700
+ export interface IKnowledgeGraphLinkElementInfo {
48701
+ /** type of element */
48702
+ type?: string | undefined;
48703
+ /** title of the result in SERP */
48704
+ title?: string | undefined;
48705
+ /** sitelink URL */
48706
+ url?: string | undefined;
48707
+ /** domain in SERP */
48708
+ domain?: string | undefined;
48709
+ /** text alongside the link title */
48710
+ snippet?: string | undefined;
48711
+ /** the XPath of the element */
48712
+ xpath?: string | undefined;
48713
+ [key: string]: any;
48714
+ }
48119
48715
  export declare class KnowledgeGraphDescriptionItemDataforseoLabsSerpElementItem extends BaseDataforseoLabsSerpElementItem implements IKnowledgeGraphDescriptionItemDataforseoLabsSerpElementItem {
48120
48716
  /** description content */
48121
48717
  text?: string | undefined;
48122
48718
  /** sitelinks
48123
48719
  the links shown below some of Google’s search results
48124
48720
  if there are none, equals null */
48125
- links?: (LinkElement | undefined)[] | undefined;
48721
+ links?: (KnowledgeGraphLinkElementInfo | undefined)[] | undefined;
48126
48722
  [key: string]: any;
48127
48723
  constructor(data?: IKnowledgeGraphDescriptionItemDataforseoLabsSerpElementItem);
48128
48724
  init(_data?: any): void;
@@ -48135,7 +48731,7 @@ export interface IKnowledgeGraphDescriptionItemDataforseoLabsSerpElementItem ext
48135
48731
  /** sitelinks
48136
48732
  the links shown below some of Google’s search results
48137
48733
  if there are none, equals null */
48138
- links?: (LinkElement | undefined)[] | undefined;
48734
+ links?: (KnowledgeGraphLinkElementInfo | undefined)[] | undefined;
48139
48735
  [key: string]: any;
48140
48736
  }
48141
48737
  export declare class KnowledgeGraphCarouselItemDataforseoLabsSerpElementItem extends BaseDataforseoLabsSerpElementItem implements IKnowledgeGraphCarouselItemDataforseoLabsSerpElementItem {
@@ -48651,7 +49247,9 @@ export interface IMapDataforseoLabsSerpElementItem extends IBaseDataforseoLabsSe
48651
49247
  [key: string]: any;
48652
49248
  }
48653
49249
  export declare class FeaturedSnippetDataforseoLabsSerpElementItem extends BaseDataforseoLabsSerpElementItem implements IFeaturedSnippetDataforseoLabsSerpElementItem {
48654
- /** domain where a link points */
49250
+ /** search engine type */
49251
+ se_type?: string | undefined;
49252
+ /** subdomain in SERP */
48655
49253
  domain?: string | undefined;
48656
49254
  /** title of the result in SERP */
48657
49255
  title?: string | undefined;
@@ -48659,32 +49257,29 @@ export declare class FeaturedSnippetDataforseoLabsSerpElementItem extends BaseDa
48659
49257
  featured_title?: string | undefined;
48660
49258
  /** description of the results element in SERP */
48661
49259
  description?: string | undefined;
48662
- /** relevant URL */
49260
+ /** relevant URL in SERP */
48663
49261
  url?: string | undefined;
48664
49262
  /** results table
48665
49263
  if there are none, equals null */
48666
49264
  table?: Table | undefined;
48667
- /** search engine type */
48668
- se_type?: string | undefined;
48669
49265
  /** primary domain name in SERP */
48670
49266
  main_domain?: string | undefined;
48671
- /** URL in SERP that does not specify the HTTPs protocol and domain name */
49267
+ /** relative URL in SERP */
48672
49268
  relative_url?: string | undefined;
48673
49269
  /** estimated traffic volume
48674
- estimated paid monthly traffic to the domain
48675
- calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain ranks for
49270
+ estimated organic monthly traffic to the domain;
49271
+ calculated as the product of CTR (click-through-rate) and search volume values of the returned keyword
48676
49272
  learn more about how the metric is calculated in this help center article */
48677
49273
  etv?: number | undefined;
48678
- /** estimated cost of monthly search traffic
48679
- represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values of all keywords in the category that the domain ranks for
49274
+ /** estimated cost of converting organic search traffic into paid
49275
+ represents the estimated monthly cost of running ads (USD) for the returned keyword;
49276
+ the metric is calculated as the product of organic etv and paid cpc values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Bing Search
48680
49277
  learn more about how the metric is calculated in this help center article */
48681
49278
  estimated_paid_traffic_cost?: number | undefined;
48682
49279
  /** changes in rankings
48683
49280
  contains information about the ranking changes of the SERP element since the previous_updated_time */
48684
49281
  rank_changes?: RankChanges | undefined;
48685
- /** backlinks information for the target website */
48686
49282
  backlinks_info?: BacklinksInfo | undefined;
48687
- /** page and domain rank information */
48688
49283
  rank_info?: RankInfo | undefined;
48689
49284
  [key: string]: any;
48690
49285
  constructor(data?: IFeaturedSnippetDataforseoLabsSerpElementItem);
@@ -48693,7 +49288,9 @@ contains information about the ranking changes of the SERP element since the pre
48693
49288
  toJSON(data?: any): any;
48694
49289
  }
48695
49290
  export interface IFeaturedSnippetDataforseoLabsSerpElementItem extends IBaseDataforseoLabsSerpElementItem {
48696
- /** domain where a link points */
49291
+ /** search engine type */
49292
+ se_type?: string | undefined;
49293
+ /** subdomain in SERP */
48697
49294
  domain?: string | undefined;
48698
49295
  /** title of the result in SERP */
48699
49296
  title?: string | undefined;
@@ -48701,32 +49298,29 @@ export interface IFeaturedSnippetDataforseoLabsSerpElementItem extends IBaseData
48701
49298
  featured_title?: string | undefined;
48702
49299
  /** description of the results element in SERP */
48703
49300
  description?: string | undefined;
48704
- /** relevant URL */
49301
+ /** relevant URL in SERP */
48705
49302
  url?: string | undefined;
48706
49303
  /** results table
48707
49304
  if there are none, equals null */
48708
49305
  table?: Table | undefined;
48709
- /** search engine type */
48710
- se_type?: string | undefined;
48711
49306
  /** primary domain name in SERP */
48712
49307
  main_domain?: string | undefined;
48713
- /** URL in SERP that does not specify the HTTPs protocol and domain name */
49308
+ /** relative URL in SERP */
48714
49309
  relative_url?: string | undefined;
48715
49310
  /** estimated traffic volume
48716
- estimated paid monthly traffic to the domain
48717
- calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain ranks for
49311
+ estimated organic monthly traffic to the domain;
49312
+ calculated as the product of CTR (click-through-rate) and search volume values of the returned keyword
48718
49313
  learn more about how the metric is calculated in this help center article */
48719
49314
  etv?: number | undefined;
48720
- /** estimated cost of monthly search traffic
48721
- represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values of all keywords in the category that the domain ranks for
49315
+ /** estimated cost of converting organic search traffic into paid
49316
+ represents the estimated monthly cost of running ads (USD) for the returned keyword;
49317
+ the metric is calculated as the product of organic etv and paid cpc values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Bing Search
48722
49318
  learn more about how the metric is calculated in this help center article */
48723
49319
  estimated_paid_traffic_cost?: number | undefined;
48724
49320
  /** changes in rankings
48725
49321
  contains information about the ranking changes of the SERP element since the previous_updated_time */
48726
49322
  rank_changes?: RankChanges | undefined;
48727
- /** backlinks information for the target website */
48728
49323
  backlinks_info?: BacklinksInfo | undefined;
48729
- /** page and domain rank information */
48730
49324
  rank_info?: RankInfo | undefined;
48731
49325
  [key: string]: any;
48732
49326
  }
@@ -50559,45 +51153,562 @@ example:
50559
51153
  if you use this field, you don’t need to specify language_code
50560
51154
  you can receive the list of available languages with their language_name by making a separate request to the
50561
51155
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
50562
- ignore this field to get the results for all available languages
51156
+ ignore this field to get the results for all available languages
51157
+ example:
51158
+ English */
51159
+ language_name?: string | undefined;
51160
+ /** language code
51161
+ if you use this field, you don’t need to specify language_name
51162
+ you can receive the list of available languages with their language_code by making a separate request to the
51163
+ https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
51164
+ ignore this field to get the results for all available languages
51165
+ example:
51166
+ en */
51167
+ language_code?: string | undefined;
51168
+ /** starting date of the time range
51169
+ optional field
51170
+ if you don’t specify this field, the data will be provided for the previous 12 months
51171
+ minimal possible value: 2020-10-01
51172
+ date format: "yyyy-mm-dd" */
51173
+ date_from?: string | undefined;
51174
+ /** ending date of the time range
51175
+ optional field
51176
+ if you don’t specify this field, the today’s date will be used by default;
51177
+ date format: "yyyy-mm-dd"
51178
+ example:
51179
+ "2021-04-01" */
51180
+ date_to?: string | undefined;
51181
+ /** ignore highly similar keywords
51182
+ optional field
51183
+ if set to true, only core keywords will be returned, all highly similar keywords will be excluded;
51184
+ default value: false */
51185
+ ignore_synonyms?: boolean | undefined;
51186
+ /** display results by item type
51187
+ optional field
51188
+ indicates the type of search results included in the response;
51189
+ Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array;
51190
+ possible values:
51191
+ ["organic", "paid", "featured_snippet", "local_pack"]
51192
+ default value:
51193
+ ["organic", "paid"] */
51194
+ item_types?: string[] | undefined;
51195
+ /** user-defined task identifier
51196
+ optional field
51197
+ the character limit is 255
51198
+ you can use this parameter to identify the task and match it with the result
51199
+ you will find the specified tag value in the data object of the response */
51200
+ tag?: string | undefined;
51201
+ [key: string]: any;
51202
+ constructor(data?: IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveRequestInfo);
51203
+ init(_data?: any): void;
51204
+ static fromJS(data: any): DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveRequestInfo;
51205
+ toJSON(data?: any): any;
51206
+ }
51207
+ export interface IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveRequestInfo {
51208
+ /** target domains and subdomains
51209
+ required field
51210
+ you can specify domains and subdomains in this field;
51211
+ domains and subdomains should be specified without https:// and www.;
51212
+ you can set up to 1000 domains or subdomains */
51213
+ targets?: string[];
51214
+ /** full name of the location
51215
+ if you use this field, you don’t have to specify location_code
51216
+ you can receive the list of available locations with their location_name by making a separate request to the
51217
+ https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
51218
+ ignore this field to get the results for all available locations
51219
+ example:
51220
+ United Kingdom */
51221
+ location_name?: string | undefined;
51222
+ /** location code
51223
+ if you use this field, you don’t have to specify location_name
51224
+ you can receive the list of available locations with their location_code by making a separate request to the
51225
+ https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
51226
+ ignore this field to get the results for all available locations
51227
+ example:
51228
+ 2840 */
51229
+ location_code?: number | undefined;
51230
+ /** full name of the language
51231
+ if you use this field, you don’t need to specify language_code
51232
+ you can receive the list of available languages with their language_name by making a separate request to the
51233
+ https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
51234
+ ignore this field to get the results for all available languages
51235
+ example:
51236
+ English */
51237
+ language_name?: string | undefined;
51238
+ /** language code
51239
+ if you use this field, you don’t need to specify language_name
51240
+ you can receive the list of available languages with their language_code by making a separate request to the
51241
+ https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
51242
+ ignore this field to get the results for all available languages
51243
+ example:
51244
+ en */
51245
+ language_code?: string | undefined;
51246
+ /** starting date of the time range
51247
+ optional field
51248
+ if you don’t specify this field, the data will be provided for the previous 12 months
51249
+ minimal possible value: 2020-10-01
51250
+ date format: "yyyy-mm-dd" */
51251
+ date_from?: string | undefined;
51252
+ /** ending date of the time range
51253
+ optional field
51254
+ if you don’t specify this field, the today’s date will be used by default;
51255
+ date format: "yyyy-mm-dd"
51256
+ example:
51257
+ "2021-04-01" */
51258
+ date_to?: string | undefined;
51259
+ /** ignore highly similar keywords
51260
+ optional field
51261
+ if set to true, only core keywords will be returned, all highly similar keywords will be excluded;
51262
+ default value: false */
51263
+ ignore_synonyms?: boolean | undefined;
51264
+ /** display results by item type
51265
+ optional field
51266
+ indicates the type of search results included in the response;
51267
+ Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array;
51268
+ possible values:
51269
+ ["organic", "paid", "featured_snippet", "local_pack"]
51270
+ default value:
51271
+ ["organic", "paid"] */
51272
+ item_types?: string[] | undefined;
51273
+ /** user-defined task identifier
51274
+ optional field
51275
+ the character limit is 255
51276
+ you can use this parameter to identify the task and match it with the result
51277
+ you will find the specified tag value in the data object of the response */
51278
+ tag?: string | undefined;
51279
+ [key: string]: any;
51280
+ }
51281
+ export declare class HistoricalMetricsInfo implements IHistoricalMetricsInfo {
51282
+ /** year for which the data is provided */
51283
+ year?: number | undefined;
51284
+ /** month for which the data is provided */
51285
+ month?: number | undefined;
51286
+ /** estimated traffic volume
51287
+ estimated organic monthly traffic to the domain
51288
+ calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain ranks for
51289
+ learn more about how the metric is calculated in this help center article */
51290
+ etv?: number | undefined;
51291
+ /** total count of organic SERPs that contain the domain */
51292
+ count?: number | undefined;
51293
+ /** estimated traffic volume based on clickstream data
51294
+ calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for
51295
+ to retrieve results for this field, the parameter include_clickstream_data must be set to true
51296
+ learn more about how the metric is calculated in this help center article https://dataforseo.com/help-center/whats-clickstream-estimated-traffic-volume-and-how-is-it-calculated */
51297
+ clickstream_etv?: number | undefined;
51298
+ [key: string]: any;
51299
+ constructor(data?: IHistoricalMetricsInfo);
51300
+ init(_data?: any): void;
51301
+ static fromJS(data: any): HistoricalMetricsInfo;
51302
+ toJSON(data?: any): any;
51303
+ }
51304
+ export interface IHistoricalMetricsInfo {
51305
+ /** year for which the data is provided */
51306
+ year?: number | undefined;
51307
+ /** month for which the data is provided */
51308
+ month?: number | undefined;
51309
+ /** estimated traffic volume
51310
+ estimated organic monthly traffic to the domain
51311
+ calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain ranks for
51312
+ learn more about how the metric is calculated in this help center article */
51313
+ etv?: number | undefined;
51314
+ /** total count of organic SERPs that contain the domain */
51315
+ count?: number | undefined;
51316
+ /** estimated traffic volume based on clickstream data
51317
+ calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for
51318
+ to retrieve results for this field, the parameter include_clickstream_data must be set to true
51319
+ learn more about how the metric is calculated in this help center article https://dataforseo.com/help-center/whats-clickstream-estimated-traffic-volume-and-how-is-it-calculated */
51320
+ clickstream_etv?: number | undefined;
51321
+ [key: string]: any;
51322
+ }
51323
+ export declare class HistoricalMetricsBundleInfo implements IHistoricalMetricsBundleInfo {
51324
+ /** traffic data from organic search */
51325
+ organic?: (HistoricalMetricsInfo | undefined)[] | undefined;
51326
+ /** traffic data from paid search */
51327
+ paid?: (HistoricalMetricsInfo | undefined)[] | undefined;
51328
+ /** traffic data from the featured snippet results in Google SERP */
51329
+ local_pack?: (HistoricalMetricsInfo | undefined)[] | undefined;
51330
+ /** traffic data from the local pack results in SERP */
51331
+ featured_snippet?: (HistoricalMetricsInfo | undefined)[] | undefined;
51332
+ [key: string]: any;
51333
+ constructor(data?: IHistoricalMetricsBundleInfo);
51334
+ init(_data?: any): void;
51335
+ static fromJS(data: any): HistoricalMetricsBundleInfo;
51336
+ toJSON(data?: any): any;
51337
+ }
51338
+ export interface IHistoricalMetricsBundleInfo {
51339
+ /** traffic data from organic search */
51340
+ organic?: (HistoricalMetricsInfo | undefined)[] | undefined;
51341
+ /** traffic data from paid search */
51342
+ paid?: (HistoricalMetricsInfo | undefined)[] | undefined;
51343
+ /** traffic data from the featured snippet results in Google SERP */
51344
+ local_pack?: (HistoricalMetricsInfo | undefined)[] | undefined;
51345
+ /** traffic data from the local pack results in SERP */
51346
+ featured_snippet?: (HistoricalMetricsInfo | undefined)[] | undefined;
51347
+ [key: string]: any;
51348
+ }
51349
+ export declare class DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveItem implements IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveItem {
51350
+ /** search engine type */
51351
+ se_type?: string | undefined;
51352
+ /** target domain in a POST array */
51353
+ target?: string | undefined;
51354
+ /** traffic data relevant to the specified domain */
51355
+ metrics?: HistoricalMetricsBundleInfo | undefined;
51356
+ [key: string]: any;
51357
+ constructor(data?: IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveItem);
51358
+ init(_data?: any): void;
51359
+ static fromJS(data: any): DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveItem;
51360
+ toJSON(data?: any): any;
51361
+ }
51362
+ export interface IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveItem {
51363
+ /** search engine type */
51364
+ se_type?: string | undefined;
51365
+ /** target domain in a POST array */
51366
+ target?: string | undefined;
51367
+ /** traffic data relevant to the specified domain */
51368
+ metrics?: HistoricalMetricsBundleInfo | undefined;
51369
+ [key: string]: any;
51370
+ }
51371
+ export declare class DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResultInfo implements IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResultInfo {
51372
+ /** search engine type */
51373
+ se_type?: string | undefined;
51374
+ /** location code in a POST array
51375
+ if there is no data, then the value is null */
51376
+ location_code?: number | undefined;
51377
+ /** language code in a POST array
51378
+ if there is no data, then the value is null */
51379
+ language_code?: string | undefined;
51380
+ /** total amount of results in our database relevant to your request */
51381
+ total_count?: number | undefined;
51382
+ /** the number of results returned in the items array */
51383
+ items_count?: number | undefined;
51384
+ /** array of items with relevant traffic estimation data */
51385
+ items?: (DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveItem | undefined)[] | undefined;
51386
+ [key: string]: any;
51387
+ constructor(data?: IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResultInfo);
51388
+ init(_data?: any): void;
51389
+ static fromJS(data: any): DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResultInfo;
51390
+ toJSON(data?: any): any;
51391
+ }
51392
+ export interface IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResultInfo {
51393
+ /** search engine type */
51394
+ se_type?: string | undefined;
51395
+ /** location code in a POST array
51396
+ if there is no data, then the value is null */
51397
+ location_code?: number | undefined;
51398
+ /** language code in a POST array
51399
+ if there is no data, then the value is null */
51400
+ language_code?: string | undefined;
51401
+ /** total amount of results in our database relevant to your request */
51402
+ total_count?: number | undefined;
51403
+ /** the number of results returned in the items array */
51404
+ items_count?: number | undefined;
51405
+ /** array of items with relevant traffic estimation data */
51406
+ items?: (DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveItem | undefined)[] | undefined;
51407
+ [key: string]: any;
51408
+ }
51409
+ export declare class DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveTaskInfo {
51410
+ /** array of results */
51411
+ result?: (DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResultInfo | undefined)[] | undefined;
51412
+ [key: string]: any;
51413
+ constructor(data?: IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveTaskInfo);
51414
+ init(_data?: any): void;
51415
+ static fromJS(data: any): DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveTaskInfo;
51416
+ toJSON(data?: any): any;
51417
+ }
51418
+ export interface IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveTaskInfo extends IBaseResponseTaskInfo {
51419
+ /** array of results */
51420
+ result?: (DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResultInfo | undefined)[] | undefined;
51421
+ [key: string]: any;
51422
+ }
51423
+ export declare class DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResponseInfo extends BaseResponseInfo implements IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResponseInfo {
51424
+ /** array of tasks */
51425
+ tasks?: (DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveTaskInfo | undefined)[] | undefined;
51426
+ [key: string]: any;
51427
+ constructor(data?: IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResponseInfo);
51428
+ init(_data?: any): void;
51429
+ static fromJS(data: any): DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResponseInfo;
51430
+ toJSON(data?: any): any;
51431
+ }
51432
+ export interface IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResponseInfo extends IBaseResponseInfo {
51433
+ /** array of tasks */
51434
+ tasks?: (DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveTaskInfo | undefined)[] | undefined;
51435
+ [key: string]: any;
51436
+ }
51437
+ export declare class DataforseoLabsGoogleHistoricalKeywordDataLiveRequestInfo implements IDataforseoLabsGoogleHistoricalKeywordDataLiveRequestInfo {
51438
+ /** keywords
51439
+ required field
51440
+ The maximum number of keywords you can specify: 700
51441
+ The maximum number of characters for each keyword: 80
51442
+ The maximum number of words for each keyword phrase: 10
51443
+ the specified keywords will be converted to lowercase format, data will be provided in a separate array
51444
+ note that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn’t contain such keywords and cannot return data on them
51445
+ you will not be charged for the keywords omitted in the results
51446
+ learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
51447
+ keywords?: string[];
51448
+ /** full name of the location
51449
+ required field if you don’t specify location_code
51450
+ Note: it is required to specify either location_name or location_code
51451
+ you can receive the list of available locations with their location_name by making a separate request to the
51452
+ https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
51453
+ example:
51454
+ United Kingdom */
51455
+ location_name?: string | undefined;
51456
+ /** location code
51457
+ required field if you don’t specify location_name
51458
+ Note: it is required to specify either location_name or location_code
51459
+ you can receive the list of available locations with their location_code by making a separate request to the
51460
+ https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
51461
+ example:
51462
+ 2840 */
51463
+ location_code?: number | undefined;
51464
+ /** full name of the language
51465
+ required field if you don’t specify language_code
51466
+ Note: it is required to specify either language_name or language_code
51467
+ you can receive the list of available locations with their language_name by making a separate request to the
51468
+ https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
51469
+ example:
51470
+ English */
51471
+ language_name?: string | undefined;
51472
+ /** language code
51473
+ required field if you don’t specify language_name
51474
+ Note: it is required to specify either language_name or language_code
51475
+ you can receive the list of available locations with their language_code by making a separate request to the
51476
+ https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
51477
+ example:
51478
+ en */
51479
+ language_code?: string | undefined;
51480
+ /** user-defined task identifier
51481
+ optional field
51482
+ the character limit is 255
51483
+ you can use this parameter to identify the task and match it with the result
51484
+ you will find the specified tag value in the data object of the response */
51485
+ tag?: string | undefined;
51486
+ [key: string]: any;
51487
+ constructor(data?: IDataforseoLabsGoogleHistoricalKeywordDataLiveRequestInfo);
51488
+ init(_data?: any): void;
51489
+ static fromJS(data: any): DataforseoLabsGoogleHistoricalKeywordDataLiveRequestInfo;
51490
+ toJSON(data?: any): any;
51491
+ }
51492
+ export interface IDataforseoLabsGoogleHistoricalKeywordDataLiveRequestInfo {
51493
+ /** keywords
51494
+ required field
51495
+ The maximum number of keywords you can specify: 700
51496
+ The maximum number of characters for each keyword: 80
51497
+ The maximum number of words for each keyword phrase: 10
51498
+ the specified keywords will be converted to lowercase format, data will be provided in a separate array
51499
+ note that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn’t contain such keywords and cannot return data on them
51500
+ you will not be charged for the keywords omitted in the results
51501
+ learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
51502
+ keywords?: string[];
51503
+ /** full name of the location
51504
+ required field if you don’t specify location_code
51505
+ Note: it is required to specify either location_name or location_code
51506
+ you can receive the list of available locations with their location_name by making a separate request to the
51507
+ https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
51508
+ example:
51509
+ United Kingdom */
51510
+ location_name?: string | undefined;
51511
+ /** location code
51512
+ required field if you don’t specify location_name
51513
+ Note: it is required to specify either location_name or location_code
51514
+ you can receive the list of available locations with their location_code by making a separate request to the
51515
+ https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
51516
+ example:
51517
+ 2840 */
51518
+ location_code?: number | undefined;
51519
+ /** full name of the language
51520
+ required field if you don’t specify language_code
51521
+ Note: it is required to specify either language_name or language_code
51522
+ you can receive the list of available locations with their language_name by making a separate request to the
51523
+ https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
51524
+ example:
51525
+ English */
51526
+ language_name?: string | undefined;
51527
+ /** language code
51528
+ required field if you don’t specify language_name
51529
+ Note: it is required to specify either language_name or language_code
51530
+ you can receive the list of available locations with their language_code by making a separate request to the
51531
+ https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
51532
+ example:
51533
+ en */
51534
+ language_code?: string | undefined;
51535
+ /** user-defined task identifier
51536
+ optional field
51537
+ the character limit is 255
51538
+ you can use this parameter to identify the task and match it with the result
51539
+ you will find the specified tag value in the data object of the response */
51540
+ tag?: string | undefined;
51541
+ [key: string]: any;
51542
+ }
51543
+ export declare class History implements IHistory {
51544
+ /** year */
51545
+ year?: number | undefined;
51546
+ /** month */
51547
+ month?: number | undefined;
51548
+ /** historical data for the keyword */
51549
+ keyword_info?: KeywordInfo | undefined;
51550
+ [key: string]: any;
51551
+ constructor(data?: IHistory);
51552
+ init(_data?: any): void;
51553
+ static fromJS(data: any): History;
51554
+ toJSON(data?: any): any;
51555
+ }
51556
+ export interface IHistory {
51557
+ /** year */
51558
+ year?: number | undefined;
51559
+ /** month */
51560
+ month?: number | undefined;
51561
+ /** historical data for the keyword */
51562
+ keyword_info?: KeywordInfo | undefined;
51563
+ [key: string]: any;
51564
+ }
51565
+ export declare class DataforseoLabsGoogleHistoricalKeywordDataLiveItem implements IDataforseoLabsGoogleHistoricalKeywordDataLiveItem {
51566
+ /** search engine type */
51567
+ se_type?: string | undefined;
51568
+ /** keyword
51569
+ keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
51570
+ keyword?: string | undefined;
51571
+ /** location code in a POST array
51572
+ if there is no data, then the value is null */
51573
+ location_code?: number | undefined;
51574
+ /** language code in a POST array */
51575
+ language_code?: string | undefined;
51576
+ /** array of objects with historical data for the keyword */
51577
+ history?: (History | undefined)[] | undefined;
51578
+ [key: string]: any;
51579
+ constructor(data?: IDataforseoLabsGoogleHistoricalKeywordDataLiveItem);
51580
+ init(_data?: any): void;
51581
+ static fromJS(data: any): DataforseoLabsGoogleHistoricalKeywordDataLiveItem;
51582
+ toJSON(data?: any): any;
51583
+ }
51584
+ export interface IDataforseoLabsGoogleHistoricalKeywordDataLiveItem {
51585
+ /** search engine type */
51586
+ se_type?: string | undefined;
51587
+ /** keyword
51588
+ keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
51589
+ keyword?: string | undefined;
51590
+ /** location code in a POST array
51591
+ if there is no data, then the value is null */
51592
+ location_code?: number | undefined;
51593
+ /** language code in a POST array */
51594
+ language_code?: string | undefined;
51595
+ /** array of objects with historical data for the keyword */
51596
+ history?: (History | undefined)[] | undefined;
51597
+ [key: string]: any;
51598
+ }
51599
+ export declare class DataforseoLabsGoogleHistoricalKeywordDataLiveResultInfo implements IDataforseoLabsGoogleHistoricalKeywordDataLiveResultInfo {
51600
+ /** search engine type */
51601
+ se_type?: string | undefined;
51602
+ /** location code in a POST array */
51603
+ location_code?: number | undefined;
51604
+ /** language code in a POST array */
51605
+ language_code?: string | undefined;
51606
+ /** the number of results returned in the items array */
51607
+ items_count?: number | undefined;
51608
+ /** contains keywords and related data */
51609
+ items?: (DataforseoLabsGoogleHistoricalKeywordDataLiveItem | undefined)[] | undefined;
51610
+ [key: string]: any;
51611
+ constructor(data?: IDataforseoLabsGoogleHistoricalKeywordDataLiveResultInfo);
51612
+ init(_data?: any): void;
51613
+ static fromJS(data: any): DataforseoLabsGoogleHistoricalKeywordDataLiveResultInfo;
51614
+ toJSON(data?: any): any;
51615
+ }
51616
+ export interface IDataforseoLabsGoogleHistoricalKeywordDataLiveResultInfo {
51617
+ /** search engine type */
51618
+ se_type?: string | undefined;
51619
+ /** location code in a POST array */
51620
+ location_code?: number | undefined;
51621
+ /** language code in a POST array */
51622
+ language_code?: string | undefined;
51623
+ /** the number of results returned in the items array */
51624
+ items_count?: number | undefined;
51625
+ /** contains keywords and related data */
51626
+ items?: (DataforseoLabsGoogleHistoricalKeywordDataLiveItem | undefined)[] | undefined;
51627
+ [key: string]: any;
51628
+ }
51629
+ export declare class DataforseoLabsGoogleHistoricalKeywordDataLiveTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsGoogleHistoricalKeywordDataLiveTaskInfo {
51630
+ /** array of results */
51631
+ result?: (DataforseoLabsGoogleHistoricalKeywordDataLiveResultInfo | undefined)[] | undefined;
51632
+ [key: string]: any;
51633
+ constructor(data?: IDataforseoLabsGoogleHistoricalKeywordDataLiveTaskInfo);
51634
+ init(_data?: any): void;
51635
+ static fromJS(data: any): DataforseoLabsGoogleHistoricalKeywordDataLiveTaskInfo;
51636
+ toJSON(data?: any): any;
51637
+ }
51638
+ export interface IDataforseoLabsGoogleHistoricalKeywordDataLiveTaskInfo extends IBaseResponseTaskInfo {
51639
+ /** array of results */
51640
+ result?: (DataforseoLabsGoogleHistoricalKeywordDataLiveResultInfo | undefined)[] | undefined;
51641
+ [key: string]: any;
51642
+ }
51643
+ export declare class DataforseoLabsGoogleHistoricalKeywordDataLiveResponseInfo extends BaseResponseInfo implements IDataforseoLabsGoogleHistoricalKeywordDataLiveResponseInfo {
51644
+ /** array of tasks */
51645
+ tasks?: (DataforseoLabsGoogleHistoricalKeywordDataLiveTaskInfo | undefined)[] | undefined;
51646
+ [key: string]: any;
51647
+ constructor(data?: IDataforseoLabsGoogleHistoricalKeywordDataLiveResponseInfo);
51648
+ init(_data?: any): void;
51649
+ static fromJS(data: any): DataforseoLabsGoogleHistoricalKeywordDataLiveResponseInfo;
51650
+ toJSON(data?: any): any;
51651
+ }
51652
+ export interface IDataforseoLabsGoogleHistoricalKeywordDataLiveResponseInfo extends IBaseResponseInfo {
51653
+ /** array of tasks */
51654
+ tasks?: (DataforseoLabsGoogleHistoricalKeywordDataLiveTaskInfo | undefined)[] | undefined;
51655
+ [key: string]: any;
51656
+ }
51657
+ export declare class DataforseoLabsGoogleKeywordOverviewLiveRequestInfo implements IDataforseoLabsGoogleKeywordOverviewLiveRequestInfo {
51658
+ /** keywords
51659
+ required field
51660
+ The maximum number of keywords you can specify: 700
51661
+ The maximum number of characters for each keyword: 80
51662
+ The maximum number of words for each keyword phrase: 10
51663
+ the specified keywords will be converted to lowercase format, data will be provided in a separate array
51664
+ note that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn’t contain such keywords and cannot return data on them
51665
+ you will not be charged for the keywords omitted in the results
51666
+ learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
51667
+ keywords?: string[];
51668
+ /** full name of the location
51669
+ required field if you don’t specify location_code
51670
+ Note: it is required to specify either location_name or location_code
51671
+ you can receive the list of available locations with their location_name by making a separate request to the
51672
+ https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
51673
+ example:
51674
+ United Kingdom */
51675
+ location_name?: string | undefined;
51676
+ /** location code
51677
+ required field if you don’t specify location_name
51678
+ Note: it is required to specify either location_name or location_code
51679
+ you can receive the list of available locations with their location_code by making a separate request to the
51680
+ https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
51681
+ example:
51682
+ 2840 */
51683
+ location_code?: number | undefined;
51684
+ /** full name of the language
51685
+ required field if you don’t specify language_code
51686
+ Note: it is required to specify either language_name or language_code
51687
+ you can receive the list of available locations with their language_name by making a separate request to the
51688
+ https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
50563
51689
  example:
50564
51690
  English */
50565
51691
  language_name?: string | undefined;
50566
51692
  /** language code
50567
- if you use this field, you don’t need to specify language_name
50568
- you can receive the list of available languages with their language_code by making a separate request to the
51693
+ required field if you don’t specify language_name
51694
+ Note: it is required to specify either language_name or language_code
51695
+ you can receive the list of available locations with their language_code by making a separate request to the
50569
51696
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
50570
- ignore this field to get the results for all available languages
50571
51697
  example:
50572
51698
  en */
50573
51699
  language_code?: string | undefined;
50574
- /** starting date of the time range
50575
- optional field
50576
- if you don’t specify this field, the data will be provided for the previous 12 months
50577
- minimal possible value: 2020-10-01
50578
- date format: "yyyy-mm-dd" */
50579
- date_from?: string | undefined;
50580
- /** ending date of the time range
50581
- optional field
50582
- if you don’t specify this field, the today’s date will be used by default;
50583
- date format: "yyyy-mm-dd"
50584
- example:
50585
- "2021-04-01" */
50586
- date_to?: string | undefined;
50587
- /** ignore highly similar keywords
51700
+ /** include data from SERP for each keyword
50588
51701
  optional field
50589
- if set to true, only core keywords will be returned, all highly similar keywords will be excluded;
51702
+ if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
50590
51703
  default value: false */
50591
- ignore_synonyms?: boolean | undefined;
50592
- /** display results by item type
51704
+ include_serp_info?: boolean | undefined;
51705
+ /** include or exclude data from clickstream-based metrics in the result
50593
51706
  optional field
50594
- indicates the type of search results included in the response;
50595
- Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array;
50596
- possible values:
50597
- ["organic", "paid", "featured_snippet", "local_pack"]
50598
- default value:
50599
- ["organic", "paid"] */
50600
- item_types?: string[] | undefined;
51707
+ if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response
51708
+ default value: false
51709
+ with this parameter enabled, you will be charged double the price for the request
51710
+ learn more about how clickstream-based metrics are calculated in this help center article */
51711
+ include_clickstream_data?: boolean | undefined;
50601
51712
  /** user-defined task identifier
50602
51713
  optional field
50603
51714
  the character limit is 255
@@ -50605,77 +51716,66 @@ you can use this parameter to identify the task and match it with the result
50605
51716
  you will find the specified tag value in the data object of the response */
50606
51717
  tag?: string | undefined;
50607
51718
  [key: string]: any;
50608
- constructor(data?: IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveRequestInfo);
51719
+ constructor(data?: IDataforseoLabsGoogleKeywordOverviewLiveRequestInfo);
50609
51720
  init(_data?: any): void;
50610
- static fromJS(data: any): DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveRequestInfo;
51721
+ static fromJS(data: any): DataforseoLabsGoogleKeywordOverviewLiveRequestInfo;
50611
51722
  toJSON(data?: any): any;
50612
51723
  }
50613
- export interface IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveRequestInfo {
50614
- /** target domains and subdomains
51724
+ export interface IDataforseoLabsGoogleKeywordOverviewLiveRequestInfo {
51725
+ /** keywords
50615
51726
  required field
50616
- you can specify domains and subdomains in this field;
50617
- domains and subdomains should be specified without https:// and www.;
50618
- you can set up to 1000 domains or subdomains */
50619
- targets?: string[];
51727
+ The maximum number of keywords you can specify: 700
51728
+ The maximum number of characters for each keyword: 80
51729
+ The maximum number of words for each keyword phrase: 10
51730
+ the specified keywords will be converted to lowercase format, data will be provided in a separate array
51731
+ note that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn’t contain such keywords and cannot return data on them
51732
+ you will not be charged for the keywords omitted in the results
51733
+ learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
51734
+ keywords?: string[];
50620
51735
  /** full name of the location
50621
- if you use this field, you don’t have to specify location_code
51736
+ required field if you don’t specify location_code
51737
+ Note: it is required to specify either location_name or location_code
50622
51738
  you can receive the list of available locations with their location_name by making a separate request to the
50623
51739
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
50624
- ignore this field to get the results for all available locations
50625
51740
  example:
50626
51741
  United Kingdom */
50627
51742
  location_name?: string | undefined;
50628
51743
  /** location code
50629
- if you use this field, you don’t have to specify location_name
51744
+ required field if you don’t specify location_name
51745
+ Note: it is required to specify either location_name or location_code
50630
51746
  you can receive the list of available locations with their location_code by making a separate request to the
50631
51747
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
50632
- ignore this field to get the results for all available locations
50633
51748
  example:
50634
51749
  2840 */
50635
51750
  location_code?: number | undefined;
50636
51751
  /** full name of the language
50637
- if you use this field, you don’t need to specify language_code
50638
- you can receive the list of available languages with their language_name by making a separate request to the
51752
+ required field if you don’t specify language_code
51753
+ Note: it is required to specify either language_name or language_code
51754
+ you can receive the list of available locations with their language_name by making a separate request to the
50639
51755
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
50640
- ignore this field to get the results for all available languages
50641
51756
  example:
50642
51757
  English */
50643
51758
  language_name?: string | undefined;
50644
51759
  /** language code
50645
- if you use this field, you don’t need to specify language_name
50646
- you can receive the list of available languages with their language_code by making a separate request to the
51760
+ required field if you don’t specify language_name
51761
+ Note: it is required to specify either language_name or language_code
51762
+ you can receive the list of available locations with their language_code by making a separate request to the
50647
51763
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
50648
- ignore this field to get the results for all available languages
50649
51764
  example:
50650
51765
  en */
50651
51766
  language_code?: string | undefined;
50652
- /** starting date of the time range
50653
- optional field
50654
- if you don’t specify this field, the data will be provided for the previous 12 months
50655
- minimal possible value: 2020-10-01
50656
- date format: "yyyy-mm-dd" */
50657
- date_from?: string | undefined;
50658
- /** ending date of the time range
50659
- optional field
50660
- if you don’t specify this field, the today’s date will be used by default;
50661
- date format: "yyyy-mm-dd"
50662
- example:
50663
- "2021-04-01" */
50664
- date_to?: string | undefined;
50665
- /** ignore highly similar keywords
51767
+ /** include data from SERP for each keyword
50666
51768
  optional field
50667
- if set to true, only core keywords will be returned, all highly similar keywords will be excluded;
51769
+ if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
50668
51770
  default value: false */
50669
- ignore_synonyms?: boolean | undefined;
50670
- /** display results by item type
51771
+ include_serp_info?: boolean | undefined;
51772
+ /** include or exclude data from clickstream-based metrics in the result
50671
51773
  optional field
50672
- indicates the type of search results included in the response;
50673
- Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array;
50674
- possible values:
50675
- ["organic", "paid", "featured_snippet", "local_pack"]
50676
- default value:
50677
- ["organic", "paid"] */
50678
- item_types?: string[] | undefined;
51774
+ if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response
51775
+ default value: false
51776
+ with this parameter enabled, you will be charged double the price for the request
51777
+ learn more about how clickstream-based metrics are calculated in this help center article */
51778
+ include_clickstream_data?: boolean | undefined;
50679
51779
  /** user-defined task identifier
50680
51780
  optional field
50681
51781
  the character limit is 255
@@ -50684,160 +51784,140 @@ you will find the specified tag value in the data object of the response */
50684
51784
  tag?: string | undefined;
50685
51785
  [key: string]: any;
50686
51786
  }
50687
- export declare class HistoricalMetricsInfo implements IHistoricalMetricsInfo {
50688
- /** year for which the data is provided */
50689
- year?: number | undefined;
50690
- /** month for which the data is provided */
50691
- month?: number | undefined;
50692
- /** estimated traffic volume
50693
- estimated organic monthly traffic to the domain
50694
- calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain ranks for
50695
- learn more about how the metric is calculated in this help center article */
50696
- etv?: number | undefined;
50697
- /** total count of organic SERPs that contain the domain */
50698
- count?: number | undefined;
50699
- /** estimated traffic volume based on clickstream data
50700
- calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for
50701
- to retrieve results for this field, the parameter include_clickstream_data must be set to true
50702
- learn more about how the metric is calculated in this help center article https://dataforseo.com/help-center/whats-clickstream-estimated-traffic-volume-and-how-is-it-calculated */
50703
- clickstream_etv?: number | undefined;
50704
- [key: string]: any;
50705
- constructor(data?: IHistoricalMetricsInfo);
50706
- init(_data?: any): void;
50707
- static fromJS(data: any): HistoricalMetricsInfo;
50708
- toJSON(data?: any): any;
50709
- }
50710
- export interface IHistoricalMetricsInfo {
50711
- /** year for which the data is provided */
50712
- year?: number | undefined;
50713
- /** month for which the data is provided */
50714
- month?: number | undefined;
50715
- /** estimated traffic volume
50716
- estimated organic monthly traffic to the domain
50717
- calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain ranks for
50718
- learn more about how the metric is calculated in this help center article */
50719
- etv?: number | undefined;
50720
- /** total count of organic SERPs that contain the domain */
50721
- count?: number | undefined;
50722
- /** estimated traffic volume based on clickstream data
50723
- calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for
50724
- to retrieve results for this field, the parameter include_clickstream_data must be set to true
50725
- learn more about how the metric is calculated in this help center article https://dataforseo.com/help-center/whats-clickstream-estimated-traffic-volume-and-how-is-it-calculated */
50726
- clickstream_etv?: number | undefined;
50727
- [key: string]: any;
50728
- }
50729
- export declare class HistoricalMetricsBundleInfo implements IHistoricalMetricsBundleInfo {
50730
- /** traffic data from organic search */
50731
- organic?: (HistoricalMetricsInfo | undefined)[] | undefined;
50732
- /** traffic data from paid search */
50733
- paid?: (HistoricalMetricsInfo | undefined)[] | undefined;
50734
- /** traffic data from the featured snippet results in Google SERP */
50735
- local_pack?: (HistoricalMetricsInfo | undefined)[] | undefined;
50736
- /** traffic data from the local pack results in SERP */
50737
- featured_snippet?: (HistoricalMetricsInfo | undefined)[] | undefined;
50738
- [key: string]: any;
50739
- constructor(data?: IHistoricalMetricsBundleInfo);
50740
- init(_data?: any): void;
50741
- static fromJS(data: any): HistoricalMetricsBundleInfo;
50742
- toJSON(data?: any): any;
50743
- }
50744
- export interface IHistoricalMetricsBundleInfo {
50745
- /** traffic data from organic search */
50746
- organic?: (HistoricalMetricsInfo | undefined)[] | undefined;
50747
- /** traffic data from paid search */
50748
- paid?: (HistoricalMetricsInfo | undefined)[] | undefined;
50749
- /** traffic data from the featured snippet results in Google SERP */
50750
- local_pack?: (HistoricalMetricsInfo | undefined)[] | undefined;
50751
- /** traffic data from the local pack results in SERP */
50752
- featured_snippet?: (HistoricalMetricsInfo | undefined)[] | undefined;
50753
- [key: string]: any;
50754
- }
50755
- export declare class DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveItem implements IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveItem {
51787
+ export declare class DataforseoLabsGoogleKeywordOverviewLiveItem implements IDataforseoLabsGoogleKeywordOverviewLiveItem {
50756
51788
  /** search engine type */
50757
51789
  se_type?: string | undefined;
50758
- /** target domain in a POST array */
50759
- target?: string | undefined;
50760
- /** traffic data relevant to the specified domain */
50761
- metrics?: HistoricalMetricsBundleInfo | undefined;
51790
+ /** keyword
51791
+ keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
51792
+ keyword?: string | undefined;
51793
+ /** location code in a POST array
51794
+ if there is no data, then the value is null */
51795
+ location_code?: number | undefined;
51796
+ /** language code in a POST array */
51797
+ language_code?: string | undefined;
51798
+ /** indicates data for Google and partner sites
51799
+ if true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;
51800
+ if false, the results are returned for Google search sites only */
51801
+ search_partners?: boolean | undefined;
51802
+ /** keyword data for the returned keyword */
51803
+ keyword_info?: KeywordInfo | undefined;
51804
+ /** contains keyword search volume normalized with Bing search volume */
51805
+ keyword_info_normalized_with_bing?: KeywordInfoNormalizedWithInfo | undefined;
51806
+ /** contains keyword search volume normalized with clickstream data */
51807
+ keyword_info_normalized_with_clickstream?: KeywordInfoNormalizedWithInfo | undefined;
51808
+ /** clickstream data for the returned keyword
51809
+ to retrieve results for this field, the parameter include_clickstream_data must be set to true */
51810
+ clickstream_keyword_info?: ClickstreamKeywordInfo | undefined;
51811
+ /** additional information about the keyword */
51812
+ keyword_properties?: KeywordProperties | undefined;
51813
+ /** SERP data
51814
+ the value will be null if you didn’t set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database */
51815
+ serp_info?: SerpInfo | undefined;
51816
+ /** backlink data for the returned keyword
51817
+ this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 websites ranking organically for the keyword */
51818
+ avg_backlinks_info?: AvgBacklinksInfo | undefined;
51819
+ /** search intent info for the returned keyword
51820
+ learn about search intent in this help center article */
51821
+ search_intent_info?: SearchIntentInfo | undefined;
50762
51822
  [key: string]: any;
50763
- constructor(data?: IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveItem);
51823
+ constructor(data?: IDataforseoLabsGoogleKeywordOverviewLiveItem);
50764
51824
  init(_data?: any): void;
50765
- static fromJS(data: any): DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveItem;
51825
+ static fromJS(data: any): DataforseoLabsGoogleKeywordOverviewLiveItem;
50766
51826
  toJSON(data?: any): any;
50767
51827
  }
50768
- export interface IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveItem {
51828
+ export interface IDataforseoLabsGoogleKeywordOverviewLiveItem {
50769
51829
  /** search engine type */
50770
51830
  se_type?: string | undefined;
50771
- /** target domain in a POST array */
50772
- target?: string | undefined;
50773
- /** traffic data relevant to the specified domain */
50774
- metrics?: HistoricalMetricsBundleInfo | undefined;
51831
+ /** keyword
51832
+ keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
51833
+ keyword?: string | undefined;
51834
+ /** location code in a POST array
51835
+ if there is no data, then the value is null */
51836
+ location_code?: number | undefined;
51837
+ /** language code in a POST array */
51838
+ language_code?: string | undefined;
51839
+ /** indicates data for Google and partner sites
51840
+ if true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search;
51841
+ if false, the results are returned for Google search sites only */
51842
+ search_partners?: boolean | undefined;
51843
+ /** keyword data for the returned keyword */
51844
+ keyword_info?: KeywordInfo | undefined;
51845
+ /** contains keyword search volume normalized with Bing search volume */
51846
+ keyword_info_normalized_with_bing?: KeywordInfoNormalizedWithInfo | undefined;
51847
+ /** contains keyword search volume normalized with clickstream data */
51848
+ keyword_info_normalized_with_clickstream?: KeywordInfoNormalizedWithInfo | undefined;
51849
+ /** clickstream data for the returned keyword
51850
+ to retrieve results for this field, the parameter include_clickstream_data must be set to true */
51851
+ clickstream_keyword_info?: ClickstreamKeywordInfo | undefined;
51852
+ /** additional information about the keyword */
51853
+ keyword_properties?: KeywordProperties | undefined;
51854
+ /** SERP data
51855
+ the value will be null if you didn’t set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database */
51856
+ serp_info?: SerpInfo | undefined;
51857
+ /** backlink data for the returned keyword
51858
+ this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 websites ranking organically for the keyword */
51859
+ avg_backlinks_info?: AvgBacklinksInfo | undefined;
51860
+ /** search intent info for the returned keyword
51861
+ learn about search intent in this help center article */
51862
+ search_intent_info?: SearchIntentInfo | undefined;
50775
51863
  [key: string]: any;
50776
51864
  }
50777
- export declare class DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResultInfo implements IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResultInfo {
51865
+ export declare class DataforseoLabsGoogleKeywordOverviewLiveResultInfo implements IDataforseoLabsGoogleKeywordOverviewLiveResultInfo {
50778
51866
  /** search engine type */
50779
51867
  se_type?: string | undefined;
50780
- /** location code in a POST array
50781
- if there is no data, then the value is null */
51868
+ /** location code in a POST array */
50782
51869
  location_code?: number | undefined;
50783
- /** language code in a POST array
50784
- if there is no data, then the value is null */
51870
+ /** language code in a POST array */
50785
51871
  language_code?: string | undefined;
50786
- /** total amount of results in our database relevant to your request */
50787
- total_count?: number | undefined;
50788
51872
  /** the number of results returned in the items array */
50789
51873
  items_count?: number | undefined;
50790
- /** array of items with relevant traffic estimation data */
50791
- items?: (DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveItem | undefined)[] | undefined;
51874
+ /** contains keywords and related data */
51875
+ items?: (DataforseoLabsGoogleKeywordOverviewLiveItem | undefined)[] | undefined;
50792
51876
  [key: string]: any;
50793
- constructor(data?: IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResultInfo);
51877
+ constructor(data?: IDataforseoLabsGoogleKeywordOverviewLiveResultInfo);
50794
51878
  init(_data?: any): void;
50795
- static fromJS(data: any): DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResultInfo;
51879
+ static fromJS(data: any): DataforseoLabsGoogleKeywordOverviewLiveResultInfo;
50796
51880
  toJSON(data?: any): any;
50797
51881
  }
50798
- export interface IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResultInfo {
51882
+ export interface IDataforseoLabsGoogleKeywordOverviewLiveResultInfo {
50799
51883
  /** search engine type */
50800
51884
  se_type?: string | undefined;
50801
- /** location code in a POST array
50802
- if there is no data, then the value is null */
51885
+ /** location code in a POST array */
50803
51886
  location_code?: number | undefined;
50804
- /** language code in a POST array
50805
- if there is no data, then the value is null */
51887
+ /** language code in a POST array */
50806
51888
  language_code?: string | undefined;
50807
- /** total amount of results in our database relevant to your request */
50808
- total_count?: number | undefined;
50809
51889
  /** the number of results returned in the items array */
50810
51890
  items_count?: number | undefined;
50811
- /** array of items with relevant traffic estimation data */
50812
- items?: (DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveItem | undefined)[] | undefined;
51891
+ /** contains keywords and related data */
51892
+ items?: (DataforseoLabsGoogleKeywordOverviewLiveItem | undefined)[] | undefined;
50813
51893
  [key: string]: any;
50814
51894
  }
50815
- export declare class DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveTaskInfo {
51895
+ export declare class DataforseoLabsGoogleKeywordOverviewLiveTaskInfo extends BaseResponseTaskInfo implements IDataforseoLabsGoogleKeywordOverviewLiveTaskInfo {
50816
51896
  /** array of results */
50817
- result?: (DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResultInfo | undefined)[] | undefined;
51897
+ result?: (DataforseoLabsGoogleKeywordOverviewLiveResultInfo | undefined)[] | undefined;
50818
51898
  [key: string]: any;
50819
- constructor(data?: IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveTaskInfo);
51899
+ constructor(data?: IDataforseoLabsGoogleKeywordOverviewLiveTaskInfo);
50820
51900
  init(_data?: any): void;
50821
- static fromJS(data: any): DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveTaskInfo;
51901
+ static fromJS(data: any): DataforseoLabsGoogleKeywordOverviewLiveTaskInfo;
50822
51902
  toJSON(data?: any): any;
50823
51903
  }
50824
- export interface IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveTaskInfo extends IBaseResponseTaskInfo {
51904
+ export interface IDataforseoLabsGoogleKeywordOverviewLiveTaskInfo extends IBaseResponseTaskInfo {
50825
51905
  /** array of results */
50826
- result?: (DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResultInfo | undefined)[] | undefined;
51906
+ result?: (DataforseoLabsGoogleKeywordOverviewLiveResultInfo | undefined)[] | undefined;
50827
51907
  [key: string]: any;
50828
51908
  }
50829
- export declare class DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResponseInfo extends BaseResponseInfo implements IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResponseInfo {
51909
+ export declare class DataforseoLabsGoogleKeywordOverviewLiveResponseInfo extends BaseResponseInfo implements IDataforseoLabsGoogleKeywordOverviewLiveResponseInfo {
50830
51910
  /** array of tasks */
50831
- tasks?: (DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveTaskInfo | undefined)[] | undefined;
51911
+ tasks?: (DataforseoLabsGoogleKeywordOverviewLiveTaskInfo | undefined)[] | undefined;
50832
51912
  [key: string]: any;
50833
- constructor(data?: IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResponseInfo);
51913
+ constructor(data?: IDataforseoLabsGoogleKeywordOverviewLiveResponseInfo);
50834
51914
  init(_data?: any): void;
50835
- static fromJS(data: any): DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResponseInfo;
51915
+ static fromJS(data: any): DataforseoLabsGoogleKeywordOverviewLiveResponseInfo;
50836
51916
  toJSON(data?: any): any;
50837
51917
  }
50838
- export interface IDataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveResponseInfo extends IBaseResponseInfo {
51918
+ export interface IDataforseoLabsGoogleKeywordOverviewLiveResponseInfo extends IBaseResponseInfo {
50839
51919
  /** array of tasks */
50840
- tasks?: (DataforseoLabsGoogleHistoricalBulkTrafficEstimationLiveTaskInfo | undefined)[] | undefined;
51920
+ tasks?: (DataforseoLabsGoogleKeywordOverviewLiveTaskInfo | undefined)[] | undefined;
50841
51921
  [key: string]: any;
50842
51922
  }
50843
51923
  export declare class DataforseoLabsAmazonBulkSearchVolumeLiveRequestInfo implements IDataforseoLabsAmazonBulkSearchVolumeLiveRequestInfo {
@@ -62089,8 +63169,10 @@ export interface IKeywordsDataGoogleTrendsCategoriesResponseInfo extends IBaseRe
62089
63169
  export declare class KeywordsDataGoogleTrendsExploreTaskPostRequestInfo implements IKeywordsDataGoogleTrendsExploreTaskPostRequestInfo {
62090
63170
  /** keywords
62091
63171
  required field
62092
- The maximum number of keywords you can specify: 5
63172
+ the maximum number of keywords you can specify: 5
63173
+ the minimum number of symbols must be greater than 1
62093
63174
  comma characters (,) in the specified keywords will be unset and ignored
63175
+ Note: keywords cannot consist of a combination of the following characters: < > | \ " - + = ~ ! : * ( ) [ ] { }
62094
63176
  Note: to obtain google_trends_topics_list and google_trends_queries_list items, specify no more than 1 keyword
62095
63177
  learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
62096
63178
  keywords?: string[];
@@ -62207,8 +63289,10 @@ you will find the specified tag value in the data object of the response */
62207
63289
  export interface IKeywordsDataGoogleTrendsExploreTaskPostRequestInfo {
62208
63290
  /** keywords
62209
63291
  required field
62210
- The maximum number of keywords you can specify: 5
63292
+ the maximum number of keywords you can specify: 5
63293
+ the minimum number of symbols must be greater than 1
62211
63294
  comma characters (,) in the specified keywords will be unset and ignored
63295
+ Note: keywords cannot consist of a combination of the following characters: < > | \ " - + = ~ ! : * ( ) [ ] { }
62212
63296
  Note: to obtain google_trends_topics_list and google_trends_queries_list items, specify no more than 1 keyword
62213
63297
  learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
62214
63298
  keywords?: string[];
@@ -62676,9 +63760,11 @@ export declare class KeywordsDataGoogleTrendsExploreLiveRequestInfo implements I
62676
63760
  /** keywords
62677
63761
  required field
62678
63762
  if keywords are not specified, the results will not contain keyword-related data;
62679
- The maximum number of keywords you can specify: 5
62680
- comma characters (,) in the specified keywords will be unset and ignored;
62681
- Note: to obtain google_trends_topics_list and google_trends_queries_list items, specify no more than 1 keyword;
63763
+ the maximum number of keywords you can specify: 5
63764
+ the minimum number of symbols must be greater than 1
63765
+ comma characters (,) in the specified keywords will be unset and ignored
63766
+ Note: keywords cannot consist of a combination of the following characters: < > | \ " - + = ~ ! : * ( ) [ ] { }
63767
+ Note: to obtain google_trends_topics_list and google_trends_queries_list items, specify no more than 1 keyword
62682
63768
  learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
62683
63769
  keywords?: string[];
62684
63770
  /** full name of search engine location
@@ -62773,9 +63859,11 @@ export interface IKeywordsDataGoogleTrendsExploreLiveRequestInfo {
62773
63859
  /** keywords
62774
63860
  required field
62775
63861
  if keywords are not specified, the results will not contain keyword-related data;
62776
- The maximum number of keywords you can specify: 5
62777
- comma characters (,) in the specified keywords will be unset and ignored;
62778
- Note: to obtain google_trends_topics_list and google_trends_queries_list items, specify no more than 1 keyword;
63862
+ the maximum number of keywords you can specify: 5
63863
+ the minimum number of symbols must be greater than 1
63864
+ comma characters (,) in the specified keywords will be unset and ignored
63865
+ Note: keywords cannot consist of a combination of the following characters: < > | \ " - + = ~ ! : * ( ) [ ] { }
63866
+ Note: to obtain google_trends_topics_list and google_trends_queries_list items, specify no more than 1 keyword
62779
63867
  learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
62780
63868
  keywords?: string[];
62781
63869
  /** full name of search engine location
@@ -108066,16 +109154,16 @@ export interface IAppendixKeywordsDatasRatesDataInfo {
108066
109154
  keyword_suggestions_for_url?: AppendixInfo | undefined;
108067
109155
  [key: string]: any;
108068
109156
  }
108069
- export declare class AppendixAppendixsRatesDataInfo implements IAppendixAppendixsRatesDataInfo {
109157
+ export declare class AppendixAppendixDaysRatesDataInfo implements IAppendixAppendixDaysRatesDataInfo {
108070
109158
  user_data?: number | undefined;
108071
109159
  errors?: number | undefined;
108072
109160
  [key: string]: any;
108073
- constructor(data?: IAppendixAppendixsRatesDataInfo);
109161
+ constructor(data?: IAppendixAppendixDaysRatesDataInfo);
108074
109162
  init(_data?: any): void;
108075
- static fromJS(data: any): AppendixAppendixsRatesDataInfo;
109163
+ static fromJS(data: any): AppendixAppendixDaysRatesDataInfo;
108076
109164
  toJSON(data?: any): any;
108077
109165
  }
108078
- export interface IAppendixAppendixsRatesDataInfo {
109166
+ export interface IAppendixAppendixDaysRatesDataInfo {
108079
109167
  user_data?: number | undefined;
108080
109168
  errors?: number | undefined;
108081
109169
  [key: string]: any;
@@ -108102,7 +109190,6 @@ export declare class AppendixDataforseoLabsLimitsRatesDataInfo implements IAppen
108102
109190
  keywords_for_site?: AppendixInfo | undefined;
108103
109191
  keyword_suggestions?: AppendixInfo | undefined;
108104
109192
  keyword_ideas?: AppendixInfo | undefined;
108105
- historical_search_volume?: AppendixInfo | undefined;
108106
109193
  categories_for_domain?: AppendixInfo | undefined;
108107
109194
  domain_metrics_by_categories?: AppendixInfo | undefined;
108108
109195
  top_searches?: AppendixInfo | undefined;
@@ -108117,6 +109204,8 @@ export declare class AppendixDataforseoLabsLimitsRatesDataInfo implements IAppen
108117
109204
  search_intent?: AppendixInfo | undefined;
108118
109205
  historical_bulk_traffic_estimation?: AppendixInfo | undefined;
108119
109206
  categories_for_keywords?: AppendixInfo | undefined;
109207
+ keyword_overview?: AppendixInfo | undefined;
109208
+ historical_keyword_data?: AppendixInfo | undefined;
108120
109209
  [key: string]: any;
108121
109210
  constructor(data?: IAppendixDataforseoLabsLimitsRatesDataInfo);
108122
109211
  init(_data?: any): void;
@@ -108145,7 +109234,6 @@ export interface IAppendixDataforseoLabsLimitsRatesDataInfo {
108145
109234
  keywords_for_site?: AppendixInfo | undefined;
108146
109235
  keyword_suggestions?: AppendixInfo | undefined;
108147
109236
  keyword_ideas?: AppendixInfo | undefined;
108148
- historical_search_volume?: AppendixInfo | undefined;
108149
109237
  categories_for_domain?: AppendixInfo | undefined;
108150
109238
  domain_metrics_by_categories?: AppendixInfo | undefined;
108151
109239
  top_searches?: AppendixInfo | undefined;
@@ -108160,6 +109248,8 @@ export interface IAppendixDataforseoLabsLimitsRatesDataInfo {
108160
109248
  search_intent?: AppendixInfo | undefined;
108161
109249
  historical_bulk_traffic_estimation?: AppendixInfo | undefined;
108162
109250
  categories_for_keywords?: AppendixInfo | undefined;
109251
+ keyword_overview?: AppendixInfo | undefined;
109252
+ historical_keyword_data?: AppendixInfo | undefined;
108163
109253
  [key: string]: any;
108164
109254
  }
108165
109255
  export declare class AppendixWhoisDomainAnalyticsLimitsRatesDataInfo implements IAppendixWhoisDomainAnalyticsLimitsRatesDataInfo {
@@ -108607,7 +109697,7 @@ export declare class AppendixDayLimitsRatesData implements IAppendixDayLimitsRat
108607
109697
  total_serp?: number | undefined;
108608
109698
  keywords_data?: AppendixKeywordsDatasRatesDataInfo | undefined;
108609
109699
  total_keywords_data?: number | undefined;
108610
- appendix?: AppendixAppendixsRatesDataInfo | undefined;
109700
+ appendix?: AppendixAppendixDaysRatesDataInfo | undefined;
108611
109701
  total_appendix?: number | undefined;
108612
109702
  dataforseo_labs?: AppendixDataforseoLabsLimitsRatesDataInfo | undefined;
108613
109703
  total_dataforseo_labs?: number | undefined;
@@ -108643,7 +109733,7 @@ export interface IAppendixDayLimitsRatesData {
108643
109733
  total_serp?: number | undefined;
108644
109734
  keywords_data?: AppendixKeywordsDatasRatesDataInfo | undefined;
108645
109735
  total_keywords_data?: number | undefined;
108646
- appendix?: AppendixAppendixsRatesDataInfo | undefined;
109736
+ appendix?: AppendixAppendixDaysRatesDataInfo | undefined;
108647
109737
  total_appendix?: number | undefined;
108648
109738
  dataforseo_labs?: AppendixDataforseoLabsLimitsRatesDataInfo | undefined;
108649
109739
  total_dataforseo_labs?: number | undefined;
@@ -108917,11 +110007,11 @@ export declare class AppendixKeywordsDataDayStatisticsRatesData implements IAppe
108917
110007
  clickstream_data?: AppendixClickstreamDataKeywordsDataLimitsRatesDataInfo | undefined;
108918
110008
  audience_estimation?: AppendixInfo | undefined;
108919
110009
  keyword_suggestions_for_url?: AppendixInfo | undefined;
108920
- job_functions?: number | undefined;
108921
110010
  search_volume_history?: AppendixInfo | undefined;
108922
110011
  industries?: number | undefined;
108923
- google?: AppendixBingKeywordsDataLimitsRatesDataInfo | undefined;
110012
+ job_functions?: number | undefined;
108924
110013
  id_list?: number | undefined;
110014
+ google?: AppendixBingKeywordsDataLimitsRatesDataInfo | undefined;
108925
110015
  [key: string]: any;
108926
110016
  constructor(data?: IAppendixKeywordsDataDayStatisticsRatesData);
108927
110017
  init(_data?: any): void;
@@ -108947,29 +110037,11 @@ export interface IAppendixKeywordsDataDayStatisticsRatesData {
108947
110037
  clickstream_data?: AppendixClickstreamDataKeywordsDataLimitsRatesDataInfo | undefined;
108948
110038
  audience_estimation?: AppendixInfo | undefined;
108949
110039
  keyword_suggestions_for_url?: AppendixInfo | undefined;
108950
- job_functions?: number | undefined;
108951
110040
  search_volume_history?: AppendixInfo | undefined;
108952
110041
  industries?: number | undefined;
108953
- google?: AppendixBingKeywordsDataLimitsRatesDataInfo | undefined;
110042
+ job_functions?: number | undefined;
108954
110043
  id_list?: number | undefined;
108955
- [key: string]: any;
108956
- }
108957
- export declare class AppendixAppendixDayStatisticsRatesData implements IAppendixAppendixDayStatisticsRatesData {
108958
- user_data?: number | undefined;
108959
- errors?: number | undefined;
108960
- status?: number | undefined;
108961
- webhook_resend?: number | undefined;
108962
- [key: string]: any;
108963
- constructor(data?: IAppendixAppendixDayStatisticsRatesData);
108964
- init(_data?: any): void;
108965
- static fromJS(data: any): AppendixAppendixDayStatisticsRatesData;
108966
- toJSON(data?: any): any;
108967
- }
108968
- export interface IAppendixAppendixDayStatisticsRatesData {
108969
- user_data?: number | undefined;
108970
- errors?: number | undefined;
108971
- status?: number | undefined;
108972
- webhook_resend?: number | undefined;
110044
+ google?: AppendixBingKeywordsDataLimitsRatesDataInfo | undefined;
108973
110045
  [key: string]: any;
108974
110046
  }
108975
110047
  export declare class AppendixDataforseoLabsDayStatisticsRatesData implements IAppendixDataforseoLabsDayStatisticsRatesData {
@@ -108994,7 +110066,6 @@ export declare class AppendixDataforseoLabsDayStatisticsRatesData implements IAp
108994
110066
  keywords_for_site?: AppendixInfo | undefined;
108995
110067
  keyword_suggestions?: AppendixInfo | undefined;
108996
110068
  keyword_ideas?: AppendixInfo | undefined;
108997
- historical_search_volume?: AppendixInfo | undefined;
108998
110069
  categories_for_domain?: AppendixInfo | undefined;
108999
110070
  domain_metrics_by_categories?: AppendixInfo | undefined;
109000
110071
  top_searches?: AppendixInfo | undefined;
@@ -109009,13 +110080,16 @@ export declare class AppendixDataforseoLabsDayStatisticsRatesData implements IAp
109009
110080
  search_intent?: AppendixInfo | undefined;
109010
110081
  historical_bulk_traffic_estimation?: AppendixInfo | undefined;
109011
110082
  categories_for_keywords?: AppendixInfo | undefined;
109012
- amazon?: AppendixDataforseoLabsLimitsRatesDataInfo | undefined;
110083
+ keyword_overview?: AppendixInfo | undefined;
110084
+ historical_keyword_data?: AppendixInfo | undefined;
110085
+ id_list?: number | undefined;
110086
+ historical_search_volume?: AppendixInfo | undefined;
110087
+ available_filters?: number | undefined;
110088
+ available_history?: number | undefined;
109013
110089
  languages?: number | undefined;
109014
110090
  top_google_searches?: AppendixInfo | undefined;
110091
+ amazon?: AppendixDataforseoLabsLimitsRatesDataInfo | undefined;
109015
110092
  status?: number | undefined;
109016
- available_history?: number | undefined;
109017
- id_list?: number | undefined;
109018
- available_filters?: number | undefined;
109019
110093
  [key: string]: any;
109020
110094
  constructor(data?: IAppendixDataforseoLabsDayStatisticsRatesData);
109021
110095
  init(_data?: any): void;
@@ -109044,7 +110118,6 @@ export interface IAppendixDataforseoLabsDayStatisticsRatesData {
109044
110118
  keywords_for_site?: AppendixInfo | undefined;
109045
110119
  keyword_suggestions?: AppendixInfo | undefined;
109046
110120
  keyword_ideas?: AppendixInfo | undefined;
109047
- historical_search_volume?: AppendixInfo | undefined;
109048
110121
  categories_for_domain?: AppendixInfo | undefined;
109049
110122
  domain_metrics_by_categories?: AppendixInfo | undefined;
109050
110123
  top_searches?: AppendixInfo | undefined;
@@ -109059,13 +110132,16 @@ export interface IAppendixDataforseoLabsDayStatisticsRatesData {
109059
110132
  search_intent?: AppendixInfo | undefined;
109060
110133
  historical_bulk_traffic_estimation?: AppendixInfo | undefined;
109061
110134
  categories_for_keywords?: AppendixInfo | undefined;
109062
- amazon?: AppendixDataforseoLabsLimitsRatesDataInfo | undefined;
110135
+ keyword_overview?: AppendixInfo | undefined;
110136
+ historical_keyword_data?: AppendixInfo | undefined;
110137
+ id_list?: number | undefined;
110138
+ historical_search_volume?: AppendixInfo | undefined;
110139
+ available_filters?: number | undefined;
110140
+ available_history?: number | undefined;
109063
110141
  languages?: number | undefined;
109064
110142
  top_google_searches?: AppendixInfo | undefined;
110143
+ amazon?: AppendixDataforseoLabsLimitsRatesDataInfo | undefined;
109065
110144
  status?: number | undefined;
109066
- available_history?: number | undefined;
109067
- id_list?: number | undefined;
109068
- available_filters?: number | undefined;
109069
110145
  [key: string]: any;
109070
110146
  }
109071
110147
  export declare class AppendixDomainAnalyticsDayStatisticsRatesData implements IAppendixDomainAnalyticsDayStatisticsRatesData {
@@ -109121,9 +110197,9 @@ export declare class AppendixLighthouseOnPageDayStatisticsRatesData implements I
109121
110197
  tasks_ready?: number | undefined;
109122
110198
  task_get?: number | undefined;
109123
110199
  live?: number | undefined;
110200
+ audits?: number | undefined;
109124
110201
  versions?: number | undefined;
109125
110202
  languages?: number | undefined;
109126
- audits?: number | undefined;
109127
110203
  [key: string]: any;
109128
110204
  constructor(data?: IAppendixLighthouseOnPageDayStatisticsRatesData);
109129
110205
  init(_data?: any): void;
@@ -109135,9 +110211,9 @@ export interface IAppendixLighthouseOnPageDayStatisticsRatesData {
109135
110211
  tasks_ready?: number | undefined;
109136
110212
  task_get?: number | undefined;
109137
110213
  live?: number | undefined;
110214
+ audits?: number | undefined;
109138
110215
  versions?: number | undefined;
109139
110216
  languages?: number | undefined;
109140
- audits?: number | undefined;
109141
110217
  [key: string]: any;
109142
110218
  }
109143
110219
  export declare class AppendixOnPageDayStatisticsRatesData implements IAppendixOnPageDayStatisticsRatesData {
@@ -109161,10 +110237,10 @@ export declare class AppendixOnPageDayStatisticsRatesData implements IAppendixOn
109161
110237
  page_screenshot?: number | undefined;
109162
110238
  content_parsing?: number | undefined;
109163
110239
  content_parsing_live?: number | undefined;
110240
+ microdata?: number | undefined;
110241
+ id_list?: number | undefined;
109164
110242
  force_stop?: number | undefined;
109165
110243
  available_filters?: number | undefined;
109166
- id_list?: number | undefined;
109167
- microdata?: number | undefined;
109168
110244
  [key: string]: any;
109169
110245
  constructor(data?: IAppendixOnPageDayStatisticsRatesData);
109170
110246
  init(_data?: any): void;
@@ -109192,10 +110268,10 @@ export interface IAppendixOnPageDayStatisticsRatesData {
109192
110268
  page_screenshot?: number | undefined;
109193
110269
  content_parsing?: number | undefined;
109194
110270
  content_parsing_live?: number | undefined;
110271
+ microdata?: number | undefined;
110272
+ id_list?: number | undefined;
109195
110273
  force_stop?: number | undefined;
109196
110274
  available_filters?: number | undefined;
109197
- id_list?: number | undefined;
109198
- microdata?: number | undefined;
109199
110275
  [key: string]: any;
109200
110276
  }
109201
110277
  export declare class AppendixBusinessDataDayStatisticsRatesData implements IAppendixBusinessDataDayStatisticsRatesData {
@@ -109255,11 +110331,11 @@ export declare class AppendixBacklinksDayStatisticsRatesData implements IAppendi
109255
110331
  competitors?: AppendixInfo | undefined;
109256
110332
  bulk_spam_score?: AppendixInfo | undefined;
109257
110333
  bulk_pages_summary?: AppendixInfo | undefined;
109258
- index?: number | undefined;
110334
+ historical_new_lost_summary?: AppendixInfo | undefined;
109259
110335
  pages_summary_with_page_info?: AppendixInfo | undefined;
110336
+ index?: number | undefined;
109260
110337
  id_list?: number | undefined;
109261
110338
  available_filters?: number | undefined;
109262
- historical_new_lost_summary?: AppendixInfo | undefined;
109263
110339
  [key: string]: any;
109264
110340
  constructor(data?: IAppendixBacklinksDayStatisticsRatesData);
109265
110341
  init(_data?: any): void;
@@ -109289,11 +110365,11 @@ export interface IAppendixBacklinksDayStatisticsRatesData {
109289
110365
  competitors?: AppendixInfo | undefined;
109290
110366
  bulk_spam_score?: AppendixInfo | undefined;
109291
110367
  bulk_pages_summary?: AppendixInfo | undefined;
109292
- index?: number | undefined;
110368
+ historical_new_lost_summary?: AppendixInfo | undefined;
109293
110369
  pages_summary_with_page_info?: AppendixInfo | undefined;
110370
+ index?: number | undefined;
109294
110371
  id_list?: number | undefined;
109295
110372
  available_filters?: number | undefined;
109296
- historical_new_lost_summary?: AppendixInfo | undefined;
109297
110373
  [key: string]: any;
109298
110374
  }
109299
110375
  export declare class AppendixAppDataDayStatisticsRatesData implements IAppendixAppDataDayStatisticsRatesData {
@@ -109339,8 +110415,8 @@ export declare class AppendixContentAnalysisDayStatisticsRatesData implements IA
109339
110415
  languages?: number | undefined;
109340
110416
  categories?: number | undefined;
109341
110417
  errors?: number | undefined;
109342
- available_filters?: number | undefined;
109343
110418
  id_list?: number | undefined;
110419
+ available_filters?: number | undefined;
109344
110420
  [key: string]: any;
109345
110421
  constructor(data?: IAppendixContentAnalysisDayStatisticsRatesData);
109346
110422
  init(_data?: any): void;
@@ -109358,8 +110434,8 @@ export interface IAppendixContentAnalysisDayStatisticsRatesData {
109358
110434
  languages?: number | undefined;
109359
110435
  categories?: number | undefined;
109360
110436
  errors?: number | undefined;
109361
- available_filters?: number | undefined;
109362
110437
  id_list?: number | undefined;
110438
+ available_filters?: number | undefined;
109363
110439
  [key: string]: any;
109364
110440
  }
109365
110441
  export declare class AppendixContentGenerationDayStatisticsRatesData implements IAppendixContentGenerationDayStatisticsRatesData {
@@ -109395,7 +110471,7 @@ export declare class AppendixDayStatisticsRatesData implements IAppendixDayStati
109395
110471
  total_serp?: number | undefined;
109396
110472
  keywords_data?: AppendixKeywordsDataDayStatisticsRatesData | undefined;
109397
110473
  total_keywords_data?: number | undefined;
109398
- appendix?: AppendixAppendixDayStatisticsRatesData | undefined;
110474
+ appendix?: AppendixAppendixDaysRatesDataInfo | undefined;
109399
110475
  total_appendix?: number | undefined;
109400
110476
  dataforseo_labs?: AppendixDataforseoLabsDayStatisticsRatesData | undefined;
109401
110477
  total_dataforseo_labs?: number | undefined;
@@ -109435,7 +110511,7 @@ export interface IAppendixDayStatisticsRatesData {
109435
110511
  total_serp?: number | undefined;
109436
110512
  keywords_data?: AppendixKeywordsDataDayStatisticsRatesData | undefined;
109437
110513
  total_keywords_data?: number | undefined;
109438
- appendix?: AppendixAppendixDayStatisticsRatesData | undefined;
110514
+ appendix?: AppendixAppendixDaysRatesDataInfo | undefined;
109439
110515
  total_appendix?: number | undefined;
109440
110516
  dataforseo_labs?: AppendixDataforseoLabsDayStatisticsRatesData | undefined;
109441
110517
  total_dataforseo_labs?: number | undefined;
@@ -109471,7 +110547,7 @@ export declare class AppendixMinuteStatisticsDataInfo implements IAppendixMinute
109471
110547
  total_serp?: number | undefined;
109472
110548
  keywords_data?: AppendixKeywordsDatasRatesDataInfo | undefined;
109473
110549
  total_keywords_data?: number | undefined;
109474
- appendix?: AppendixAppendixsRatesDataInfo | undefined;
110550
+ appendix?: AppendixAppendixDaysRatesDataInfo | undefined;
109475
110551
  total_appendix?: number | undefined;
109476
110552
  dataforseo_labs?: AppendixDataforseoLabsLimitsRatesDataInfo | undefined;
109477
110553
  total_dataforseo_labs?: number | undefined;
@@ -109508,7 +110584,7 @@ export interface IAppendixMinuteStatisticsDataInfo {
109508
110584
  total_serp?: number | undefined;
109509
110585
  keywords_data?: AppendixKeywordsDatasRatesDataInfo | undefined;
109510
110586
  total_keywords_data?: number | undefined;
109511
- appendix?: AppendixAppendixsRatesDataInfo | undefined;
110587
+ appendix?: AppendixAppendixDaysRatesDataInfo | undefined;
109512
110588
  total_appendix?: number | undefined;
109513
110589
  dataforseo_labs?: AppendixDataforseoLabsLimitsRatesDataInfo | undefined;
109514
110590
  total_dataforseo_labs?: number | undefined;
@@ -109580,40 +110656,6 @@ export interface IAppendixLimitsMoneyData {
109580
110656
  minute?: AppendixDataInfo | undefined;
109581
110657
  [key: string]: any;
109582
110658
  }
109583
- export declare class AppendixSerpDayStatisticsMoneyData implements IAppendixSerpDayStatisticsMoneyData {
109584
- task_post?: number | undefined;
109585
- task_get?: AppendixFunctionTypeInfo | undefined;
109586
- tasks_ready?: number | undefined;
109587
- locations?: number | undefined;
109588
- languages?: number | undefined;
109589
- live?: AppendixFunctionTypeInfo | undefined;
109590
- errors?: number | undefined;
109591
- tasks_fixed?: number | undefined;
109592
- jobs?: AppendixJobsSerpLimitsRatesDataInfo | undefined;
109593
- screenshot?: number | undefined;
109594
- ai_summary?: number | undefined;
109595
- refund_money?: number | undefined;
109596
- [key: string]: any;
109597
- constructor(data?: IAppendixSerpDayStatisticsMoneyData);
109598
- init(_data?: any): void;
109599
- static fromJS(data: any): AppendixSerpDayStatisticsMoneyData;
109600
- toJSON(data?: any): any;
109601
- }
109602
- export interface IAppendixSerpDayStatisticsMoneyData {
109603
- task_post?: number | undefined;
109604
- task_get?: AppendixFunctionTypeInfo | undefined;
109605
- tasks_ready?: number | undefined;
109606
- locations?: number | undefined;
109607
- languages?: number | undefined;
109608
- live?: AppendixFunctionTypeInfo | undefined;
109609
- errors?: number | undefined;
109610
- tasks_fixed?: number | undefined;
109611
- jobs?: AppendixJobsSerpLimitsRatesDataInfo | undefined;
109612
- screenshot?: number | undefined;
109613
- ai_summary?: number | undefined;
109614
- refund_money?: number | undefined;
109615
- [key: string]: any;
109616
- }
109617
110659
  export declare class AppendixKeywordsDataDayStatisticsMoneyData implements IAppendixKeywordsDataDayStatisticsMoneyData {
109618
110660
  keywords_for_keywords?: AppendixInfo | undefined;
109619
110661
  keywords_for_site?: AppendixInfo | undefined;
@@ -109633,8 +110675,8 @@ export declare class AppendixKeywordsDataDayStatisticsMoneyData implements IAppe
109633
110675
  clickstream_data?: AppendixClickstreamDataKeywordsDataLimitsRatesDataInfo | undefined;
109634
110676
  audience_estimation?: AppendixInfo | undefined;
109635
110677
  keyword_suggestions_for_url?: AppendixInfo | undefined;
109636
- search_volume_history?: AppendixJobsSerpLimitsRatesDataInfo | undefined;
109637
110678
  google?: AppendixBingKeywordsDataLimitsRatesDataInfo | undefined;
110679
+ search_volume_history?: AppendixJobsSerpLimitsRatesDataInfo | undefined;
109638
110680
  [key: string]: any;
109639
110681
  constructor(data?: IAppendixKeywordsDataDayStatisticsMoneyData);
109640
110682
  init(_data?: any): void;
@@ -109660,134 +110702,18 @@ export interface IAppendixKeywordsDataDayStatisticsMoneyData {
109660
110702
  clickstream_data?: AppendixClickstreamDataKeywordsDataLimitsRatesDataInfo | undefined;
109661
110703
  audience_estimation?: AppendixInfo | undefined;
109662
110704
  keyword_suggestions_for_url?: AppendixInfo | undefined;
109663
- search_volume_history?: AppendixJobsSerpLimitsRatesDataInfo | undefined;
109664
110705
  google?: AppendixBingKeywordsDataLimitsRatesDataInfo | undefined;
109665
- [key: string]: any;
109666
- }
109667
- export declare class AppendixOnPageDayStatisticsMoneyData implements IAppendixOnPageDayStatisticsMoneyData {
109668
- task_post?: number | undefined;
109669
- tasks_ready?: number | undefined;
109670
- summary?: number | undefined;
109671
- resources?: number | undefined;
109672
- pages?: number | undefined;
109673
- non_indexable?: number | undefined;
109674
- duplicate_tags?: number | undefined;
109675
- links?: number | undefined;
109676
- waterfall?: number | undefined;
109677
- errors?: number | undefined;
109678
- pages_by_resource?: number | undefined;
109679
- duplicate_content?: number | undefined;
109680
- raw_html?: number | undefined;
109681
- instant_pages?: number | undefined;
109682
- redirect_chains?: number | undefined;
109683
- lighthouse?: AppendixInfo | undefined;
109684
- keyword_density?: number | undefined;
109685
- page_screenshot?: number | undefined;
109686
- content_parsing?: number | undefined;
109687
- content_parsing_live?: number | undefined;
109688
- refund_money?: number | undefined;
109689
- [key: string]: any;
109690
- constructor(data?: IAppendixOnPageDayStatisticsMoneyData);
109691
- init(_data?: any): void;
109692
- static fromJS(data: any): AppendixOnPageDayStatisticsMoneyData;
109693
- toJSON(data?: any): any;
109694
- }
109695
- export interface IAppendixOnPageDayStatisticsMoneyData {
109696
- task_post?: number | undefined;
109697
- tasks_ready?: number | undefined;
109698
- summary?: number | undefined;
109699
- resources?: number | undefined;
109700
- pages?: number | undefined;
109701
- non_indexable?: number | undefined;
109702
- duplicate_tags?: number | undefined;
109703
- links?: number | undefined;
109704
- waterfall?: number | undefined;
109705
- errors?: number | undefined;
109706
- pages_by_resource?: number | undefined;
109707
- duplicate_content?: number | undefined;
109708
- raw_html?: number | undefined;
109709
- instant_pages?: number | undefined;
109710
- redirect_chains?: number | undefined;
109711
- lighthouse?: AppendixInfo | undefined;
109712
- keyword_density?: number | undefined;
109713
- page_screenshot?: number | undefined;
109714
- content_parsing?: number | undefined;
109715
- content_parsing_live?: number | undefined;
109716
- refund_money?: number | undefined;
109717
- [key: string]: any;
109718
- }
109719
- export declare class AppendixBusinessDataDayStatisticsMoneyData implements IAppendixBusinessDataDayStatisticsMoneyData {
109720
- google?: AppendixBusinessDataGoogleInfo | undefined;
109721
- locations?: number | undefined;
109722
- languages?: number | undefined;
109723
- errors?: number | undefined;
109724
- yelp?: AppendixBusinessDataDayLimitsRatesDataInfo | undefined;
109725
- social_media?: AppendixSocialMediaBusinessDataLimitsRatesDataInfo | undefined;
109726
- tripadvisor?: AppendixBusinessDataDayLimitsRatesDataInfo | undefined;
109727
- trustpilot?: AppendixBusinessDataDayLimitsRatesDataInfo | undefined;
109728
- business_listings?: AppendixBusinessListingsBusinessDataLimitsRatesDataInfo | undefined;
109729
- tasks_ready?: number | undefined;
109730
- refund_money?: number | undefined;
109731
- [key: string]: any;
109732
- constructor(data?: IAppendixBusinessDataDayStatisticsMoneyData);
109733
- init(_data?: any): void;
109734
- static fromJS(data: any): AppendixBusinessDataDayStatisticsMoneyData;
109735
- toJSON(data?: any): any;
109736
- }
109737
- export interface IAppendixBusinessDataDayStatisticsMoneyData {
109738
- google?: AppendixBusinessDataGoogleInfo | undefined;
109739
- locations?: number | undefined;
109740
- languages?: number | undefined;
109741
- errors?: number | undefined;
109742
- yelp?: AppendixBusinessDataDayLimitsRatesDataInfo | undefined;
109743
- social_media?: AppendixSocialMediaBusinessDataLimitsRatesDataInfo | undefined;
109744
- tripadvisor?: AppendixBusinessDataDayLimitsRatesDataInfo | undefined;
109745
- trustpilot?: AppendixBusinessDataDayLimitsRatesDataInfo | undefined;
109746
- business_listings?: AppendixBusinessListingsBusinessDataLimitsRatesDataInfo | undefined;
109747
- tasks_ready?: number | undefined;
109748
- refund_money?: number | undefined;
109749
- [key: string]: any;
109750
- }
109751
- export declare class AppendixAppDataDayStatisticsMoneyData implements IAppendixAppDataDayStatisticsMoneyData {
109752
- app_info?: AppendixSerpLimitsRatesDataInfo | undefined;
109753
- app_list?: AppendixSerpLimitsRatesDataInfo | undefined;
109754
- app_reviews?: AppendixSerpLimitsRatesDataInfo | undefined;
109755
- app_searches?: AppendixSerpLimitsRatesDataInfo | undefined;
109756
- errors?: number | undefined;
109757
- languages?: number | undefined;
109758
- locations?: number | undefined;
109759
- categories?: number | undefined;
109760
- app_listings?: AppendixBusinessListingsBusinessDataLimitsRatesDataInfo | undefined;
109761
- tasks_ready?: number | undefined;
109762
- refund_money?: number | undefined;
109763
- [key: string]: any;
109764
- constructor(data?: IAppendixAppDataDayStatisticsMoneyData);
109765
- init(_data?: any): void;
109766
- static fromJS(data: any): AppendixAppDataDayStatisticsMoneyData;
109767
- toJSON(data?: any): any;
109768
- }
109769
- export interface IAppendixAppDataDayStatisticsMoneyData {
109770
- app_info?: AppendixSerpLimitsRatesDataInfo | undefined;
109771
- app_list?: AppendixSerpLimitsRatesDataInfo | undefined;
109772
- app_reviews?: AppendixSerpLimitsRatesDataInfo | undefined;
109773
- app_searches?: AppendixSerpLimitsRatesDataInfo | undefined;
109774
- errors?: number | undefined;
109775
- languages?: number | undefined;
109776
- locations?: number | undefined;
109777
- categories?: number | undefined;
109778
- app_listings?: AppendixBusinessListingsBusinessDataLimitsRatesDataInfo | undefined;
109779
- tasks_ready?: number | undefined;
109780
- refund_money?: number | undefined;
110706
+ search_volume_history?: AppendixJobsSerpLimitsRatesDataInfo | undefined;
109781
110707
  [key: string]: any;
109782
110708
  }
109783
110709
  export declare class AppendixDayStatisticsMoneyData implements IAppendixDayStatisticsMoneyData {
109784
- serp?: AppendixSerpDayStatisticsMoneyData | undefined;
110710
+ serp?: AppendixSerpDayStatisticsRatesData | undefined;
109785
110711
  /** total amount of money deposited to your account */
109786
110712
  total?: number | undefined;
109787
110713
  total_serp?: number | undefined;
109788
110714
  keywords_data?: AppendixKeywordsDataDayStatisticsMoneyData | undefined;
109789
110715
  total_keywords_data?: number | undefined;
109790
- appendix?: AppendixAppendixsRatesDataInfo | undefined;
110716
+ appendix?: AppendixAppendixDaysRatesDataInfo | undefined;
109791
110717
  total_appendix?: number | undefined;
109792
110718
  dataforseo_labs?: AppendixDataforseoLabsDayStatisticsRatesData | undefined;
109793
110719
  total_dataforseo_labs?: number | undefined;
@@ -109795,13 +110721,13 @@ export declare class AppendixDayStatisticsMoneyData implements IAppendixDayStati
109795
110721
  total_domain_analytics?: number | undefined;
109796
110722
  merchant?: AppendixMerchantLimitsRatesDataInfo | undefined;
109797
110723
  total_merchant?: number | undefined;
109798
- on_page?: AppendixOnPageDayStatisticsMoneyData | undefined;
110724
+ on_page?: AppendixOnPageLimitsRatesDataInfo | undefined;
109799
110725
  total_on_page?: number | undefined;
109800
- business_data?: AppendixBusinessDataDayStatisticsMoneyData | undefined;
110726
+ business_data?: AppendixBusinessDataLimitsRatesDataInfo | undefined;
109801
110727
  total_business_data?: number | undefined;
109802
110728
  backlinks?: AppendixBacklinksDayStatisticsRatesData | undefined;
109803
110729
  total_backlinks?: number | undefined;
109804
- app_data?: AppendixAppDataDayStatisticsMoneyData | undefined;
110730
+ app_data?: AppendixAppDataLimitsRatesDataInfo | undefined;
109805
110731
  total_app_data?: number | undefined;
109806
110732
  content_analysis?: AppendixContentAnalysisLimitsRatesDataInfo | undefined;
109807
110733
  total_content_analysis?: number | undefined;
@@ -109821,13 +110747,13 @@ minute in the yyyy-MM-dd HH:mm format */
109821
110747
  toJSON(data?: any): any;
109822
110748
  }
109823
110749
  export interface IAppendixDayStatisticsMoneyData {
109824
- serp?: AppendixSerpDayStatisticsMoneyData | undefined;
110750
+ serp?: AppendixSerpDayStatisticsRatesData | undefined;
109825
110751
  /** total amount of money deposited to your account */
109826
110752
  total?: number | undefined;
109827
110753
  total_serp?: number | undefined;
109828
110754
  keywords_data?: AppendixKeywordsDataDayStatisticsMoneyData | undefined;
109829
110755
  total_keywords_data?: number | undefined;
109830
- appendix?: AppendixAppendixsRatesDataInfo | undefined;
110756
+ appendix?: AppendixAppendixDaysRatesDataInfo | undefined;
109831
110757
  total_appendix?: number | undefined;
109832
110758
  dataforseo_labs?: AppendixDataforseoLabsDayStatisticsRatesData | undefined;
109833
110759
  total_dataforseo_labs?: number | undefined;
@@ -109835,13 +110761,13 @@ export interface IAppendixDayStatisticsMoneyData {
109835
110761
  total_domain_analytics?: number | undefined;
109836
110762
  merchant?: AppendixMerchantLimitsRatesDataInfo | undefined;
109837
110763
  total_merchant?: number | undefined;
109838
- on_page?: AppendixOnPageDayStatisticsMoneyData | undefined;
110764
+ on_page?: AppendixOnPageLimitsRatesDataInfo | undefined;
109839
110765
  total_on_page?: number | undefined;
109840
- business_data?: AppendixBusinessDataDayStatisticsMoneyData | undefined;
110766
+ business_data?: AppendixBusinessDataLimitsRatesDataInfo | undefined;
109841
110767
  total_business_data?: number | undefined;
109842
110768
  backlinks?: AppendixBacklinksDayStatisticsRatesData | undefined;
109843
110769
  total_backlinks?: number | undefined;
109844
- app_data?: AppendixAppDataDayStatisticsMoneyData | undefined;
110770
+ app_data?: AppendixAppDataLimitsRatesDataInfo | undefined;
109845
110771
  total_app_data?: number | undefined;
109846
110772
  content_analysis?: AppendixContentAnalysisLimitsRatesDataInfo | undefined;
109847
110773
  total_content_analysis?: number | undefined;
@@ -110238,8 +111164,8 @@ export interface IAppendixMerchantPriceData {
110238
111164
  }
110239
111165
  export declare class AppendixSerpPriceDataInfo implements IAppendixSerpPriceDataInfo {
110240
111166
  regular?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
110241
- html?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
110242
111167
  advanced?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
111168
+ html?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
110243
111169
  [key: string]: any;
110244
111170
  constructor(data?: IAppendixSerpPriceDataInfo);
110245
111171
  init(_data?: any): void;
@@ -110248,8 +111174,8 @@ export declare class AppendixSerpPriceDataInfo implements IAppendixSerpPriceData
110248
111174
  }
110249
111175
  export interface IAppendixSerpPriceDataInfo {
110250
111176
  regular?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
110251
- html?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
110252
111177
  advanced?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
111178
+ html?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
110253
111179
  [key: string]: any;
110254
111180
  }
110255
111181
  export declare class AppendixSerpPriceData implements IAppendixSerpPriceData {
@@ -110617,10 +111543,11 @@ export declare class AppendixDataforseoLabsPriceData implements IAppendixDatafor
110617
111543
  domain_whois_overview?: AppendixBingKeywordsDataPriceDataInfo | undefined;
110618
111544
  errors?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
110619
111545
  historical_bulk_traffic_estimation?: AppendixBingKeywordsDataPriceDataInfo | undefined;
111546
+ historical_keyword_data?: AppendixBingKeywordsDataPriceDataInfo | undefined;
110620
111547
  historical_rank_overview?: AppendixBingKeywordsDataPriceDataInfo | undefined;
110621
- historical_search_volume?: AppendixBingKeywordsDataPriceDataInfo | undefined;
110622
111548
  historical_serps?: AppendixBingKeywordsDataPriceDataInfo | undefined;
110623
111549
  keyword_ideas?: AppendixBingKeywordsDataPriceDataInfo | undefined;
111550
+ keyword_overview?: AppendixBingKeywordsDataPriceDataInfo | undefined;
110624
111551
  keywords_for_app?: AppendixBingKeywordsDataPriceDataInfo | undefined;
110625
111552
  keywords_for_categories?: AppendixBingKeywordsDataPriceDataInfo | undefined;
110626
111553
  keywords_for_site?: AppendixBingKeywordsDataPriceDataInfo | undefined;
@@ -110660,10 +111587,11 @@ export interface IAppendixDataforseoLabsPriceData {
110660
111587
  domain_whois_overview?: AppendixBingKeywordsDataPriceDataInfo | undefined;
110661
111588
  errors?: AppendixTaskKeywordsDataPriceDataInfo | undefined;
110662
111589
  historical_bulk_traffic_estimation?: AppendixBingKeywordsDataPriceDataInfo | undefined;
111590
+ historical_keyword_data?: AppendixBingKeywordsDataPriceDataInfo | undefined;
110663
111591
  historical_rank_overview?: AppendixBingKeywordsDataPriceDataInfo | undefined;
110664
- historical_search_volume?: AppendixBingKeywordsDataPriceDataInfo | undefined;
110665
111592
  historical_serps?: AppendixBingKeywordsDataPriceDataInfo | undefined;
110666
111593
  keyword_ideas?: AppendixBingKeywordsDataPriceDataInfo | undefined;
111594
+ keyword_overview?: AppendixBingKeywordsDataPriceDataInfo | undefined;
110667
111595
  keywords_for_app?: AppendixBingKeywordsDataPriceDataInfo | undefined;
110668
111596
  keywords_for_categories?: AppendixBingKeywordsDataPriceDataInfo | undefined;
110669
111597
  keywords_for_site?: AppendixBingKeywordsDataPriceDataInfo | undefined;