semrush-api-client 0.1.12 → 0.1.14

package/dist/backlinks/getIndexedPages.d.ts

@@ -0,0 +1,12 @@
+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, }: {
+    target: string;
+    target_type?: IndexedPageTargetType;
+    export_columns?: ExportColumns[];
+    displaySort?: DisplaySort;
+    outputObj?: boolean;
+    display_limit?: number;
+}): Promise<string | Record<string, string>[]>;

package/dist/backlinks/getIndexedPages.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getIndexedPages = getIndexedPages;
+async function getIndexedPages({ target, target_type = "domain", export_columns = [
+    "source_url",
+    "source_title",
+    "response_code",
+    "backlinks_num",
+    "domains_num",
+    "last_seen",
+    "external_num",
+    "internal_num",
+], displaySort = "backlinks_num_desc", display_limit = 1000, outputObj = true, }) {
+    const params = {
+        type: "backlinks_pages",
+        target,
+        target_type,
+        display_sort: displaySort,
+        display_limit,
+        export_columns: export_columns.join(","),
+    };
+    return this.get(this.ANALYTICS_URL + "v1/", params, outputObj);
+}

package/dist/backlinks/getReferringDomains.d.ts

@@ -0,0 +1,12 @@
+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, }: {
+    target: string;
+    target_type?: TargetType;
+    export_columns?: ExportColumns[];
+    displaySort?: DisplaySort;
+    outputObj?: boolean;
+    display_limit?: number;
+}): Promise<string | Record<string, string>[]>;

package/dist/backlinks/getReferringDomains.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getReferringDomains = getReferringDomains;
+async function getReferringDomains({ target, target_type = "domain", export_columns = [
+    "domain_ascore",
+    "domain_score",
+    "domain",
+    "backlinks_num",
+    "domain_trust_score",
+    "ip",
+    "country",
+    "first_seen",
+    "last_seen",
+], displaySort = "backlinks_num_desc", display_limit = 1000, outputObj = true, }) {
+    const params = {
+        type: "backlinks_refdomains",
+        target,
+        target_type,
+        display_sort: displaySort,
+        display_limit,
+        export_columns: export_columns.join(","),
+    };
+    return this.get(this.ANALYTICS_URL + "v1/", params, outputObj);
+}

package/dist/client/index.d.ts

