semrush-api-client 0.1.19 → 0.1.21

package/dist/backlinks/index.d.ts

@@ -0,0 +1,5 @@
+export { getBacklinksOverview } from "./backlinksOverview";
+export { getBacklinks } from "./getBacklinks";
+export { getAnchors } from "./getAnchors";
+export { getIndexedPages } from "./getIndexedPages";
+export { getReferringDomains } from "./getReferringDomains";

package/dist/backlinks/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getReferringDomains = exports.getIndexedPages = exports.getAnchors = exports.getBacklinks = exports.getBacklinksOverview = void 0;
+var backlinksOverview_1 = require("./backlinksOverview");
+Object.defineProperty(exports, "getBacklinksOverview", { enumerable: true, get: function () { return backlinksOverview_1.getBacklinksOverview; } });
+var getBacklinks_1 = require("./getBacklinks");
+Object.defineProperty(exports, "getBacklinks", { enumerable: true, get: function () { return getBacklinks_1.getBacklinks; } });
+var getAnchors_1 = require("./getAnchors");
+Object.defineProperty(exports, "getAnchors", { enumerable: true, get: function () { return getAnchors_1.getAnchors; } });
+var getIndexedPages_1 = require("./getIndexedPages");
+Object.defineProperty(exports, "getIndexedPages", { enumerable: true, get: function () { return getIndexedPages_1.getIndexedPages; } });
+var getReferringDomains_1 = require("./getReferringDomains");
+Object.defineProperty(exports, "getReferringDomains", { enumerable: true, get: function () { return getReferringDomains_1.getReferringDomains; } });

package/dist/client/index.d.ts

@@ -1,20 +1,9 @@
-import { getDomainOverview } from "../domain/getDomainOverview";
-import { getKeywordOverview } from "../keyword/getKeywordOverview";
-import { getBacklinksOverview } from "../backlinks/backlinksOverview";
-import { getRankDifference } from "../overview/getRankDifference";
-import { getDomainOrganicSearchKeywords } from "../domain/getDomainOrganicSearchKeywords";
-import { getDomainPaidSearchKeywords } from "../domain/getDomainPaidSearchKeywords";
-import { getAdsCopies } from "../domain/getAdsCopies";
-import { getTrafficSummary } from "../trend/getTrafficSummary";
-import { getSemrushRank } from "../overview/getSemrushRank";
-import { getKeywordDifficulty } from "../keyword/getKeywordDifficulty";
-import { getBacklinks } from "../backlinks/getBacklinks";
-import { getAnchors } from "../backlinks/getAnchors";
-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";
+import { getDomainOverview, getDomainOrganicSearchKeywords, getDomainPaidSearchKeywords, getAdsCopies } from "../domain";
+import { getKeywordOverview, getKeywordDifficulty, getRelatedKeywords, getPhraseQuestions, getBroadMatchKeywords } from "../keyword";
+import { getBacklinksOverview, getBacklinks, getAnchors, getIndexedPages, getReferringDomains } from "../backlinks";
+import { getRankDifference, getSemrushRank } from "../overview";
+import { getTrafficSummary } from "../trend";
+import { getUrlOverview, getUrlOrganicSearchKeywords, getUrlPaidSearchKeywords } from "../url";
 export declare class SemrushAPIClient {
     private client;
     private api_key;
@@ -42,4 +31,7 @@ export declare class SemrushAPIClient {
     getRelatedKeywords: typeof getRelatedKeywords;
     getPhraseQuestions: typeof getPhraseQuestions;
     getBroadMatchKeywords: typeof getBroadMatchKeywords;
+    getUrlOverview: typeof getUrlOverview;
+    getUrlOrganicSearchKeywords: typeof getUrlOrganicSearchKeywords;
+    getUrlPaidSearchKeywords: typeof getUrlPaidSearchKeywords;
 }

package/dist/client/index.js

@@ -5,23 +5,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SemrushAPIClient = void 0;
 const axios_1 = __importDefault(require("axios"));
-const getDomainOverview_1 = require("../domain/getDomainOverview");
-const getKeywordOverview_1 = require("../keyword/getKeywordOverview");
-const backlinksOverview_1 = require("../backlinks/backlinksOverview");
-const getRankDifference_1 = require("../overview/getRankDifference");
-const getDomainOrganicSearchKeywords_1 = require("../domain/getDomainOrganicSearchKeywords");
-const getDomainPaidSearchKeywords_1 = require("../domain/getDomainPaidSearchKeywords");
-const getAdsCopies_1 = require("../domain/getAdsCopies");
-const getTrafficSummary_1 = require("../trend/getTrafficSummary");
-const getSemrushRank_1 = require("../overview/getSemrushRank");
-const getKeywordDifficulty_1 = require("../keyword/getKeywordDifficulty");
-const getBacklinks_1 = require("../backlinks/getBacklinks");
-const getAnchors_1 = require("../backlinks/getAnchors");
-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");
+const domain_1 = require("../domain");
+const keyword_1 = require("../keyword");
+const backlinks_1 = require("../backlinks");
+const overview_1 = require("../overview");
+const trend_1 = require("../trend");
+const url_1 = require("../url");
 class SemrushAPIClient {
     client;
     api_key;
@@ -67,22 +56,25 @@ class SemrushAPIClient {
             }
         }
     }
