semrush-api-client 0.1.6 → 0.1.8

package/dist/backlinks/backlinksOverview.js

@@ -23,5 +23,5 @@ async function backlinksOverview({ target, target_type = "domain", export_column
         target_type,
         export_columns: export_columns.join(","),
     };
-    return this.get(this.ANALYTICS_URL, params, outputObj);
+    return this.get(this.ANALYTICS_URL + "v1/", params, outputObj);
 }

package/dist/client/index.d.ts

@@ -1,9 +1,13 @@
 import { getDomainOverview } from "../overview/getDomainOverview";
-import { getPhraseAll } from "../keyword/getPhrase";
+import { getKeywordOverview } from "../keyword/getKeywordOverview";
 import { backlinksOverview } from "../backlinks/backlinksOverview";
 import { getRankDifference } from "../overview/getRankDifference";
 import { getDomainOrganic } from "../domain/getDomainOrganic";
+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";
 export declare class SemrushAPIClient {
     private client;
     private api_key;
@@ -15,9 +19,13 @@ 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;
-    getPhrase: typeof getPhraseAll;
+    getKeywordOverview: typeof getKeywordOverview;
     backlinksOverview: typeof backlinksOverview;
     getRankDifference: typeof getRankDifference;
     getSemrushRank: typeof getSemrushRank;
     getDomainOrganic: typeof getDomainOrganic;
+    getDomainPaidSearchKeywords: typeof getDomainPaidSearchKeywords;
+    getAdsCopies: typeof getAdsCopies;
+    getTrafficSummary: typeof getTrafficSummary;
+    getKeywordDifficulty: typeof getKeywordDifficulty;
 }

package/dist/client/index.js

@@ -6,20 +6,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SemrushAPIClient = void 0;
 const axios_1 = __importDefault(require("axios"));
 const getDomainOverview_1 = require("../overview/getDomainOverview");
-const getPhrase_1 = require("../keyword/getPhrase");
+const getKeywordOverview_1 = require("../keyword/getKeywordOverview");
 const backlinksOverview_1 = require("../backlinks/backlinksOverview");
 const getRankDifference_1 = require("../overview/getRankDifference");
 const getDomainOrganic_1 = require("../domain/getDomainOrganic");
+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");
 class SemrushAPIClient {
     client;
     api_key;
     BASE_URL = "https://api.semrush.com/";
-    ANALYTICS_URL = "https://api.semrush.com/analytics/v1/";
+    ANALYTICS_URL = "https://api.semrush.com/analytics/";
     constructor({ api_key }) {
         this.api_key = api_key;
         this.client = axios_1.default.create({
-            timeout: 10000,
+            timeout: 14000,
         });
     }
     parseCsvToObjects(csvString, delimiter = ";") {
@@ -57,10 +61,14 @@ class SemrushAPIClient {
         }
     }
     getDomainOverview = getDomainOverview_1.getDomainOverview;
-    getPhrase = getPhrase_1.getPhraseAll;
+    getKeywordOverview = getKeywordOverview_1.getKeywordOverview;
     backlinksOverview = backlinksOverview_1.backlinksOverview;
     getRankDifference = getRankDifference_1.getRankDifference;
     getSemrushRank = getSemrushRank_1.getSemrushRank;
     getDomainOrganic = getDomainOrganic_1.getDomainOrganic;
+    getDomainPaidSearchKeywords = getDomainPaidSearchKeywords_1.getDomainPaidSearchKeywords;
+    getAdsCopies = getAdsCopies_1.getAdsCopies;
+    getTrafficSummary = getTrafficSummary_1.getTrafficSummary;
+    getKeywordDifficulty = getKeywordDifficulty_1.getKeywordDifficulty;
 }
 exports.SemrushAPIClient = SemrushAPIClient;

package/dist/domain/getAdsCopies.d.ts

@@ -0,0 +1,11 @@
+import { SemrushAPIClient } from "../client";
+import { Database } from "../type/general/database";
+type ExportColumns = "Tt" | "Ds" | "Vu" | "Ur" | "Pc" | "Un";
+export declare function getAdsCopies(this: SemrushAPIClient, { domain, export_columns, database, display_limit, outputObj, }: {
+    domain: string;
+    export_columns?: ExportColumns[];
+    database?: Database;
+    outputObj?: boolean;
+    display_limit?: number;
+}): Promise<string>;
+export {};

package/dist/domain/getAdsCopies.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAdsCopies = getAdsCopies;
+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(","),
+        domain,
+        database,
+        display_limit,
+    };
+    return this.get(this.BASE_URL, params, outputObj);
+}

package/dist/domain/getDomainOrganic.d.ts

@@ -1,12 +1,12 @@
 import { SemrushAPIClient } from "../client";
 import { Database } from "../type/general/database";
 type ExportColumns = "Ph" | "Po" | "Pp" | "Pd" | "Nq" | "Cp" | "Ur" | "Tr" | "Tg" | "Tc" | "Co" | "Nr" | "Td" | "Kd" | "Fp" | "Fk" | "Ts" | "In" | "Pt";