@@ -10,6 +10,10 @@ 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";
 export declare class SemrushAPIClient {
     private client;
     private api_key;
@@ -32,4 +36,8 @@ export declare class SemrushAPIClient {
     getKeywordDifficulty: typeof getKeywordDifficulty;
     getBacklinks: typeof getBacklinks;
     getAnchors: typeof getAnchors;
+    getIndexedPages: typeof getIndexedPages;
+    getReferringDomains: typeof getReferringDomains;
+    getRelatedKeywords: typeof getRelatedKeywords;
+    getPhraseQuestions: typeof getPhraseQuestions;
 }

package/dist/client/index.js

@@ -17,6 +17,10 @@ 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");
 class SemrushAPIClient {
     client;
     api_key;
@@ -74,5 +78,9 @@ class SemrushAPIClient {
     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;
 }
 exports.SemrushAPIClient = SemrushAPIClient;

package/dist/domain/getAdsCopies.js

@@ -1,7 +1,7 @@
 "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, }) {
+async function getAdsCopies({ domain, export_columns = ["Tt", "Ds", "Vu", "Ur", "Pc", "Un"], database, display_limit = 1000, outputObj = true, }) {
     const params = {
         type: "domain_adwords_unique",
         export_columns: export_columns.join(","),

package/dist/domain/getDomainOrganic.js

@@ -14,7 +14,7 @@ async function getDomainOrganic({ domain, export_columns = [
     "Co",
     "Nr",
     "Td",
-], database = "us", displayPosition, displayPositionsType, display_limit = 1000, outputObj = true, }) {
+], database, displayPosition, displayPositionsType, display_limit = 1000, outputObj = true, }) {
     const params = {
         type: "domain_organic",
         export_columns: export_columns.join(","),

package/dist/domain/getDomainPaidSearchKeywords.js

@@ -14,7 +14,7 @@ async function getDomainPaidSearchKeywords({ domain, export_columns = [
     "Co",
     "Nr",
     "Td",
-], database = "us", displayPosition, display_limit = 1000, outputObj = true, }) {
+], database, displayPosition, display_limit = 1000, outputObj = true, }) {
     const params = {
         type: "domain_adwords",
         export_columns: export_columns.join(","),

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 = "us", outputObj = true, // Default to true for output object
+async function getKeywordDifficulty({ phrases, export_columns = ["Ph", "Kd"], database, 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 = "us", outputObj = true, // Default to true for output object
+async function getKeywordOverview({ phrase, export_columns = ["Dt", "Db", "Ph", "Nq", "Cp", "Co", "Nr"], database, outputObj = true, // Default to true for output object
  }) {
     const params = {
         type: "phrase_all",

package/dist/keyword/getPhraseQuestions.d.ts

@@ -0,0 +1,13 @@
+import { SemrushAPIClient } from "../client";
+import { Database } from "../type/general/database";
+export type IndexedPagephraseType = "root_domain" | "domain" | "url";
+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, }: {
+    phrase: string;
+    database?: Database;
+    export_columns?: ExportColumns[];
+    displaySort?: DisplaySort;
+    outputObj?: boolean;
+    display_limit?: number;
+}): Promise<string | Record<string, string>[]>;

package/dist/keyword/getPhraseQuestions.js

@@ -0,0 +1,14 @@
+"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, displaySort = "nq_desc", display_limit = 1000, outputObj = true, }) {
+    const params = {
+        type: "phrase_questions",
+        phrase,
+        database,
+        display_sort: displaySort,
+        display_limit,
+        export_columns: export_columns.join(","),
+    };
+    return this.get(this.ANALYTICS_URL, params, outputObj);
+}

package/dist/keyword/getRelatedKeywords.d.ts

@@ -0,0 +1,13 @@
+import { SemrushAPIClient } from "../client";
+import { Database } from "../type/general/database";
+export type IndexedPagephraseType = "root_domain" | "domain" | "url";
+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, }: {
+    phrase: string;
+    database?: Database;
+    export_columns?: ExportColumns[];
+    displaySort?: DisplaySort;
+    outputObj?: boolean;
+    display_limit?: number;
+}): Promise<string | Record<string, string>[]>;

package/dist/keyword/getRelatedKeywords.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRelatedKeywords = getRelatedKeywords;
+async function getRelatedKeywords({ phrase, export_columns = [
+    "Ph",
+    "Nq",
+    "Cp",
+    "Co",
+    "Nr",
+    "Td",
+    "Rr",
+    "Fk",
+    "In",
+    "Kd",
+], database, displaySort = "nq_desc", display_limit = 1000, outputObj = true, }) {
+    const params = {
+        type: "phrase_related",
+        phrase,
+        database,
+        display_sort: displaySort,
+        display_limit,
+        export_columns: export_columns.join(","),
+    };
+    return this.get(this.ANALYTICS_URL, params, outputObj);
+}

package/dist/overview/getDomainOverview.js

@@ -23,7 +23,7 @@ async function getDomainOverview({ domain, export_columns = [
     "Sc",
     "Srn",
     "Srl",
-], database = "us", display_limit = 1000, outputObj = true, }) {
+], database, display_limit = 1000, outputObj = true, }) {
     const params = {
         type: "domain_ranks",
         export_columns: export_columns.join(","),

package/dist/overview/getRankDifference.js

@@ -12,7 +12,7 @@ async function getRankDifference({ domain, export_columns = [
     "At",
     "Ac",
     "Sh",
-], database = "us", display_limit = 1000, outputObj = true, }) {
+], database, display_limit = 1000, outputObj = true, }) {
     const params = {
         type: "rank_difference",
         export_columns: export_columns.join(","),

package/dist/overview/getSemrushRank.js

@@ -1,7 +1,7 @@
 "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 = 1000, outputObj = true, }) {
+async function getSemrushRank({ export_columns = ["Dn", "Rk", "Or", "Ot", "Oc", "Ad", "At", "Ac"], database, display_limit = 1000, outputObj = true, }) {
     const params = {
         type: "rank",
         export_columns: export_columns.join(","),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "semrush-api-client",
-  "version": "0.1.12",
+  "version": "0.1.14",
   "description": "",
   "license": "Apache-2.0",
   "main": "dist/index.js",