-    getDomainOverview = getDomainOverview_1.getDomainOverview;
-    getKeywordOverview = getKeywordOverview_1.getKeywordOverview;
-    getBacklinksOverview = backlinksOverview_1.getBacklinksOverview;
-    getRankDifference = getRankDifference_1.getRankDifference;
-    getSemrushRank = getSemrushRank_1.getSemrushRank;
-    getDomainOrganicSearchKeywords = getDomainOrganicSearchKeywords_1.getDomainOrganicSearchKeywords;
-    getDomainPaidSearchKeywords = getDomainPaidSearchKeywords_1.getDomainPaidSearchKeywords;
-    getAdsCopies = getAdsCopies_1.getAdsCopies;
-    getTrafficSummary = getTrafficSummary_1.getTrafficSummary;
-    getKeywordDifficulty = getKeywordDifficulty_1.getKeywordDifficulty;
-    getBacklinks = getBacklinks_1.getBacklinks;
-    getAnchors = getAnchors_1.getAnchors;
-    getIndexedPages = getIndexedPages_1.getIndexedPages;
-    getReferringDomains = getReferringDomains_1.getReferringDomains;
-    getRelatedKeywords = getRelatedKeywords_1.getRelatedKeywords;
-    getPhraseQuestions = getPhraseQuestions_1.getPhraseQuestions;
-    getBroadMatchKeywords = getBroadMatchKeywords_1.getBroadMatchKeywords;
+    getDomainOverview = domain_1.getDomainOverview;
+    getKeywordOverview = keyword_1.getKeywordOverview;
+    getBacklinksOverview = backlinks_1.getBacklinksOverview;
+    getRankDifference = overview_1.getRankDifference;
+    getSemrushRank = overview_1.getSemrushRank;
+    getDomainOrganicSearchKeywords = domain_1.getDomainOrganicSearchKeywords;
+    getDomainPaidSearchKeywords = domain_1.getDomainPaidSearchKeywords;
+    getAdsCopies = domain_1.getAdsCopies;
+    getTrafficSummary = trend_1.getTrafficSummary;
+    getKeywordDifficulty = keyword_1.getKeywordDifficulty;
+    getBacklinks = backlinks_1.getBacklinks;
+    getAnchors = backlinks_1.getAnchors;
+    getIndexedPages = backlinks_1.getIndexedPages;
+    getReferringDomains = backlinks_1.getReferringDomains;
+    getRelatedKeywords = keyword_1.getRelatedKeywords;
+    getPhraseQuestions = keyword_1.getPhraseQuestions;
+    getBroadMatchKeywords = keyword_1.getBroadMatchKeywords;
+    getUrlOverview = url_1.getUrlOverview;
+    getUrlOrganicSearchKeywords = url_1.getUrlOrganicSearchKeywords;
+    getUrlPaidSearchKeywords = url_1.getUrlPaidSearchKeywords;
 }
 exports.SemrushAPIClient = SemrushAPIClient;