-type displayPostions = "new" | "lost" | "rise" | "fall";
+type displayPositions = "new" | "lost" | "rise" | "fall";
 type displayPositionType = "organic" | "all" | "serp_features";
 export declare function getDomainOrganic(this: SemrushAPIClient, { domain, export_columns, database, displayPosition, displayPositionsType, display_limit, outputObj, }: {
     domain: string;
     export_columns?: ExportColumns[];
-    displayPosition?: displayPostions;
+    displayPosition?: displayPositions;
     database?: Database;
     outputObj?: boolean;
     displayPositionsType?: displayPositionType;

package/dist/domain/getDomainPaidSearchKeywords.d.ts

@@ -0,0 +1,13 @@
+import { SemrushAPIClient } from "../client";
+import { Database } from "../type/general/database";
+type ExportColumns = "Ph" | "Po" | "Pp" | "Pd" | "Ab" | "Nq" | "Cp" | "Ur" | "Tr" | "Tg" | "Tc" | "Co" | "Nr" | "Td" | "Tt" | "Ds" | "Vu" | "Ur" | "Ts" | "Un";
+type displayPositions = "new" | "lost" | "rise" | "fall";
+export declare function getDomainPaidSearchKeywords(this: SemrushAPIClient, { domain, export_columns, database, displayPosition, display_limit, outputObj, }: {
+    domain: string;
+    export_columns?: ExportColumns[];
+    displayPosition?: displayPositions;
+    database?: Database;
+    outputObj?: boolean;
+    display_limit?: number;
+}): Promise<string>;
+export {};

package/dist/domain/getDomainPaidSearchKeywords.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDomainPaidSearchKeywords = getDomainPaidSearchKeywords;
+async function getDomainPaidSearchKeywords({ domain, export_columns = [
+    "Ph",
+    "Po",
+    "Pp",
+    "Pd",
+    "Nq",
+    "Cp",
+    "Vu",
+    "Tr",
+    "Tc",
+    "Co",
+    "Nr",
+    "Td",
+], database = "us", displayPosition, display_limit = 1000, outputObj = true, }) {
+    const params = {
+        type: "domain_adwords",
+        export_columns: export_columns.join(","),
+        domain,
+        database,
+        display_position: displayPosition,
+        display_limit,
+    };
+    return this.get(this.BASE_URL, params, outputObj);
+}

package/dist/keyword/getKeywordDifficulty.d.ts

@@ -0,0 +1,10 @@
+import { SemrushAPIClient } from "../client";
+import { Database } from "../type/general/database";
+type ExportColumns = "Ph" | "Kd";
+export declare function getKeywordDifficulty(this: SemrushAPIClient, { phrases, export_columns, database, outputObj, }: {
+    phrases: string[];
+    export_columns?: ExportColumns[];
+    database?: Database;
+    outputObj?: boolean;
+}): Promise<string>;
+export {};

package/dist/keyword/getKeywordDifficulty.js

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

package/dist/keyword/{getPhrase.d.ts → getKeywordOverview.d.ts}

@@ -1,7 +1,7 @@
 import { SemrushAPIClient } from "../client";
 import { Database } from "../type/general/database";
 type KeywordExportColumns = "Dt" | "Db" | "Ph" | "Nq" | "Cp" | "Co" | "Nr" | "In" | "Kd";
-export declare function getPhraseAll(this: SemrushAPIClient, { phrase, export_columns, database, outputObj, }: {
+export declare function getKeywordOverview(this: SemrushAPIClient, { phrase, export_columns, database, outputObj, }: {
     phrase: string;
     export_columns?: KeywordExportColumns[];
     database?: Database;

package/dist/keyword/{getPhrase.js → getKeywordOverview.js}

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPhraseAll = getPhraseAll;
-async function getPhraseAll({ phrase, export_columns = ["Dt", "Db", "Ph", "Nq", "Cp", "Co", "Nr"], database = "us", outputObj = true, // Default to true for output object
+exports.getKeywordOverview = getKeywordOverview;
+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/trend/getTrafficSummary.d.ts

@@ -0,0 +1,9 @@
+import { SemrushAPIClient } from "../client";
+import { Country } from "../type/general/country";
+export type ExportColumns = "target" | "rank" | "visits" | "categories" | "desktop_visits" | "mobile_visits" | "users" | "desktop_users" | "mobile_users" | "direct" | "referral" | "social" | "search" | "paid" | "search_organic" | "search_paid" | "social_organic" | "social_paid" | "mail" | "display_ad" | "unknown_channel" | "time_on_site" | "desktop_time_on_site" | "mobile_time_on_site" | "pages_per_visit" | "desktop_pages_per_visit" | "mobile_pages_per_visit" | "bounce_rate" | "desktop_bounce_rate" | "mobile_bounce_rate" | "desktop_share" | "mobile_share" | "accuracy" | "display_date" | "country" | "device_type" | "desktop_hits" | "mobile_hits";
+export declare function getTrafficSummary(this: SemrushAPIClient, { domains, export_columns, country, outputObj, }: {
+    domains: string[];
+    export_columns?: ExportColumns[];
+    country?: Country;
+    outputObj?: boolean;
+}): Promise<string>;

package/dist/trend/getTrafficSummary.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTrafficSummary = getTrafficSummary;
+function getTrafficSummary({ domains, export_columns = ["target", "visits", "users"], country, outputObj = true, // Default to true for output object
+ }) {
+    const params = {
+        targets: domains.join(","),
+        export_columns: export_columns.join(","),
+        country: country,
+    };
+    return this.get(this.ANALYTICS_URL + "ta/api/v3/summary", params, outputObj);
+}

package/dist/type/general/country.d.ts

@@ -0,0 +1 @@
+export type Country = "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AN" | "AO" | "AQ" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW";

package/dist/type/general/country.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "semrush-api-client",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "description": "",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "module": "dist/index.js",
+  "homepage": "https://github.com/RenKoya1/semrush-api-client",
   "exports": {
     ".": {
       "import": "./dist/index.js",
@@ -18,7 +19,10 @@
   "engines": {
     "node": "20"
   },
-  "keywords": [],
+  "keywords": [
+    "semrush",
+    "api"
+  ],
   "author": "",
   "type": "commonjs",
   "dependencies": {