semrush-api-client 0.1.24 → 1.0.2

package/dist/keyword/getKeywordOrganic.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getKeywordOrganic = getKeywordOrganic;
+async function getKeywordOrganic({ phrase, exportColumns = ["Po", "Pt", "Dn", "Ur", "Fk", "Fp", "Fl"], database = "us", displayLimit = 10, displayOffset, displaySort, displayFilter, exportEscape, exportDecode, outputObj = true, }) {
+    const params = {
+        type: "phrase_organic",
+        export_columns: exportColumns.join(","),
+        phrase,
+        database,
+        display_limit: displayLimit,
+        display_offset: displayOffset,
+        display_sort: displaySort,
+        display_filter: displayFilter,
+        export_escape: exportEscape,
+        export_decode: exportDecode,
+    };
+    return this.get(this.BASE_URL, params, outputObj);
+}

package/dist/keyword/getKeywordOverview.d.ts

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

package/dist/keyword/getKeywordOverview.js

@@ -1,13 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getKeywordOverview = getKeywordOverview;
-async function getKeywordOverview({ phrase, export_columns = ["Dt", "Db", "Ph", "Nq", "Cp", "Co", "Nr", "In", "Kd"], database = "us", outputObj = true, // Default to true for output object
- }) {
+const displayDateValidator_1 = require("../utils/displayDateValidator");
+async function getKeywordOverview({ phrase, exportColumns = ["Dt", "Db", "Ph", "Nq", "Cp", "Co", "Nr", "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_all",
-        export_columns: export_columns.join(","),
+        export_columns: exportColumns.join(","),
         phrase,
         database,
+        display_date: displayDate,
+        export_escape: exportEscape,
+        export_decode: exportDecode,
     };
     return this.get(this.BASE_URL, params, outputObj);
 }

package/dist/keyword/getPhrase.d.ts

@@ -0,0 +1,9 @@
+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, }: {
+    phrase: string;
+    export_columns?: KeywordExportColumns[];
+    database?: Database;
+}): Promise<string>;
+export {};

package/dist/keyword/getPhrase.js

@@ -0,0 +1,12 @@
+"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", }) {
+    const params = {
+        type: "phrase_all",
+        export_columns: export_columns.join(","),
+        phrase,
+        database,
+    };
+    return this.get("", params);
+}

package/dist/keyword/getPhraseQuestions.d.ts

