semrush-api-client 0.1.16 → 0.1.18

package/dist/backlinks/backlinksOverview.d.ts

@@ -6,4 +6,4 @@ export declare function getBacklinksOverview(this: SemrushAPIClient, { target, t
     target_type?: BacklinksTargetType;
     export_columns?: BacklinkstExportColumns[];
     outputObj?: boolean;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;

package/dist/backlinks/getAnchors.d.ts

@@ -9,4 +9,4 @@ export declare function getAnchors(this: SemrushAPIClient, { target, target_type
     displaySort?: DisplaySort;
     outputObj?: boolean;
     display_limit?: number;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;

package/dist/backlinks/getBacklinks.d.ts

@@ -9,4 +9,4 @@ export declare function getBacklinks(this: SemrushAPIClient, { target, target_ty
     displaySort?: DisplaySort;
     outputObj?: boolean;
     display_limit?: number;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;

package/dist/backlinks/getIndexedPages.d.ts

@@ -9,4 +9,4 @@ export declare function getIndexedPages(this: SemrushAPIClient, { target, target
     displaySort?: DisplaySort;
     outputObj?: boolean;
     display_limit?: number;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;

package/dist/backlinks/getReferringDomains.d.ts

@@ -9,4 +9,4 @@ export declare function getReferringDomains(this: SemrushAPIClient, { target, ta
     displaySort?: DisplaySort;
     outputObj?: boolean;
     display_limit?: number;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;

package/dist/client/index.d.ts

@@ -14,6 +14,7 @@ import { getIndexedPages } from "../backlinks/getIndexedPages";
 import { getReferringDomains } from "../backlinks/getReferringDomains";
 import { getRelatedKeywords } from "../keyword/getRelatedKeywords";
 import { getPhraseQuestions } from "../keyword/getPhraseQuestions";
+import { getBroadMatchKeywords } from "../keyword/getBroadMatchKeywords";
 export declare class SemrushAPIClient {
     private client;
     private api_key;
@@ -40,4 +41,5 @@ export declare class SemrushAPIClient {
     getReferringDomains: typeof getReferringDomains;
     getRelatedKeywords: typeof getRelatedKeywords;
     getPhraseQuestions: typeof getPhraseQuestions;
+    getBroadMatchKeywords: typeof getBroadMatchKeywords;
 }

package/dist/client/index.js

@@ -21,6 +21,7 @@ const getIndexedPages_1 = require("../backlinks/getIndexedPages");
 const getReferringDomains_1 = require("../backlinks/getReferringDomains");
 const getRelatedKeywords_1 = require("../keyword/getRelatedKeywords");
 const getPhraseQuestions_1 = require("../keyword/getPhraseQuestions");
+const getBroadMatchKeywords_1 = require("../keyword/getBroadMatchKeywords");
 class SemrushAPIClient {
     client;
     api_key;
@@ -82,5 +83,6 @@ class SemrushAPIClient {
     getReferringDomains = getReferringDomains_1.getReferringDomains;
     getRelatedKeywords = getRelatedKeywords_1.getRelatedKeywords;
     getPhraseQuestions = getPhraseQuestions_1.getPhraseQuestions;
+    getBroadMatchKeywords = getBroadMatchKeywords_1.getBroadMatchKeywords;
 }
 exports.SemrushAPIClient = SemrushAPIClient;

package/dist/domain/getAdsCopies.d.ts

@@ -7,5 +7,5 @@ export declare function getAdsCopies(this: SemrushAPIClient, { domain, export_co
     database?: Database;
     outputObj?: boolean;
     display_limit?: number;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;
 export {};

package/dist/domain/getDomainOrganicSearchKeywords.d.ts

@@ -11,5 +11,5 @@ export declare function getDomainOrganicSearchKeywords(this: SemrushAPIClient, {
     outputObj?: boolean;
     displayPositionsType?: displayPositionType;
     display_limit?: number;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;
 export {};

package/dist/domain/getDomainOverview.d.ts

@@ -8,4 +8,4 @@ export declare function getDomainOverview(this: SemrushAPIClient, { domain, expo
     display_limit?: number;
     outputObj?: boolean;
     displayDate?: string;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;

package/dist/domain/getDomainPaidSearchKeywords.d.ts

@@ -9,5 +9,5 @@ export declare function getDomainPaidSearchKeywords(this: SemrushAPIClient, { do
     database?: Database;
     outputObj?: boolean;
     display_limit?: number;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;
 export {};

package/dist/keyword/getBroadMatchKeywords.d.ts

@@ -0,0 +1,12 @@
+import { SemrushAPIClient } from "../client";
+import { Database } from "../type/general/database";
+export type ExportColumns = "Ph" | "Nq" | "Cp" | "Co" | "Nr" | "Td" | "Fk" | "In" | "Kd";
+export type DisplaySort = "nq_asc" | "nq_desc" | "cp_asc" | "cp_desc" | "co_asc" | "co_desc" | "nr_asc" | "nr_desc" | "kd_asc" | "kd_desc";
+export declare function getBroadMatchKeywords(this: SemrushAPIClient, { phrase, export_columns, database, displaySort, display_limit, outputObj, }: {
+    phrase: string;
+    database?: Database;
+    export_columns?: ExportColumns[];
+    displaySort?: DisplaySort;
+    outputObj?: boolean;
+    display_limit?: number;
+}): Promise<Record<string, string>[]>;

package/dist/keyword/getBroadMatchKeywords.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBroadMatchKeywords = getBroadMatchKeywords;
+async function getBroadMatchKeywords({ phrase, export_columns = ["Ph", "Nq", "Cp", "Co", "Nr", "Td", "In", "Kd"], database = "us", displaySort = "nq_desc", display_limit = 1000, outputObj = true, }) {
+    const params = {
+        type: "phrase_fullsearch",
+        phrase,
+        database,
+        display_sort: displaySort,
+        display_limit,
+        export_columns: export_columns.join(","),
+    };
+    return this.get(this.ANALYTICS_URL, params, outputObj);
+}

package/dist/keyword/getKeywordDifficulty.d.ts

@@ -6,5 +6,5 @@ export declare function getKeywordDifficulty(this: SemrushAPIClient, { phrases,
     export_columns?: ExportColumns[];
     database?: Database;
     outputObj?: boolean;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;
 export {};

package/dist/keyword/getKeywordOverview.d.ts

@@ -6,5 +6,5 @@ export declare function getKeywordOverview(this: SemrushAPIClient, { phrase, exp
     export_columns?: KeywordExportColumns[];
     database?: Database;
     outputObj?: boolean;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;
 export {};

package/dist/keyword/getPhraseQuestions.d.ts

@@ -1,6 +1,5 @@
 import { SemrushAPIClient } from "../client";
 import { Database } from "../type/general/database";
-export type IndexedPagephraseType = "root_domain" | "domain" | "url";
 export type ExportColumns = "Ph" | "Nq" | "Cp" | "Co" | "Nr" | "Td" | "In" | "Kd";
 export type DisplaySort = "nq_asc" | "nq_desc" | "cp_asc" | "cp_desc" | "co_asc" | "co_desc" | "nr_asc" | "nr_desc" | "kd_asc" | "kd_desc";
 export declare function getPhraseQuestions(this: SemrushAPIClient, { phrase, export_columns, database, displaySort, display_limit, outputObj, }: {
@@ -10,4 +9,4 @@ export declare function getPhraseQuestions(this: SemrushAPIClient, { phrase, exp
     displaySort?: DisplaySort;
     outputObj?: boolean;
     display_limit?: number;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;

package/dist/keyword/getRelatedKeywords.d.ts

@@ -1,6 +1,5 @@
 import { SemrushAPIClient } from "../client";
 import { Database } from "../type/general/database";
-export type IndexedPagephraseType = "root_domain" | "domain" | "url";
 export type ExportColumns = "Ph" | "Nq" | "Cp" | "Co" | "Nr" | "Td" | "Rr" | "Fk" | "In" | "Kd";
 export type DisplaySort = "nq_asc" | "nq_desc" | "cp_asc" | "cp_desc" | "co_asc" | "co_desc" | "nr_asc" | "nr_desc" | "rr_asc" | "rr_desc" | "kd_asc" | "kd_desc";
 export declare function getRelatedKeywords(this: SemrushAPIClient, { phrase, export_columns, database, displaySort, display_limit, outputObj, }: {
@@ -10,4 +9,4 @@ export declare function getRelatedKeywords(this: SemrushAPIClient, { phrase, exp
     displaySort?: DisplaySort;
     outputObj?: boolean;
     display_limit?: number;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;

package/dist/overview/getRankDifference.d.ts

@@ -7,5 +7,5 @@ export declare function getRankDifference(this: SemrushAPIClient, { domain, expo
     database?: Database;
     display_limit?: number;
     outputObj?: boolean;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;
 export {};

package/dist/overview/getSemrushRank.d.ts

@@ -6,5 +6,5 @@ export declare function getSemrushRank(this: SemrushAPIClient, { export_columns,
     database?: Database;
     display_limit?: number;
     outputObj?: boolean;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;
 export {};

package/dist/trend/getTrafficSummary.d.ts

@@ -6,4 +6,4 @@ export declare function getTrafficSummary(this: SemrushAPIClient, { domains, exp
     export_columns?: ExportColumns[];
     country?: Country;
     outputObj?: boolean;
-}): Promise<string | Record<string, string>[]>;
+}): Promise<Record<string, string>[]>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "semrush-api-client",
-  "version": "0.1.16",
+  "version": "0.1.18",
   "description": "",
   "license": "Apache-2.0",
   "main": "dist/index.js",