semrush-api-client 0.1.24 → 1.0.2

package/dist/backlinks/backlinksOverview.d.ts

@@ -1,9 +1,10 @@
 import { SemrushAPIClient } from "../client";
 export type BacklinksTargetType = "root_domain" | "domain" | "url";
 export type BacklinkstExportColumns = "ascore" | "total" | "domains_num" | "urls_num" | "ips_num" | "ipclassc_num" | "follows_num" | "nofollows_num" | "sponsored_num" | "ugc_num" | "texts_num" | "images_num" | "forms_num" | "frames_num";
-export declare function getBacklinksOverview(this: SemrushAPIClient, { target, target_type, export_columns, outputObj, }: {
+export declare function getBacklinksOverview(this: SemrushAPIClient, { target, targetType, exportColumns, exportEscape, outputObj, }: {
     target: string;
-    target_type?: BacklinksTargetType;
-    export_columns?: BacklinkstExportColumns[];
+    targetType?: BacklinksTargetType;
+    exportColumns?: BacklinkstExportColumns[];
+    exportEscape?: 1;
     outputObj?: boolean;
 }): Promise<Record<string, string>[]>;

package/dist/backlinks/backlinksOverview.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getBacklinksOverview = getBacklinksOverview;
-async function getBacklinksOverview({ target, target_type = "domain", export_columns = [
+async function getBacklinksOverview({ target, targetType = "domain", exportColumns = [
     "ascore",
     "total",
     "domains_num",
@@ -16,12 +16,13 @@ async function getBacklinksOverview({ target, target_type = "domain", export_col
     "images_num",
     "forms_num",
     "frames_num",
-], outputObj = true, }) {
+], exportEscape, outputObj = true, }) {
     const params = {
         type: "backlinks_overview",
         target,
-        target_type,
-        export_columns: export_columns.join(","),
+        target_type: targetType,
+        export_columns: exportColumns.join(","),
+        export_escape: exportEscape,
     };
     return this.get(this.ANALYTICS_URL + "v1/", params, outputObj);
 }

package/dist/backlinks/getAnchors.d.ts

@@ -2,11 +2,13 @@ import { SemrushAPIClient } from "../client";
 export type AnchorsTargetType = "root_domain" | "domain" | "url";
 export type AnchorsExportColumns = "anchor" | "domains_num" | "backlinks_num" | "first_seen" | "last_seen";
 export type DisplaySort = "page_ascore_asc" | "page_ascore_desc" | "domains_num_asc" | "domains_num_desc" | "backlinks_num_asc" | "backlinks_num_desc" | "first_seen_asc" | "first_seen_desc" | "last_seen_asc" | "last_seen_desc";
-export declare function getAnchors(this: SemrushAPIClient, { target, target_type, export_columns, displaySort, display_limit, outputObj, }: {
+export declare function getAnchors(this: SemrushAPIClient, { target, targetType, exportColumns, displaySort, displayLimit, displayOffset, exportEscape, outputObj, }: {
     target: string;
-    target_type?: AnchorsTargetType;
-    export_columns?: AnchorsExportColumns[];
+    targetType?: AnchorsTargetType;
+    exportColumns?: AnchorsExportColumns[];
     displaySort?: DisplaySort;
+    displayLimit?: number;
+    displayOffset?: number;
+    exportEscape?: 1;
     outputObj?: boolean;
-    display_limit?: number;
 }): Promise<Record<string, string>[]>;

package/dist/backlinks/getAnchors.js

@@ -1,20 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getAnchors = getAnchors;
-async function getAnchors({ target, target_type = "domain", export_columns = [
+async function getAnchors({ target, targetType = "domain", exportColumns = [
     "anchor",
     "domains_num",
     "backlinks_num",
     "first_seen",
     "last_seen",
-], displaySort = "backlinks_num_desc", display_limit = 10, outputObj = true, }) {
+], displaySort = "backlinks_num_desc", displayLimit = 10, displayOffset, exportEscape, outputObj = true, }) {
     const params = {
         type: "backlinks_anchors",
         target,
-        target_type,
+        target_type: targetType,
         display_sort: displaySort,
-        display_limit,
-        export_columns: export_columns.join(","),
+        display_limit: displayLimit,
+        display_offset: displayOffset,
+        export_escape: exportEscape,
+        export_columns: exportColumns.join(","),
     };
     return this.get(this.ANALYTICS_URL + "v1/", params, outputObj);
 }

package/dist/backlinks/getBacklinks.d.ts

@@ -2,11 +2,14 @@ import { SemrushAPIClient } from "../client";
 export type BacklinksTargetType = "root_domain" | "domain" | "url";
 export type BacklinkstExportColumns = "page_ascore" | "response_code" | "source_size" | "external_num" | "internal_num" | "redirect_url" | "source_url" | "source_title" | "image_url" | "target_url" | "target_title" | "anchor" | "image_alt" | "last_seen" | "first_seen" | "nofollow" | "form" | "frame" | "image" | "sitewide" | "newlink" | "lostlink";
 export type DisplaySort = "page_ascore_asc" | "page_ascore_desc" | "last_seen_asc" | "last_seen_desc" | "first_seen_asc" | "first_seen_desc";
-export declare function getBacklinks(this: SemrushAPIClient, { target, target_type, export_columns, displaySort, display_limit, outputObj, }: {
+export declare function getBacklinks(this: SemrushAPIClient, { target, targetType, exportColumns, displaySort, displayLimit, displayOffset, displayFilter, exportEscape, outputObj, }: {
     target: string;
-    target_type?: BacklinksTargetType;
-    export_columns?: BacklinkstExportColumns[];
+    targetType?: BacklinksTargetType;
+    exportColumns?: BacklinkstExportColumns[];
     displaySort?: DisplaySort;
+    displayLimit?: number;
+    displayOffset?: number;
+    displayFilter?: string;
+    exportEscape?: 1;
     outputObj?: boolean;
-    display_limit?: number;
 }): Promise<Record<string, string>[]>;

package/dist/backlinks/getBacklinks.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getBacklinks = getBacklinks;
-async function getBacklinks({ target, target_type = "domain", export_columns = [
+async function getBacklinks({ target, targetType = "domain", exportColumns = [
     "page_ascore",
     "response_code",
     "source_size",
@@ -24,14 +24,17 @@ async function getBacklinks({ target, target_type = "domain", export_columns = [
     "sitewide",
     "newlink",
     "lostlink",
-], displaySort = "page_ascore_desc", display_limit = 10, outputObj = true, }) {
+], displaySort = "page_ascore_desc", displayLimit = 10, displayOffset, displayFilter, exportEscape, outputObj = true, }) {
     const params = {
         type: "backlinks",
         target,
-        target_type,
+        target_type: targetType,
         display_sort: displaySort,
-        display_limit,
-        export_columns: export_columns.join(","),
+        display_limit: displayLimit,
+        display_offset: displayOffset,
+        display_filter: displayFilter,
+        export_escape: exportEscape,
+        export_columns: exportColumns.join(","),
     };
     return this.get(this.ANALYTICS_URL + "v1/", params, outputObj);
 }

package/dist/backlinks/getIndexedPages.d.ts

@@ -2,11 +2,13 @@ import { SemrushAPIClient } from "../client";
 export type IndexedPageTargetType = "root_domain" | "domain" | "url";
 export type ExportColumns = "source_url" | "source_title" | "response_code" | "backlinks_num" | "domains_num" | "last_seen" | "external_num" | "internal_num";
 export type DisplaySort = "backlinks_num_asc" | "backlinks_num_desc" | "domains_num_asc" | "domains_num_desc" | "last_seen_asc" | "last_seen_desc";
-export declare function getIndexedPages(this: SemrushAPIClient, { target, target_type, export_columns, displaySort, display_limit, outputObj, }: {
+export declare function getIndexedPages(this: SemrushAPIClient, { target, targetType, exportColumns, displaySort, displayLimit, displayOffset, exportEscape, outputObj, }: {
     target: string;
-    target_type?: IndexedPageTargetType;
-    export_columns?: ExportColumns[];
+    targetType?: IndexedPageTargetType;
+    exportColumns?: ExportColumns[];
     displaySort?: DisplaySort;
+    displayLimit?: number;
+    displayOffset?: number;
+    exportEscape?: 1;
     outputObj?: boolean;
-    display_limit?: number;
 }): Promise<Record<string, string>[]>;

package/dist/backlinks/getIndexedPages.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getIndexedPages = getIndexedPages;
-async function getIndexedPages({ target, target_type = "domain", export_columns = [
+async function getIndexedPages({ target, targetType = "domain", exportColumns = [
     "source_url",
     "source_title",
     "response_code",
@@ -10,14 +10,16 @@ async function getIndexedPages({ target, target_type = "domain", export_columns
     "last_seen",
     "external_num",
     "internal_num",
-], displaySort = "backlinks_num_desc", display_limit = 10, outputObj = true, }) {
+], displaySort = "backlinks_num_desc", displayLimit = 10, displayOffset, exportEscape, outputObj = true, }) {
     const params = {
         type: "backlinks_pages",
         target,
-        target_type,
+        target_type: targetType,
         display_sort: displaySort,
-        display_limit,
-        export_columns: export_columns.join(","),
+        display_limit: displayLimit,
+        display_offset: displayOffset,
+        export_escape: exportEscape,
+        export_columns: exportColumns.join(","),
     };
     return this.get(this.ANALYTICS_URL + "v1/", params, outputObj);
 }

package/dist/backlinks/getReferringDomains.d.ts

@@ -2,11 +2,14 @@ import { SemrushAPIClient } from "../client";
 export type TargetType = "root_domain" | "domain" | "url";
 export type ExportColumns = "domain_ascore" | "domain_score" | "domain" | "backlinks_num" | "domain_trust_score" | "ip" | "country" | "first_seen" | "last_seen";
 export type DisplaySort = "domain_ascore_asc" | "domain_ascore_desc" | "backlinks_num_asc" | "backlinks_num_desc" | "last_seen_asc" | "last_seen_desc" | "first_seen_asc" | "first_seen_desc";
-export declare function getReferringDomains(this: SemrushAPIClient, { target, target_type, export_columns, displaySort, display_limit, outputObj, }: {
+export declare function getReferringDomains(this: SemrushAPIClient, { target, targetType, exportColumns, displaySort, displayLimit, displayOffset, displayFilter, exportEscape, outputObj, }: {
     target: string;
-    target_type?: TargetType;
-    export_columns?: ExportColumns[];
+    targetType?: TargetType;
+    exportColumns?: ExportColumns[];
     displaySort?: DisplaySort;
+    displayLimit?: number;
+    displayOffset?: number;
+    displayFilter?: string;
+    exportEscape?: 1;
     outputObj?: boolean;
-    display_limit?: number;
 }): Promise<Record<string, string>[]>;

package/dist/backlinks/getReferringDomains.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getReferringDomains = getReferringDomains;
-async function getReferringDomains({ target, target_type = "domain", export_columns = [
+async function getReferringDomains({ target, targetType = "domain", exportColumns = [
     "domain_ascore",
     "domain_score",
     "domain",
@@ -11,14 +11,17 @@ async function getReferringDomains({ target, target_type = "domain", export_colu
     "country",
     "first_seen",
     "last_seen",
-], displaySort = "backlinks_num_desc", display_limit = 10, outputObj = true, }) {
+], displaySort = "backlinks_num_desc", displayLimit = 10, displayOffset, displayFilter, exportEscape, outputObj = true, }) {
     const params = {
         type: "backlinks_refdomains",
         target,
-        target_type,
+        target_type: targetType,
         display_sort: displaySort,
-        display_limit,
-        export_columns: export_columns.join(","),
+        display_limit: displayLimit,
+        display_offset: displayOffset,
+        display_filter: displayFilter,
+        export_escape: exportEscape,
+        export_columns: exportColumns.join(","),
     };
     return this.get(this.ANALYTICS_URL + "v1/", params, outputObj);
 }

package/dist/client/index.d.ts

@@ -1,5 +1,5 @@
 import { getDomainOverview, getDomainOrganicSearchKeywords, getDomainPaidSearchKeywords, getAdsCopies } from "../domain";
-import { getKeywordOverview, getKeywordDifficulty, getRelatedKeywords, getPhraseQuestions, getBroadMatchKeywords } from "../keyword";
+import { getKeywordOverview, getKeywordDifficulty, getRelatedKeywords, getPhraseQuestions, getBroadMatchKeywords, getKeywordOrganic } from "../keyword";
 import { getBacklinksOverview, getBacklinks, getAnchors, getIndexedPages, getReferringDomains } from "../backlinks";
 import { getRankDifference, getSemrushRank } from "../overview";
 import { getTrafficSummary } from "../trend";
@@ -23,6 +23,7 @@ export declare class SemrushAPIClient {
     getRelatedKeywords: typeof getRelatedKeywords;
     getPhraseQuestions: typeof getPhraseQuestions;
     getBroadMatchKeywords: typeof getBroadMatchKeywords;
+    getKeywordOrganic: typeof getKeywordOrganic;
     getBacklinksOverview: typeof getBacklinksOverview;
     getBacklinks: typeof getBacklinks;
     getAnchors: typeof getAnchors;

package/dist/client/index.js

@@ -67,6 +67,7 @@ class SemrushAPIClient {
     getRelatedKeywords = keyword_1.getRelatedKeywords;
     getPhraseQuestions = keyword_1.getPhraseQuestions;
     getBroadMatchKeywords = keyword_1.getBroadMatchKeywords;
+    getKeywordOrganic = keyword_1.getKeywordOrganic;
     // Backlinks methods
     getBacklinksOverview = backlinks_1.getBacklinksOverview;
     getBacklinks = backlinks_1.getBacklinks;

package/dist/domain/getAdsCopies.d.ts

@@ -1,11 +1,18 @@
 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, }: {
+export type AdsCopiesDisplaySort = "tr_asc" | "tr_desc" | "tc_asc" | "tc_desc";
+export declare function getAdsCopies(this: SemrushAPIClient, { domain, exportColumns, database, displayLimit, displayOffset, displaySort, displayFilter, displayDate, exportEscape, exportDecode, outputObj, }: {
     domain: string;
-    export_columns?: ExportColumns[];
+    exportColumns?: ExportColumns[];
     database?: Database;
+    displayLimit?: number;
+    displayOffset?: number;
+    displaySort?: AdsCopiesDisplaySort;
+    displayFilter?: string;
+    displayDate?: string;
+    exportEscape?: 1;
+    exportDecode?: 0 | 1;
     outputObj?: boolean;
-    display_limit?: number;
 }): Promise<Record<string, string>[]>;
 export {};

package/dist/domain/getAdsCopies.js

@@ -1,13 +1,23 @@
 "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 = 10, outputObj = true, }) {
+const displayDateValidator_1 = require("../utils/displayDateValidator");
+async function getAdsCopies({ domain, exportColumns = ["Tt", "Ds", "Vu", "Ur", "Pc", "Un"], 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 = {
         type: "domain_adwords_unique",
-        export_columns: export_columns.join(","),
+        export_columns: exportColumns.join(","),
         domain,
         database,
-        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/domain/getDomainOrganicSearchKeywords.d.ts

@@ -3,13 +3,20 @@ 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 displayPositions = "new" | "lost" | "rise" | "fall";
 type displayPositionType = "organic" | "all" | "serp_features";
-export declare function getDomainOrganicSearchKeywords(this: SemrushAPIClient, { domain, export_columns, database, displayPosition, displayPositionsType, display_limit, outputObj, }: {
+export type DomainOrganicDisplaySort = "po_asc" | "po_desc" | "tr_asc" | "tr_desc" | "tc_asc" | "tc_desc" | "nq_asc" | "nq_desc" | "cp_asc" | "cp_desc" | "co_asc" | "co_desc" | "kd_asc" | "kd_desc";
+export declare function getDomainOrganicSearchKeywords(this: SemrushAPIClient, { domain, exportColumns, database, displayPosition, displayPositionsType, displayLimit, displayOffset, displaySort, displayFilter, displayDate, exportEscape, exportDecode, outputObj, }: {
     domain: string;
-    export_columns?: ExportColumns[];
-    displayPosition?: displayPositions;
+    exportColumns?: ExportColumns[];
     database?: Database;
-    outputObj?: boolean;
+    displayPosition?: displayPositions;
     displayPositionsType?: displayPositionType;
-    display_limit?: number;
+    displayLimit?: number;
+    displayOffset?: number;
+    displaySort?: DomainOrganicDisplaySort;
+    displayFilter?: string;
+    displayDate?: string;
+    exportEscape?: 1;
+    exportDecode?: 0 | 1;
+    outputObj?: boolean;
 }): Promise<Record<string, string>[]>;
 export {};

package/dist/domain/getDomainOrganicSearchKeywords.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDomainOrganicSearchKeywords = getDomainOrganicSearchKeywords;
-async function getDomainOrganicSearchKeywords({ domain, export_columns = [
+const displayDateValidator_1 = require("../utils/displayDateValidator");
+async function getDomainOrganicSearchKeywords({ domain, exportColumns = [
     "Ph",
     "Po",
     "Pp",
@@ -14,15 +15,24 @@ async function getDomainOrganicSearchKeywords({ domain, export_columns = [
     "Co",
     "Nr",
     "Td",
-], database = "us", displayPosition, displayPositionsType, display_limit = 10, outputObj = true, }) {
+], database = "us", displayPosition, displayPositionsType, 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 = {
         type: "domain_organic",
-        export_columns: export_columns.join(","),
+        export_columns: exportColumns.join(","),
         domain,
         database,
         display_position: displayPosition,
         display_positions_type: displayPositionsType,
-        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/domain/getDomainOverview.d.ts

@@ -1,11 +1,15 @@
 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, displayDate, display_limit, outputObj, }: {
+export type DomainOverviewDisplaySort = "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 getDomainOverview(this: SemrushAPIClient, { domain, exportColumns, database, displayDate, displayLimit, displayOffset, displaySort, exportEscape, outputObj, }: {
     domain: string;
-    export_columns?: ExportColumns[];
+    exportColumns?: ExportColumns[];
     database?: Database;
-    display_limit?: number;
-    outputObj?: boolean;
     displayDate?: string;
+    displayLimit?: number;
+    displayOffset?: number;
+    displaySort?: DomainOverviewDisplaySort;
+    exportEscape?: 1;
+    outputObj?: boolean;
 }): Promise<Record<string, string>[]>;

package/dist/domain/getDomainOverview.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDomainOverview = getDomainOverview;
-async function getDomainOverview({ domain, export_columns = [
+const displayDateValidator_1 = require("../utils/displayDateValidator");
+async function getDomainOverview({ domain, exportColumns = [
     "Db",
     "Dt",
     "Dn",
@@ -23,14 +24,20 @@ async function getDomainOverview({ domain, export_columns = [
     "Sc",
     "Srn",
     "Srl",
-], database = "us", displayDate, display_limit = 10, outputObj = true, }) {
+], database = "us", displayDate, displayLimit = 10, displayOffset, displaySort, exportEscape, outputObj = true, }) {
+    if (displayDate && !(0, displayDateValidator_1.displayDateValidator)(displayDate)) {
+        throw new Error("Invalid displayDate format. Format: YYYYMM15");
+    }
     const params = {
         type: "domain_ranks",
-        export_columns: export_columns.join(","),
+        export_columns: exportColumns.join(","),
         domain,
         database,
-        displayDate: displayDate,
-        display_limit,
+        display_date: displayDate,
+        display_limit: displayLimit,
+        display_offset: displayOffset,
+        display_sort: displaySort,
+        export_escape: exportEscape,
     };
     return this.get(this.BASE_URL, params, outputObj);
 }

package/dist/domain/getDomainPaidSearchKeywords.d.ts

@@ -2,12 +2,19 @@ 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, }: {
+export type DomainPaidDisplaySort = "po_asc" | "po_desc" | "tr_asc" | "tr_desc" | "tc_asc" | "tc_desc" | "nq_asc" | "nq_desc" | "cp_asc" | "cp_desc" | "co_asc" | "co_desc";
+export declare function getDomainPaidSearchKeywords(this: SemrushAPIClient, { domain, exportColumns, database, displayPosition, displayLimit, displayOffset, displaySort, displayFilter, displayDate, exportEscape, exportDecode, outputObj, }: {
     domain: string;
-    export_columns?: ExportColumns[];
-    displayPosition?: displayPositions;
+    exportColumns?: ExportColumns[];
     database?: Database;
+    displayPosition?: displayPositions;
+    displayLimit?: number;
+    displayOffset?: number;
+    displaySort?: DomainPaidDisplaySort;
+    displayFilter?: string;
+    displayDate?: string;
+    exportEscape?: 1;
+    exportDecode?: 0 | 1;
     outputObj?: boolean;
-    display_limit?: number;
 }): Promise<Record<string, string>[]>;
 export {};

package/dist/domain/getDomainPaidSearchKeywords.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDomainPaidSearchKeywords = getDomainPaidSearchKeywords;
-async function getDomainPaidSearchKeywords({ domain, export_columns = [
+const displayDateValidator_1 = require("../utils/displayDateValidator");
+async function getDomainPaidSearchKeywords({ domain, exportColumns = [
     "Ph",
     "Po",
     "Pp",
@@ -14,14 +15,23 @@ async function getDomainPaidSearchKeywords({ domain, export_columns = [
     "Co",
     "Nr",
     "Td",
-], database = "us", displayPosition, display_limit = 1000, outputObj = true, }) {
+], database = "us", displayPosition, displayLimit = 1000, 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 = {
         type: "domain_adwords",
-        export_columns: export_columns.join(","),
+        export_columns: exportColumns.join(","),
         domain,
         database,
         display_position: displayPosition,
-        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/domain/getDomainRank.d.ts

@@ -0,0 +1,9 @@
+import { SemrushAPIClient } from "../client";
+import { Database } from "../type/general/database";
+import { ExportColumns } from "../type/general/exportColumns";
+export declare function getDomainRank(this: SemrushAPIClient, { domain, export_columns, database, display_limit, }: {
+    domain: string;
+    export_columns?: ExportColumns[];
+    database?: Database;
+    display_limit?: number;
+}): Promise<string>;

package/dist/domain/getDomainRank.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDomainRank = getDomainRank;
+async function getDomainRank({ domain, export_columns = ["Dn", "Or", "Rk", "Ot", "Oc"], database = "us", display_limit = 1000, }) {
+    const params = {
+        type: "domain_ranks",
+        export_columns: export_columns.join(","),
+        domain,
+        database,
+        display_limit,
+    };
+    return this.get("", params);
+}

package/dist/keyword/getBroadMatchKeywords.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" | "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, }: {
+export declare function getBroadMatchKeywords(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/getBroadMatchKeywords.js

@@ -1,14 +1,18 @@
 "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 = 10, outputObj = true, }) {
+async function getBroadMatchKeywords({ 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_fullsearch",
         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/getKeywordDifficulty.d.ts

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

package/dist/keyword/getKeywordDifficulty.js

@@ -1,13 +1,14 @@
 "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
- }) {
+async function getKeywordDifficulty({ phrases, exportColumns = ["Ph", "Kd"], database = "us", exportEscape, exportDecode, outputObj = true, }) {
     const params = {
         type: "phrase_kdi",
-        export_columns: export_columns.join(","),
+        export_columns: exportColumns.join(","),
         phrase: phrases.join(";"),
         database,
+        export_escape: exportEscape,
+        export_decode: exportDecode,
     };
     return this.get(this.BASE_URL, params, outputObj);
 }

package/dist/keyword/getKeywordOrganic.d.ts

@@ -0,0 +1,17 @@
+import { SemrushAPIClient } from "../client";
+import { Database } from "../type/general/database";
+type KeywordExportColumns = "Po" | "Pt" | "Dn" | "Ur" | "Fk" | "Fp" | "Fl";
+export type KeywordOrganicDisplaySort = "po_asc" | "po_desc" | "tr_asc" | "tr_desc";
+export declare function getKeywordOrganic(this: SemrushAPIClient, { phrase, exportColumns, database, displayLimit, displayOffset, displaySort, displayFilter, exportEscape, exportDecode, outputObj, }: {
+    phrase: string;
+    exportColumns?: KeywordExportColumns[];
+    database?: Database;
+    displayLimit?: number;
+    displayOffset?: number;
+    displaySort?: KeywordOrganicDisplaySort;
+    displayFilter?: string;
+    exportEscape?: 1;
+    exportDecode?: 0 | 1;
+    outputObj?: boolean;
+}): Promise<Record<string, string>[]>;
+export {};