package/dist/domain/index.d.ts

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

package/dist/domain/index.js

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

package/dist/index.d.ts

@@ -1,4 +1,10 @@
 export * from "./client";
+export * from "./domain";
+export * from "./keyword";
+export * from "./backlinks";
+export * from "./overview";
+export * from "./trend";
+export * from "./url";
 export * from "./type/general/country";
 export * from "./type/general/exportColumns";
 export * from "./type/general/database";

package/dist/index.js

@@ -20,6 +20,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const dotenv_1 = __importDefault(require("dotenv"));
 dotenv_1.default.config();
 __exportStar(require("./client"), exports);
+// Export all API functions by category
+__exportStar(require("./domain"), exports);
+__exportStar(require("./keyword"), exports);
+__exportStar(require("./backlinks"), exports);
+__exportStar(require("./overview"), exports);
+__exportStar(require("./trend"), exports);
+__exportStar(require("./url"), exports);
+// Export types
 __exportStar(require("./type/general/country"), exports);
 __exportStar(require("./type/general/exportColumns"), exports);
 __exportStar(require("./type/general/database"), exports);

package/dist/keyword/getKeywordDifficulty.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getKeywordDifficulty = getKeywordDifficulty;
-async function getKeywordDifficulty({ phrases, export_columns = ["Ph", "Kd"], database, outputObj = true, // Default to true for output object
+async function getKeywordDifficulty({ phrases, export_columns = ["Ph", "Kd"], database = "us", outputObj = true, // Default to true for output object
  }) {
     const params = {
         type: "phrase_kdi",

package/dist/keyword/getKeywordOverview.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getKeywordOverview = getKeywordOverview;
-async function getKeywordOverview({ phrase, export_columns = ["Dt", "Db", "Ph", "Nq", "Cp", "Co", "Nr"], database, outputObj = true, // Default to true for output object
+async function getKeywordOverview({ phrase, export_columns = ["Dt", "Db", "Ph", "Nq", "Cp", "Co", "Nr"], database = "us", outputObj = true, // Default to true for output object
  }) {
     const params = {
         type: "phrase_all",

package/dist/keyword/index.d.ts

@@ -0,0 +1,5 @@
+export { getKeywordOverview } from "./getKeywordOverview";
+export { getKeywordDifficulty } from "./getKeywordDifficulty";
+export { getRelatedKeywords } from "./getRelatedKeywords";
+export { getPhraseQuestions } from "./getPhraseQuestions";
+export { getBroadMatchKeywords } from "./getBroadMatchKeywords";

package/dist/keyword/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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");
+Object.defineProperty(exports, "getKeywordDifficulty", { enumerable: true, get: function () { return getKeywordDifficulty_1.getKeywordDifficulty; } });
+var getRelatedKeywords_1 = require("./getRelatedKeywords");
+Object.defineProperty(exports, "getRelatedKeywords", { enumerable: true, get: function () { return getRelatedKeywords_1.getRelatedKeywords; } });
+var getPhraseQuestions_1 = require("./getPhraseQuestions");
+Object.defineProperty(exports, "getPhraseQuestions", { enumerable: true, get: function () { return getPhraseQuestions_1.getPhraseQuestions; } });
+var getBroadMatchKeywords_1 = require("./getBroadMatchKeywords");
+Object.defineProperty(exports, "getBroadMatchKeywords", { enumerable: true, get: function () { return getBroadMatchKeywords_1.getBroadMatchKeywords; } });

package/dist/overview/index.d.ts

@@ -0,0 +1,2 @@
+export { getRankDifference } from "./getRankDifference";
+export { getSemrushRank } from "./getSemrushRank";

package/dist/overview/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSemrushRank = exports.getRankDifference = void 0;
+var getRankDifference_1 = require("./getRankDifference");
+Object.defineProperty(exports, "getRankDifference", { enumerable: true, get: function () { return getRankDifference_1.getRankDifference; } });
+var getSemrushRank_1 = require("./getSemrushRank");
+Object.defineProperty(exports, "getSemrushRank", { enumerable: true, get: function () { return getSemrushRank_1.getSemrushRank; } });

package/dist/trend/index.d.ts

@@ -0,0 +1 @@
+export { getTrafficSummary } from "./getTrafficSummary";

package/dist/trend/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTrafficSummary = void 0;
+var getTrafficSummary_1 = require("./getTrafficSummary");
+Object.defineProperty(exports, "getTrafficSummary", { enumerable: true, get: function () { return getTrafficSummary_1.getTrafficSummary; } });

package/dist/url/getUrlOrganicSearchKeywords.d.ts

@@ -0,0 +1,12 @@
+import { SemrushAPIClient } from "../client";
+import { Database } from "../type/general/database";
+export type ExportColumns = "Ph" | "Po" | "Pp" | "Nq" | "Cp" | "Co" | "Kd" | "Tr" | "Tg" | "Tc" | "Nr" | "Td" | "Fp" | "Fk" | "Ts" | "In" | "Pt";
+export type DisplaySort = "po_asc" | "po_desc" | "tg_asc" | "tg_desc" | "tr_asc" | "tr_desc" | "tc_asc" | "tc_desc" | "nq_asc" | "nq_desc";
+export declare function getUrlOrganicSearchKeywords(this: SemrushAPIClient, { url, export_columns, database, outputObj, display_limit, display_sort, }: {
+    url: string;
+    export_columns?: ExportColumns[];
+    database?: Database;
+    outputObj?: boolean;
+    display_limit?: number;
+    display_sort?: DisplaySort;
+}): Promise<Record<string, string>[]>;

package/dist/url/getUrlOrganicSearchKeywords.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUrlOrganicSearchKeywords = getUrlOrganicSearchKeywords;
+function getUrlOrganicSearchKeywords({ url, export_columns = [
+    "Ph",
+    "Po",
+    "Pp",
+    "Nq",
+    "Cp",
+    "Co",
+    "Kd",
+    "Tr",
+    "Tg",
+    "Tc",
+    "Nr",
+    "Td",
+    "Fp",
+    "Fk",
+    "Ts",
+    "In",
+    "Pt",
+], database = "us", outputObj = true, display_limit = 10, display_sort, }) {
+    const params = {
+        url,
+        type: "url_organic",
+        export_columns: export_columns.join(","),
+        database,
+        display_limit,
+        display_sort,
+    };
+    return this.get(this.BASE_URL, params, outputObj);
+}

package/dist/url/getUrlOverview.d.ts

@@ -0,0 +1,13 @@
+import { SemrushAPIClient } from "../client";
+import { Database } from "../type/general/database";
+export type ExportColumns = "Dn" | "Or" | "Xn" | "Ot" | "Oc" | "Ad" | "At" | "Ac" | "FKn" | "FPn" | "Ipu" | "Ip0" | "Ip1" | "Ip2" | "Ip3" | "Itu" | "It0" | "It1" | "It2" | "It3" | "Icu" | "Ic0" | "Ic1" | "Ic2" | "Ic3" | "Sr" | "Srb" | "St" | "Stb" | "Sc" | "Srn" | "Srl" | "Rk";
+export type DisplaySort = "po_asc" | "po_desc" | "tg_asc" | "tg_desc" | "tr_asc" | "tr_desc" | "tc_asc" | "tc_desc" | "nq_asc" | "nq_desc" | "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 getUrlOverview(this: SemrushAPIClient, { url, export_columns, // Default export columns
+database, outputObj, // Default to true for output object
+display_sort, }: {
+    url: string;
+    export_columns?: ExportColumns[];
+    database?: Database;
+    outputObj?: boolean;
+    display_sort?: DisplaySort;
+}): Promise<Record<string, string>[]>;

package/dist/url/getUrlOverview.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUrlOverview = getUrlOverview;
+function getUrlOverview({ url, export_columns = [
+    "Dn",
+    "Or",
+    "Xn",
+    "Ot",
+    "Oc",
+    "Ad",
+    "At",
+    "Ac",
+    "FKn",
+    "FPn",
+    "Ipu",
+    "Ip0",
+    "Ip1",
+    "Ip2",
+    "Ip3",
+    "Itu",
+    "It0",
+    "It1",
+    "It2",
+    "It3",
+    "Icu",
+    "Ic0",
+    "Ic1",
+    "Ic2",
+    "Ic3",
+    "Sr",
+    "Srb",
+    "St",
+    "Stb",
+    "Sc",
+    "Srn",
+    "Srl",
+    "Rk",
+], // Default export columns
+database = "us", outputObj = true, // Default to true for output object
+display_sort, }) {
+    const params = {
+        url,
+        type: "url_rank",
+        export_columns: export_columns.join(","),
+        database,
+        display_sort,
+    };
+    return this.get(this.BASE_URL, params, outputObj);
+}

package/dist/url/getUrlPaidSearchKeywords.d.ts

@@ -0,0 +1,12 @@
+import { SemrushAPIClient } from "../client";
+import { Database } from "../type/general/database";
+export type ExportColumns = "Ph" | "Po" | "Nq" | "Cp" | "Co" | "Tg" | "Tr" | "Tc" | "Nr" | "Td" | "Tt" | "Ds" | "Ts";
+export type DisplaySort = "po_asc" | "po_desc" | "tg_asc" | "tg_desc" | "tr_asc" | "tr_desc" | "tc_asc" | "tc_desc" | "nq_asc" | "nq_desc";
+export declare function getUrlPaidSearchKeywords(this: SemrushAPIClient, { url, export_columns, database, display_sort, outputObj, display_limit, }: {
+    url: string;
+    export_columns?: ExportColumns[];
+    database?: Database;
+    display_sort?: DisplaySort;
+    outputObj?: boolean;
+    display_limit?: number;
+}): Promise<Record<string, string>[]>;

package/dist/url/getUrlPaidSearchKeywords.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUrlPaidSearchKeywords = getUrlPaidSearchKeywords;
+function getUrlPaidSearchKeywords({ url, export_columns = [
+    "Ph",
+    "Po",
+    "Nq",
+    "Cp",
+    "Co",
+    "Tg",
+    "Tr",
+    "Tc",
+    "Nr",
+    "Td",
+    "Tt",
+    "Ds",
+    "Ts",
+], database = "us", display_sort, outputObj = true, display_limit = 10, }) {
+    const params = {
+        url,
+        type: "url_adwords",
+        export_columns: export_columns.join(","),
+        database,
+        display_sort,
+        display_limit,
+    };
+    return this.get(this.BASE_URL, params, outputObj);
+}

package/dist/url/index.d.ts

@@ -0,0 +1,3 @@
+export { getUrlOverview } from "./getUrlOverview";
+export { getUrlOrganicSearchKeywords } from "./getUrlOrganicSearchKeywords";
+export { getUrlPaidSearchKeywords } from "./getUrlPaidSearchKeywords";

package/dist/url/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUrlPaidSearchKeywords = exports.getUrlOrganicSearchKeywords = exports.getUrlOverview = void 0;
+var getUrlOverview_1 = require("./getUrlOverview");
+Object.defineProperty(exports, "getUrlOverview", { enumerable: true, get: function () { return getUrlOverview_1.getUrlOverview; } });
+var getUrlOrganicSearchKeywords_1 = require("./getUrlOrganicSearchKeywords");
+Object.defineProperty(exports, "getUrlOrganicSearchKeywords", { enumerable: true, get: function () { return getUrlOrganicSearchKeywords_1.getUrlOrganicSearchKeywords; } });
+var getUrlPaidSearchKeywords_1 = require("./getUrlPaidSearchKeywords");
+Object.defineProperty(exports, "getUrlPaidSearchKeywords", { enumerable: true, get: function () { return getUrlPaidSearchKeywords_1.getUrlPaidSearchKeywords; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "semrush-api-client",
-  "version": "0.1.19",
+  "version": "0.1.21",
   "description": "",
   "license": "Apache-2.0",
   "main": "dist/index.js",
@@ -17,7 +17,7 @@
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "engines": {
-    "node": "20"
+    "node": ">=20"
   },
   "keywords": [
     "semrush",