semrush-api-client 0.1.15 → 0.1.17

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.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getAdsCopies = getAdsCopies;
-async function getAdsCopies({ domain, export_columns = ["Tt", "Ds", "Vu", "Ur", "Pc", "Un"], database, display_limit = 1000, outputObj = true, }) {
+async function getAdsCopies({ domain, export_columns = ["Tt", "Ds", "Vu", "Ur", "Pc", "Un"], database = "us", display_limit = 1000, outputObj = true, }) {
     const params = {
         type: "domain_adwords_unique",
         export_columns: export_columns.join(","),

package/dist/domain/getDomainOrganicSearchKeywords.js

@@ -14,7 +14,7 @@ async function getDomainOrganicSearchKeywords({ domain, export_columns = [
     "Co",
     "Nr",
     "Td",
-], database, displayPosition, displayPositionsType, display_limit = 1000, outputObj = true, }) {
+], database = "us", displayPosition, displayPositionsType, display_limit = 1000, outputObj = true, }) {
     const params = {
         type: "domain_organic",
         export_columns: export_columns.join(","),

package/dist/domain/getDomainOverview.d.ts

@@ -1,10 +1,11 @@
 import { SemrushAPIClient } from "../client";
 import { Database } from "../type/general/database";
 import { ExportColumns } from "../type/general/exportColumns";
-export declare function getDomainOverview(this: SemrushAPIClient, { domain, export_columns, database, display_limit, outputObj, }: {
+export declare function getDomainOverview(this: SemrushAPIClient, { domain, export_columns, database, displayDate, display_limit, outputObj, }: {
     domain: string;
     export_columns?: ExportColumns[];
     database?: Database;
     display_limit?: number;
     outputObj?: boolean;
+    displayDate?: string;
 }): Promise<string | Record<string, string>[]>;

package/dist/domain/getDomainOverview.js

@@ -23,12 +23,13 @@ async function getDomainOverview({ domain, export_columns = [
     "Sc",
     "Srn",
     "Srl",
-], database, display_limit = 1000, outputObj = true, }) {
+], database = "us", displayDate, display_limit = 1000, outputObj = true, }) {
     const params = {
         type: "domain_ranks",
         export_columns: export_columns.join(","),
         domain,
         database,
+        displayDate: displayDate,
         display_limit,
     };
     return this.get(this.BASE_URL, params, outputObj);

package/dist/domain/getDomainPaidSearchKeywords.js

@@ -14,7 +14,7 @@ async function getDomainPaidSearchKeywords({ domain, export_columns = [
     "Co",
     "Nr",
     "Td",
-], database, displayPosition, display_limit = 1000, outputObj = true, }) {
+], database = "us", displayPosition, display_limit = 1000, outputObj = true, }) {
     const params = {
         type: "domain_adwords",
         export_columns: export_columns.join(","),

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<string | 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/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, }: {

package/dist/keyword/getPhraseQuestions.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPhraseQuestions = getPhraseQuestions;
-async function getPhraseQuestions({ phrase, export_columns = ["Ph", "Nq", "Cp", "Co", "Nr", "Td", "In", "Kd"], database, displaySort = "nq_desc", display_limit = 1000, outputObj = true, }) {
+async function getPhraseQuestions({ 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_questions",
         phrase,

package/dist/keyword/getRelatedKeywords.js

@@ -12,7 +12,7 @@ async function getRelatedKeywords({ phrase, export_columns = [
     "Fk",
     "In",
     "Kd",
-], database, displaySort = "nq_desc", display_limit = 1000, outputObj = true, }) {
+], database = "us", displaySort = "nq_desc", display_limit = 1000, outputObj = true, }) {
     const params = {
         type: "phrase_related",
         phrase,

package/dist/overview/getRankDifference.js

@@ -12,7 +12,7 @@ async function getRankDifference({ domain, export_columns = [
     "At",
     "Ac",
     "Sh",
-], database, display_limit = 1000, outputObj = true, }) {
+], database = "us", display_limit = 1000, outputObj = true, }) {
     const params = {
         type: "rank_difference",
         export_columns: export_columns.join(","),

package/dist/overview/getSemrushRank.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getSemrushRank = getSemrushRank;
-async function getSemrushRank({ export_columns = ["Dn", "Rk", "Or", "Ot", "Oc", "Ad", "At", "Ac"], database, display_limit = 1000, outputObj = true, }) {
+async function getSemrushRank({ export_columns = ["Dn", "Rk", "Or", "Ot", "Oc", "Ad", "At", "Ac"], database = "us", display_limit = 1000, outputObj = true, }) {
     const params = {
         type: "rank",
         export_columns: export_columns.join(","),

package/package.json

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