@@ -2,11 +2,15 @@ import { SemrushAPIClient } from "../client";
 import { Database } from "../type/general/database";
 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, }: {
+export declare function getPhraseQuestions(this: SemrushAPIClient, { phrase, exportColumns, database, displaySort, displayLimit, displayOffset, displayFilter, exportEscape, exportDecode, outputObj, }: {
     phrase: string;
     database?: Database;
-    export_columns?: ExportColumns[];
+    exportColumns?: ExportColumns[];
     displaySort?: DisplaySort;
+    displayLimit?: number;
+    displayOffset?: number;
+    displayFilter?: string;
+    exportEscape?: 1;
+    exportDecode?: 0 | 1;
     outputObj?: boolean;
-    display_limit?: number;
 }): Promise<Record<string, string>[]>;

package/dist/keyword/getPhraseQuestions.js

@@ -1,14 +1,18 @@
 "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 = "us", displaySort = "nq_desc", display_limit = 10, outputObj = true, }) {
+async function getPhraseQuestions({ phrase, exportColumns = ["Ph", "Nq", "Cp", "Co", "Nr", "Td", "In", "Kd"], database = "us", displaySort = "nq_desc", displayLimit = 10, displayOffset, displayFilter, exportEscape, exportDecode, outputObj = true, }) {
     const params = {
         type: "phrase_questions",
         phrase,
         database,
         display_sort: displaySort,
-        display_limit,
-        export_columns: export_columns.join(","),
+        display_limit: displayLimit,
+        display_offset: displayOffset,
+        display_filter: displayFilter,
+        export_escape: exportEscape,
+        export_decode: exportDecode,
+        export_columns: exportColumns.join(","),
     };
     return this.get(this.ANALYTICS_URL, params, outputObj);
 }

package/dist/keyword/getRelatedKeywords.d.ts

@@ -2,11 +2,15 @@ import { SemrushAPIClient } from "../client";
 import { Database } from "../type/general/database";
 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, }: {
+export declare function getRelatedKeywords(this: SemrushAPIClient, { phrase, exportColumns, database, displaySort, displayLimit, displayOffset, displayFilter, exportEscape, exportDecode, outputObj, }: {
     phrase: string;
     database?: Database;
-    export_columns?: ExportColumns[];
+    exportColumns?: ExportColumns[];
     displaySort?: DisplaySort;
+    displayLimit?: number;
+    displayOffset?: number;
+    displayFilter?: string;
+    exportEscape?: 1;
+    exportDecode?: 0 | 1;
     outputObj?: boolean;
-    display_limit?: number;
 }): Promise<Record<string, string>[]>;

package/dist/keyword/getRelatedKeywords.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRelatedKeywords = getRelatedKeywords;
-async function getRelatedKeywords({ phrase, export_columns = [
+async function getRelatedKeywords({ phrase, exportColumns = [
     "Ph",
     "Nq",
     "Cp",
@@ -12,14 +12,18 @@ async function getRelatedKeywords({ phrase, export_columns = [
     "Fk",
     "In",
     "Kd",
-], database = "us", displaySort = "nq_desc", display_limit = 10, outputObj = true, }) {
+], database = "us", displaySort = "nq_desc", displayLimit = 10, displayOffset, displayFilter, exportEscape, exportDecode, outputObj = true, }) {
     const params = {
         type: "phrase_related",
         phrase,
         database,
         display_sort: displaySort,
-        display_limit,
-        export_columns: export_columns.join(","),
+        display_limit: displayLimit,
+        display_offset: displayOffset,
+        display_filter: displayFilter,
+        export_escape: exportEscape,
+        export_decode: exportDecode,
+        export_columns: exportColumns.join(","),
     };
     return this.get(this.ANALYTICS_URL, params, outputObj);
 }

package/dist/keyword/index.d.ts

@@ -3,3 +3,4 @@ export { getKeywordDifficulty } from "./getKeywordDifficulty";
 export { getRelatedKeywords } from "./getRelatedKeywords";
 export { getPhraseQuestions } from "./getPhraseQuestions";
 export { getBroadMatchKeywords } from "./getBroadMatchKeywords";
+export { getKeywordOrganic } from "./getKeywordOrganic";

package/dist/keyword/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBroadMatchKeywords = exports.getPhraseQuestions = exports.getRelatedKeywords = exports.getKeywordDifficulty = exports.getKeywordOverview = void 0;
+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");
@@ -11,3 +11,5 @@ 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; } });
+var getKeywordOrganic_1 = require("./getKeywordOrganic");
+Object.defineProperty(exports, "getKeywordOrganic", { enumerable: true, get: function () { return getKeywordOrganic_1.getKeywordOrganic; } });

package/dist/overview/getRankDifference.d.ts

@@ -1,11 +1,17 @@
 import { SemrushAPIClient } from "../client";
 import { Database } from "../type/general/database";
 type ExportColumns = "Db" | "Dt" | "Dn" | "Rk" | "Or" | "Ot" | "Oc" | "Ad" | "At" | "Ac" | "Sh" | "Sv" | "FKn" | "FPn" | "Sr" | "Srb" | "St" | "Stb" | "Sc" | "Srn" | "Srl";
-export declare function getRankDifference(this: SemrushAPIClient, { domain, export_columns, database, display_limit, outputObj, }: {
+export type RankDifferenceDisplaySort = "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 getRankDifference(this: SemrushAPIClient, { domain, exportColumns, database, displayLimit, displayOffset, displaySort, displayDate, exportEscape, exportDecode, outputObj, }: {
     domain: string;
-    export_columns?: ExportColumns[];
+    exportColumns?: ExportColumns[];
     database?: Database;
-    display_limit?: number;
+    displayLimit?: number;
+    displayOffset?: number;
+    displaySort?: RankDifferenceDisplaySort;
+    displayDate?: string;
+    exportEscape?: 1;
+    exportDecode?: 0 | 1;
     outputObj?: boolean;
 }): Promise<Record<string, string>[]>;
 export {};

package/dist/overview/getRankDifference.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRankDifference = getRankDifference;
-async function getRankDifference({ domain, export_columns = [
+const displayDateValidator_1 = require("../utils/displayDateValidator");
+async function getRankDifference({ domain, exportColumns = [
     "Db",
     "Dn",
     "Rk",
@@ -12,13 +13,21 @@ async function getRankDifference({ domain, export_columns = [
     "At",
     "Ac",
     "Sh",
-], database = "us", display_limit = 1000, outputObj = true, }) {
+], database = "us", displayLimit = 1000, displayOffset, displaySort, displayDate, exportEscape, exportDecode, outputObj = true, }) {
+    if (displayDate && !(0, displayDateValidator_1.displayDateValidator)(displayDate)) {
+        throw new Error("Invalid displayDate format. Format: YYYYMM15");
+    }
     const params = {
         type: "rank_difference",
-        export_columns: export_columns.join(","),
+        export_columns: exportColumns.join(","),
         domain,
         database,
-        display_limit,
+        display_limit: displayLimit,
+        display_offset: displayOffset,
+        display_sort: displaySort,
+        display_date: displayDate,
+        export_escape: exportEscape,
+        export_decode: exportDecode,
     };
     return this.get(this.BASE_URL, params, outputObj);
 }

package/dist/overview/getSemrushRank.d.ts

@@ -1,10 +1,15 @@
 import { SemrushAPIClient } from "../client";
 import { Database } from "../type/general/database";
 type ExportColumns = "Dn" | "Rk" | "Or" | "Ot" | "Oc" | "Ad" | "At" | "Ac" | "Sr" | "St" | "Sc";
-export declare function getSemrushRank(this: SemrushAPIClient, { export_columns, database, display_limit, outputObj, }: {
-    export_columns?: ExportColumns[];
+export declare function getSemrushRank(this: SemrushAPIClient, { exportColumns, database, displayLimit, displayOffset, displayFilter, displayDate, exportEscape, exportDecode, outputObj, }: {
+    exportColumns?: ExportColumns[];
     database?: Database;
-    display_limit?: number;
+    displayLimit?: number;
+    displayOffset?: number;
+    displayFilter?: string;
+    displayDate?: string;
+    exportEscape?: 1;
+    exportDecode?: 0 | 1;
     outputObj?: boolean;
 }): Promise<Record<string, string>[]>;
 export {};

package/dist/overview/getSemrushRank.js

@@ -1,12 +1,21 @@
 "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 = "us", display_limit = 10, outputObj = true, }) {
+const displayDateValidator_1 = require("../utils/displayDateValidator");
+async function getSemrushRank({ exportColumns = ["Dn", "Rk", "Or", "Ot", "Oc", "Ad", "At", "Ac"], database = "us", displayLimit = 10, displayOffset, displayFilter, displayDate, exportEscape, exportDecode, outputObj = true, }) {
+    if (displayDate && !(0, displayDateValidator_1.displayDateValidator)(displayDate)) {
+        throw new Error("Invalid displayDate format. Format: YYYYMM15");
+    }
     const params = {
         type: "rank",
-        export_columns: export_columns.join(","),
+        export_columns: exportColumns.join(","),
         database,
-        display_limit,
+        display_limit: displayLimit,
+        display_offset: displayOffset,
+        display_filter: displayFilter,
+        display_date: displayDate,
+        export_escape: exportEscape,
+        export_decode: exportDecode,
     };
     return this.get(this.BASE_URL, params, outputObj);
 }

package/dist/trend/getTrafficSummary.d.ts

@@ -1,9 +1,12 @@
 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, }: {
+export declare function getTrafficSummary(this: SemrushAPIClient, { domains, exportColumns, country, displayDate, displayLimit, displayOffset, outputObj, }: {
     domains: string[];
-    export_columns?: ExportColumns[];
+    exportColumns?: ExportColumns[];
     country?: Country;
+    displayDate?: string;
+    displayLimit?: number;
+    displayOffset?: number;
     outputObj?: boolean;
 }): Promise<Record<string, string>[]>;

package/dist/trend/getTrafficSummary.js

@@ -1,12 +1,18 @@
 "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 displayDateValidator_1 = require("../utils/displayDateValidator");
+function getTrafficSummary({ domains, exportColumns = ["target", "visits", "users"], country, displayDate, displayLimit, displayOffset, outputObj = true, }) {
+    if (displayDate && !(0, displayDateValidator_1.displayDateValidator)(displayDate)) {
+        throw new Error("Invalid displayDate format. Format: YYYYMM15");
+    }
     const params = {
         targets: domains.join(","),
-        export_columns: export_columns.join(","),
-        country: country,
+        export_columns: exportColumns.join(","),
+        country,
+        display_date: displayDate,
+        display_limit: displayLimit,
+        display_offset: displayOffset,
     };
     return this.get(this.ANALYTICS_URL + "ta/api/v3/summary", params, outputObj);
 }

package/dist/url/getUrlOrganicSearchKeywords.d.ts

@@ -2,11 +2,16 @@ 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, }: {
+export declare function getUrlOrganicSearchKeywords(this: SemrushAPIClient, { url, exportColumns, database, displayLimit, displayOffset, displaySort, displayFilter, displayDate, exportEscape, exportDecode, outputObj, }: {
     url: string;
-    export_columns?: ExportColumns[];
+    exportColumns?: ExportColumns[];
     database?: Database;
+    displayLimit?: number;
+    displayOffset?: number;
+    displaySort?: DisplaySort;
+    displayFilter?: string;
+    displayDate?: string;
+    exportEscape?: 1;
+    exportDecode?: 0 | 1;
     outputObj?: boolean;
-    display_limit?: number;
-    display_sort?: DisplaySort;
 }): Promise<Record<string, string>[]>;

package/dist/url/getUrlOrganicSearchKeywords.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getUrlOrganicSearchKeywords = getUrlOrganicSearchKeywords;
-function getUrlOrganicSearchKeywords({ url, export_columns = [
+const displayDateValidator_1 = require("../utils/displayDateValidator");
+function getUrlOrganicSearchKeywords({ url, exportColumns = [
     "Ph",
     "Po",
     "Pp",
@@ -19,14 +20,22 @@ function getUrlOrganicSearchKeywords({ url, export_columns = [
     "Ts",
     "In",
     "Pt",
-], database = "us", outputObj = true, display_limit = 10, display_sort, }) {
+], database = "us", displayLimit = 10, displayOffset, displaySort, displayFilter, displayDate, exportEscape, exportDecode, outputObj = true, }) {
+    if (displayDate && !(0, displayDateValidator_1.displayDateValidator)(displayDate)) {
+        throw new Error("Invalid displayDate format. Format: YYYYMM15");
+    }
     const params = {
         url,
         type: "url_organic",
-        export_columns: export_columns.join(","),
+        export_columns: exportColumns.join(","),
         database,
-        display_limit,
-        display_sort,
+        display_limit: displayLimit,
+        display_offset: displayOffset,
+        display_sort: displaySort,
+        display_filter: displayFilter,
+        display_date: displayDate,
+        export_escape: exportEscape,
+        export_decode: exportDecode,
     };
     return this.get(this.BASE_URL, params, outputObj);
 }

package/dist/url/getUrlOverview.d.ts

@@ -2,12 +2,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, }: {
+export declare function getUrlOverview(this: SemrushAPIClient, { url, exportColumns, database, displaySort, displayDate, exportEscape, exportDecode, outputObj, }: {
     url: string;
-    export_columns?: ExportColumns[];
+    exportColumns?: ExportColumns[];
     database?: Database;
+    displaySort?: DisplaySort;
+    displayDate?: string;
+    exportEscape?: 1;
+    exportDecode?: 0 | 1;
     outputObj?: boolean;
-    display_sort?: DisplaySort;
 }): Promise<Record<string, string>[]>;

package/dist/url/getUrlOverview.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getUrlOverview = getUrlOverview;
-function getUrlOverview({ url, export_columns = [
+const displayDateValidator_1 = require("../utils/displayDateValidator");
+function getUrlOverview({ url, exportColumns = [
     "Dn",
     "Or",
     "Xn",
@@ -35,15 +36,19 @@ function getUrlOverview({ url, export_columns = [
     "Srn",
     "Srl",
     "Rk",
-], // Default export columns
-database = "us", outputObj = true, // Default to true for output object
-display_sort, }) {
+], database = "us", displaySort, displayDate, exportEscape, exportDecode, outputObj = true, }) {
+    if (displayDate && !(0, displayDateValidator_1.displayDateValidator)(displayDate)) {
+        throw new Error("Invalid displayDate format. Format: YYYYMM15");
+    }
     const params = {
         url,
         type: "url_rank",
-        export_columns: export_columns.join(","),
+        export_columns: exportColumns.join(","),
         database,
-        display_sort,
+        display_sort: displaySort,
+        display_date: displayDate,
+        export_escape: exportEscape,
+        export_decode: exportDecode,
     };
     return this.get(this.BASE_URL, params, outputObj);
 }

package/dist/url/getUrlPaidSearchKeywords.d.ts

@@ -2,11 +2,16 @@ 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, }: {
+export declare function getUrlPaidSearchKeywords(this: SemrushAPIClient, { url, exportColumns, database, displayLimit, displayOffset, displaySort, displayFilter, displayDate, exportEscape, exportDecode, outputObj, }: {
     url: string;
-    export_columns?: ExportColumns[];
+    exportColumns?: ExportColumns[];
     database?: Database;
-    display_sort?: DisplaySort;
+    displayLimit?: number;
+    displayOffset?: number;
+    displaySort?: DisplaySort;
+    displayFilter?: string;
+    displayDate?: string;
+    exportEscape?: 1;
+    exportDecode?: 0 | 1;
     outputObj?: boolean;
-    display_limit?: number;
 }): Promise<Record<string, string>[]>;

package/dist/url/getUrlPaidSearchKeywords.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getUrlPaidSearchKeywords = getUrlPaidSearchKeywords;
-function getUrlPaidSearchKeywords({ url, export_columns = [
+const displayDateValidator_1 = require("../utils/displayDateValidator");
+function getUrlPaidSearchKeywords({ url, exportColumns = [
     "Ph",
     "Po",
     "Nq",
@@ -15,14 +16,22 @@ function getUrlPaidSearchKeywords({ url, export_columns = [
     "Tt",
     "Ds",
     "Ts",
-], database = "us", display_sort, outputObj = true, display_limit = 10, }) {
+], database = "us", displayLimit = 10, displayOffset, displaySort, displayFilter, displayDate, exportEscape, exportDecode, outputObj = true, }) {
+    if (displayDate && !(0, displayDateValidator_1.displayDateValidator)(displayDate)) {
+        throw new Error("Invalid displayDate format. Format: YYYYMM15");
+    }
     const params = {
         url,
         type: "url_adwords",
-        export_columns: export_columns.join(","),
+        export_columns: exportColumns.join(","),
         database,
-        display_sort,
-        display_limit,
+        display_limit: displayLimit,
+        display_offset: displayOffset,
+        display_sort: displaySort,
+        display_filter: displayFilter,
+        display_date: displayDate,
+        export_escape: exportEscape,
+        export_decode: exportDecode,
     };
     return this.get(this.BASE_URL, params, outputObj);
 }

package/dist/utils/displayDateValidator.d.ts

@@ -0,0 +1 @@
+export declare function displayDateValidator(displayDate?: string): boolean;

package/dist/utils/displayDateValidator.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.displayDateValidator = displayDateValidator;
+function displayDateValidator(displayDate) {
+    if (!displayDate)
+        return true;
+    const regex = /^\d{4}(0[1-9]|1[0-2])15$/;
+    return regex.test(displayDate);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "semrush-api-client",
-  "version": "0.1.24",
+  "version": "1.0.2",
   "description": "",
   "license": "Apache-2.0",
   "main": "dist/index.js",
@@ -33,6 +33,7 @@
     "dist"
   ],
   "devDependencies": {
-    "@types/node": "^22.15.30"
+    "@types/node": "^22.15.30",
+    "typescript": "^5.9.3"
   }
 }