semrush-api-client 1.0.6 → 1.0.11

package/dist/client/index.d.ts

@@ -1,5 +1,5 @@
-import { getDomainOverview, getDomainOrganicSearchKeywords, getDomainPaidSearchKeywords, getAdsCopies } from "../domain";
-import { getKeywordOverview, getKeywordDifficulty, getRelatedKeywords, getPhraseQuestions, getBroadMatchKeywords, getKeywordOrganic } from "../keyword";
+import { getDomainOverview, getDomainOverviewOneDatabase, getDomainOverviewHistory, getDomainOrganicSearchKeywords, getDomainPaidSearchKeywords, getAdsCopies } from "../domain";
+import { getKeywordOverview, getKeywordDifficulty, getRelatedKeywords, getPhraseQuestions, getBroadMatchKeywords, getKeywordOrganic, getBatchKeywordOverview, getKeywordPaidResults, getKeywordAdsHistory } from "../keyword";
 import { getBacklinksOverview, getBacklinks, getAnchors, getIndexedPages, getReferringDomains } from "../backlinks";
 import { getRankDifference, getSemrushRank } from "../overview";
 import { getTrafficSummary } from "../trend";
@@ -16,6 +16,8 @@ export declare class SemrushAPIClient {
     parseCsvToObjects(csvString: string, delimiter?: string): Record<string, string>[];
     get<T>(url: string, params?: Record<string, any>, outputObj?: boolean): Promise<T>;
     getDomainOverview: typeof getDomainOverview;
+    getDomainOverviewOneDatabase: typeof getDomainOverviewOneDatabase;
+    getDomainOverviewHistory: typeof getDomainOverviewHistory;
     getDomainOrganicSearchKeywords: typeof getDomainOrganicSearchKeywords;
     getDomainPaidSearchKeywords: typeof getDomainPaidSearchKeywords;
     getAdsCopies: typeof getAdsCopies;
@@ -25,6 +27,9 @@ export declare class SemrushAPIClient {
     getPhraseQuestions: typeof getPhraseQuestions;
     getBroadMatchKeywords: typeof getBroadMatchKeywords;
     getKeywordOrganic: typeof getKeywordOrganic;
+    getBatchKeywordOverview: typeof getBatchKeywordOverview;
+    getKeywordPaidResults: typeof getKeywordPaidResults;
+    getKeywordAdsHistory: typeof getKeywordAdsHistory;
     getBacklinksOverview: typeof getBacklinksOverview;
     getBacklinks: typeof getBacklinks;
     getAnchors: typeof getAnchors;

package/dist/client/index.js

@@ -59,6 +59,8 @@ class SemrushAPIClient {
     }
     // Domain methods
     getDomainOverview = domain_1.getDomainOverview;
+    getDomainOverviewOneDatabase = domain_1.getDomainOverviewOneDatabase;
+    getDomainOverviewHistory = domain_1.getDomainOverviewHistory;
     getDomainOrganicSearchKeywords = domain_1.getDomainOrganicSearchKeywords;
     getDomainPaidSearchKeywords = domain_1.getDomainPaidSearchKeywords;
     getAdsCopies = domain_1.getAdsCopies;
@@ -69,6 +71,9 @@ class SemrushAPIClient {
     getPhraseQuestions = keyword_1.getPhraseQuestions;
     getBroadMatchKeywords = keyword_1.getBroadMatchKeywords;
     getKeywordOrganic = keyword_1.getKeywordOrganic;
+    getBatchKeywordOverview = keyword_1.getBatchKeywordOverview;
+    getKeywordPaidResults = keyword_1.getKeywordPaidResults;
+    getKeywordAdsHistory = keyword_1.getKeywordAdsHistory;
     // Backlinks methods
     getBacklinksOverview = backlinks_1.getBacklinksOverview;
     getBacklinks = backlinks_1.getBacklinks;

package/dist/domain/getDomainOverview.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDomainOverview = getDomainOverview;
 const displayDateValidator_1 = require("../utils/displayDateValidator");
+// Domain Overview (all databases) — type=domain_ranks.
+// "database" is optional here; when omitted the request is sent to all
+// regional databases.
 async function getDomainOverview({ domain, exportColumns = [
     "Db",
     "Dt",
@@ -24,7 +27,7 @@ async function getDomainOverview({ domain, exportColumns = [
     "Sc",
     "Srn",
     "Srl",
-], database = "us", displayDate, displayLimit = 10, displayOffset, displaySort, exportEscape, outputObj = true, }) {
+], database, displayDate, displayLimit = 10, displayOffset, displaySort, exportEscape, outputObj = true, }) {
     if (displayDate && !(0, displayDateValidator_1.displayDateValidator)(displayDate)) {
         throw new Error("Invalid displayDate format. Format: YYYYMM15");
     }

package/dist/domain/getDomainOverviewHistory.d.ts

@@ -0,0 +1,15 @@
+import { SemrushAPIClient } from "../client";
+import { Database } from "../type/general/database";
+import { ExportColumns } from "../type/general/exportColumns";
+export type DomainOverviewHistoryDisplaySort = "dt_asc" | "dt_desc";
+export declare function getDomainOverviewHistory(this: SemrushAPIClient, { domain, exportColumns, database, displayLimit, displayOffset, displaySort, displayDaily, exportEscape, outputObj, }: {
+    domain: string;
+    exportColumns?: ExportColumns[];
+    database?: Database;
+    displayLimit?: number;
+    displayOffset?: number;
+    displaySort?: DomainOverviewHistoryDisplaySort;
+    displayDaily?: 1;
+    exportEscape?: 1;
+    outputObj?: boolean;
+}): Promise<Record<string, string>[]>;

package/dist/domain/getDomainOverviewHistory.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDomainOverviewHistory = getDomainOverviewHistory;
+// Domain Overview (history) — type=domain_rank_history. "database" is required.
+async function getDomainOverviewHistory({ domain, exportColumns = [
+    "Rk",
+    "Or",
+    "Ot",
+    "Oc",
+    "Ad",
+    "At",
+    "Ac",
+    "Dt",
+    "FKn",
+    "FPn",
+    "Sr",
+    "Srb",
+    "St",
+    "Stb",
+    "Sc",
+], database = "us", displayLimit = 10, displayOffset, displaySort, displayDaily, exportEscape, outputObj = true, }) {
+    const params = {
+        type: "domain_rank_history",
+        export_columns: exportColumns.join(","),
+        domain,
+        database,
+        display_limit: displayLimit,
+        display_offset: displayOffset,
+        display_sort: displaySort,
+        display_daily: displayDaily,
+        export_escape: exportEscape,
+    };
+    return this.get(this.BASE_URL, params, outputObj);
+}

package/dist/domain/getDomainOverviewOneDatabase.d.ts

@@ -0,0 +1,14 @@
+import { SemrushAPIClient } from "../client";
+import { Database } from "../type/general/database";
+import { ExportColumns } from "../type/general/exportColumns";
+export type DomainOverviewOneDatabaseDisplaySort = "rk_asc" | "rk_desc" | "or_asc" | "or_desc" | "ot_asc" | "ot_desc" | "oc_asc" | "oc_desc" | "ad_asc" | "ad_desc" | "at_asc" | "at_desc" | "ac_asc" | "ac_desc";
+export declare function getDomainOverviewOneDatabase(this: SemrushAPIClient, { domain, exportColumns, database, displayDate, displaySort, exportEscape, exportDecode, outputObj, }: {
+    domain: string;
+    exportColumns?: ExportColumns[];
+    database?: Database;
+    displayDate?: string;
+    displaySort?: DomainOverviewOneDatabaseDisplaySort;
+    exportEscape?: 1;
+    exportDecode?: 0 | 1;
+    outputObj?: boolean;
+}): Promise<Record<string, string>[]>;

package/dist/domain/getDomainOverviewOneDatabase.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDomainOverviewOneDatabase = getDomainOverviewOneDatabase;
+const displayDateValidator_1 = require("../utils/displayDateValidator");
+// Domain Overview (one database) — type=domain_rank. "database" is required.
+async function getDomainOverviewOneDatabase({ domain, exportColumns = [
+    "Dn",
+    "Rk",
+    "Or",
+    "Ot",
+    "Oc",
+    "Ad",
+    "At",
+    "Ac",
+    "FKn",
+    "FPn",
+    "Sr",
+    "Srb",
+    "St",
+    "Stb",
+    "Sc",
+    "Srn",
+    "Srl",
+], database = "us", displayDate, displaySort, exportEscape, exportDecode, outputObj = true, }) {
+    if (displayDate && !(0, displayDateValidator_1.displayDateValidator)(displayDate)) {
+        throw new Error("Invalid displayDate format. Format: YYYYMM15");
+    }
+    const params = {
+        type: "domain_rank",
+        export_columns: exportColumns.join(","),
+        domain,
+        database,
+        display_date: displayDate,
+        display_sort: displaySort,
+        export_escape: exportEscape,
+        export_decode: exportDecode,
+    };
+    return this.get(this.BASE_URL, params, outputObj);
+}

package/dist/domain/index.d.ts

@@ -1,4 +1,6 @@
 export { getDomainOverview } from "./getDomainOverview";
+export { getDomainOverviewOneDatabase } from "./getDomainOverviewOneDatabase";
+export { getDomainOverviewHistory } from "./getDomainOverviewHistory";
 export { getDomainOrganicSearchKeywords } from "./getDomainOrganicSearchKeywords";
 export { getDomainPaidSearchKeywords } from "./getDomainPaidSearchKeywords";
 export { getAdsCopies } from "./getAdsCopies";

package/dist/domain/index.js

@@ -1,8 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAdsCopies = exports.getDomainPaidSearchKeywords = exports.getDomainOrganicSearchKeywords = exports.getDomainOverview = void 0;
+exports.getAdsCopies = exports.getDomainPaidSearchKeywords = exports.getDomainOrganicSearchKeywords = exports.getDomainOverviewHistory = exports.getDomainOverviewOneDatabase = exports.getDomainOverview = void 0;
 var getDomainOverview_1 = require("./getDomainOverview");
 Object.defineProperty(exports, "getDomainOverview", { enumerable: true, get: function () { return getDomainOverview_1.getDomainOverview; } });
+var getDomainOverviewOneDatabase_1 = require("./getDomainOverviewOneDatabase");
+Object.defineProperty(exports, "getDomainOverviewOneDatabase", { enumerable: true, get: function () { return getDomainOverviewOneDatabase_1.getDomainOverviewOneDatabase; } });
+var getDomainOverviewHistory_1 = require("./getDomainOverviewHistory");
+Object.defineProperty(exports, "getDomainOverviewHistory", { enumerable: true, get: function () { return getDomainOverviewHistory_1.getDomainOverviewHistory; } });
 var getDomainOrganicSearchKeywords_1 = require("./getDomainOrganicSearchKeywords");
 Object.defineProperty(exports, "getDomainOrganicSearchKeywords", { enumerable: true, get: function () { return getDomainOrganicSearchKeywords_1.getDomainOrganicSearchKeywords; } });
 var getDomainPaidSearchKeywords_1 = require("./getDomainPaidSearchKeywords");

package/dist/keyword/getBatchKeywordOverview.d.ts

@@ -0,0 +1,13 @@
+import { SemrushAPIClient } from "../client";
+import { Database } from "../type/general/database";
+type KeywordExportColumns = "Ph" | "Nq" | "Cp" | "Co" | "Nr" | "Td" | "In" | "Kd";
+export declare function getBatchKeywordOverview(this: SemrushAPIClient, { phrases, exportColumns, database, displayDate, exportEscape, exportDecode, outputObj, }: {
+    phrases: string[];
+    exportColumns?: KeywordExportColumns[];
+    database?: Database;
+    displayDate?: string;
+    exportEscape?: 1;
+    exportDecode?: 0 | 1;
+    outputObj?: boolean;
+}): Promise<Record<string, string>[]>;
+export {};

package/dist/keyword/getBatchKeywordOverview.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBatchKeywordOverview = getBatchKeywordOverview;
+const displayDateValidator_1 = require("../utils/displayDateValidator");
+// Batch Keyword Overview — type=phrase_these. Up to 100 keywords per request.
+async function getBatchKeywordOverview({ phrases, exportColumns = ["Ph", "Nq", "Cp", "Co", "Nr", "Td", "In", "Kd"], database = "us", displayDate, exportEscape, exportDecode, outputObj = true, }) {
+    if (displayDate && !(0, displayDateValidator_1.displayDateValidator)(displayDate)) {
+        throw new Error("Invalid displayDate format. Format: YYYYMM15");
+    }
+    const params = {
+        type: "phrase_these",
+        export_columns: exportColumns.join(","),
+        phrase: phrases.join(";"),
+        database,
+        display_date: displayDate,
+        export_escape: exportEscape,
+        export_decode: exportDecode,
+    };
+    return this.get(this.BASE_URL, params, outputObj);
+}

package/dist/keyword/getBroadMatchKeywords.js

@@ -14,5 +14,5 @@ async function getBroadMatchKeywords({ phrase, exportColumns = ["Ph", "Nq", "Cp"
         export_decode: exportDecode,
         export_columns: exportColumns.join(","),
     };
-    return this.get(this.ANALYTICS_URL, params, outputObj);
+    return this.get(this.BASE_URL, params, outputObj);
 }

package/dist/keyword/getKeywordAdsHistory.d.ts

@@ -0,0 +1,14 @@
+import { SemrushAPIClient } from "../client";
+import { Database } from "../type/general/database";
+type KeywordExportColumns = "Dn" | "Dt" | "Po" | "Ur" | "Tt" | "Ds" | "Vu" | "At" | "Ac" | "Ad";
+export declare function getKeywordAdsHistory(this: SemrushAPIClient, { phrase, exportColumns, database, displayLimit, displayOffset, exportEscape, exportDecode, outputObj, }: {
+    phrase: string;
+    exportColumns?: KeywordExportColumns[];
+    database?: Database;
+    displayLimit?: number;
+    displayOffset?: number;
+    exportEscape?: 1;
+    exportDecode?: 0 | 1;
+    outputObj?: boolean;
+}): Promise<Record<string, string>[]>;
+export {};

package/dist/keyword/getKeywordAdsHistory.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getKeywordAdsHistory = getKeywordAdsHistory;
+async function getKeywordAdsHistory({ phrase, exportColumns = ["Dn", "Dt", "Po", "Ur", "Tt", "Ds", "Vu"], database = "us", displayLimit = 10, displayOffset, exportEscape, exportDecode, outputObj = true, }) {
+    const params = {
+        type: "phrase_adwords_historical",
+        export_columns: exportColumns.join(","),
+        phrase,
+        database,
+        display_limit: displayLimit,
+        display_offset: displayOffset,
+        export_escape: exportEscape,
+        export_decode: exportDecode,
+    };
+    return this.get(this.BASE_URL, params, outputObj);
+}

package/dist/keyword/getKeywordPaidResults.d.ts

@@ -0,0 +1,15 @@
+import { SemrushAPIClient } from "../client";
+import { Database } from "../type/general/database";
+type KeywordExportColumns = "Dn" | "Ur" | "Vu";
+export declare function getKeywordPaidResults(this: SemrushAPIClient, { phrase, exportColumns, database, displayLimit, displayOffset, displayDate, exportEscape, exportDecode, outputObj, }: {
+    phrase: string;
+    exportColumns?: KeywordExportColumns[];
+    database?: Database;
+    displayLimit?: number;
+    displayOffset?: number;
+    displayDate?: string;
+    exportEscape?: 1;
+    exportDecode?: 0 | 1;
+    outputObj?: boolean;
+}): Promise<Record<string, string>[]>;
+export {};

package/dist/keyword/getKeywordPaidResults.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getKeywordPaidResults = getKeywordPaidResults;
+const displayDateValidator_1 = require("../utils/displayDateValidator");
+async function getKeywordPaidResults({ phrase, exportColumns = ["Dn", "Ur", "Vu"], database = "us", displayLimit = 10, displayOffset, displayDate, exportEscape, exportDecode, outputObj = true, }) {
+    if (displayDate && !(0, displayDateValidator_1.displayDateValidator)(displayDate)) {
+        throw new Error("Invalid displayDate format. Format: YYYYMM15");
+    }
+    const params = {
+        type: "phrase_adwords",
+        export_columns: exportColumns.join(","),
+        phrase,
+        database,
+        display_limit: displayLimit,
+        display_offset: displayOffset,
+        display_date: displayDate,
+        export_escape: exportEscape,
+        export_decode: exportDecode,
+    };
+    return this.get(this.BASE_URL, params, outputObj);
+}

package/dist/keyword/getPhraseQuestions.js

@@ -14,5 +14,5 @@ async function getPhraseQuestions({ phrase, exportColumns = ["Ph", "Nq", "Cp", "
         export_decode: exportDecode,
         export_columns: exportColumns.join(","),
     };
-    return this.get(this.ANALYTICS_URL, params, outputObj);
+    return this.get(this.BASE_URL, params, outputObj);
 }

package/dist/keyword/getRelatedKeywords.js

@@ -25,5 +25,5 @@ async function getRelatedKeywords({ phrase, exportColumns = [
         export_decode: exportDecode,
         export_columns: exportColumns.join(","),
     };
-    return this.get(this.ANALYTICS_URL, params, outputObj);
+    return this.get(this.BASE_URL, params, outputObj);
 }

package/dist/keyword/index.d.ts

@@ -4,3 +4,6 @@ export { getRelatedKeywords } from "./getRelatedKeywords";
 export { getPhraseQuestions } from "./getPhraseQuestions";
 export { getBroadMatchKeywords } from "./getBroadMatchKeywords";
 export { getKeywordOrganic } from "./getKeywordOrganic";
+export { getBatchKeywordOverview } from "./getBatchKeywordOverview";
+export { getKeywordPaidResults } from "./getKeywordPaidResults";
+export { getKeywordAdsHistory } from "./getKeywordAdsHistory";

package/dist/keyword/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getKeywordOrganic = exports.getBroadMatchKeywords = exports.getPhraseQuestions = exports.getRelatedKeywords = exports.getKeywordDifficulty = exports.getKeywordOverview = void 0;
+exports.getKeywordAdsHistory = exports.getKeywordPaidResults = exports.getBatchKeywordOverview = exports.getKeywordOrganic = exports.getBroadMatchKeywords = exports.getPhraseQuestions = exports.getRelatedKeywords = exports.getKeywordDifficulty = exports.getKeywordOverview = void 0;
 var getKeywordOverview_1 = require("./getKeywordOverview");
 Object.defineProperty(exports, "getKeywordOverview", { enumerable: true, get: function () { return getKeywordOverview_1.getKeywordOverview; } });
 var getKeywordDifficulty_1 = require("./getKeywordDifficulty");
@@ -13,3 +13,9 @@ var getBroadMatchKeywords_1 = require("./getBroadMatchKeywords");
 Object.defineProperty(exports, "getBroadMatchKeywords", { enumerable: true, get: function () { return getBroadMatchKeywords_1.getBroadMatchKeywords; } });
 var getKeywordOrganic_1 = require("./getKeywordOrganic");
 Object.defineProperty(exports, "getKeywordOrganic", { enumerable: true, get: function () { return getKeywordOrganic_1.getKeywordOrganic; } });
+var getBatchKeywordOverview_1 = require("./getBatchKeywordOverview");
+Object.defineProperty(exports, "getBatchKeywordOverview", { enumerable: true, get: function () { return getBatchKeywordOverview_1.getBatchKeywordOverview; } });
+var getKeywordPaidResults_1 = require("./getKeywordPaidResults");
+Object.defineProperty(exports, "getKeywordPaidResults", { enumerable: true, get: function () { return getKeywordPaidResults_1.getKeywordPaidResults; } });
+var getKeywordAdsHistory_1 = require("./getKeywordAdsHistory");
+Object.defineProperty(exports, "getKeywordAdsHistory", { enumerable: true, get: function () { return getKeywordAdsHistory_1.getKeywordAdsHistory; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "semrush-api-client",
-  "version": "1.0.6",
+  "version": "1.0.11",
   "description": "",
   "license": "Apache-2.0",
   "main": "dist/index.js",
@@ -14,6 +14,10 @@
   },
   "scripts": {
     "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "release": "bash scripts/release.sh",
+    "release:minor": "bash scripts/release.sh minor",
+    "release:major": "bash scripts/release.sh major",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "engines": {
@@ -36,4 +40,4 @@
     "@types/node": "^22.15.30",
     "typescript": "^5.9.3"
   }
-}
+}