semrush-api-client 0.1.4 → 0.1.6

package/README.md

@@ -1,5 +1,6 @@
 # semrush-api-client
 [![Version badge](https://img.shields.io/github/v/release/RenKoya1/semrush-api-client?include_prereleases)](https://github.com//RenKoya1/semrush-api-client)
+[![npm version](https://img.shields.io/npm/v/semrush-api-client)](https://www.npmjs.com/package/semrush-api-client)
 
 A Node.js/TypeScript client for accessing the SEMrush API easily.
 

package/dist/client/index.d.ts

@@ -1,7 +1,9 @@
-import { getDomainRank } from "../domain/getDomainRank";
+import { getDomainOverview } from "../overview/getDomainOverview";
 import { getPhraseAll } from "../keyword/getPhrase";
 import { backlinksOverview } from "../backlinks/backlinksOverview";
 import { getRankDifference } from "../overview/getRankDifference";
+import { getDomainOrganic } from "../domain/getDomainOrganic";
+import { getSemrushRank } from "../overview/getSemrushRank";
 export declare class SemrushAPIClient {
     private client;
     private api_key;
@@ -12,8 +14,10 @@ export declare class SemrushAPIClient {
     });
     parseCsvToObjects(csvString: string, delimiter?: string): Record<string, string>[];
     get<T>(url: string, params?: Record<string, any>, outputObj?: boolean): Promise<T>;
-    getDomainRank: typeof getDomainRank;
+    getDomainOverview: typeof getDomainOverview;
     getPhrase: typeof getPhraseAll;
     backlinksOverview: typeof backlinksOverview;
     getRankDifference: typeof getRankDifference;
+    getSemrushRank: typeof getSemrushRank;
+    getDomainOrganic: typeof getDomainOrganic;
 }

package/dist/client/index.js

@@ -5,10 +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 getDomainRank_1 = require("../domain/getDomainRank");
+const getDomainOverview_1 = require("../overview/getDomainOverview");
 const getPhrase_1 = require("../keyword/getPhrase");
 const backlinksOverview_1 = require("../backlinks/backlinksOverview");
 const getRankDifference_1 = require("../overview/getRankDifference");
+const getDomainOrganic_1 = require("../domain/getDomainOrganic");
+const getSemrushRank_1 = require("../overview/getSemrushRank");
 class SemrushAPIClient {
     client;
     api_key;
@@ -17,7 +19,7 @@ class SemrushAPIClient {
     constructor({ api_key }) {
         this.api_key = api_key;
         this.client = axios_1.default.create({
-            timeout: 5000,
+            timeout: 10000,
         });
     }
     parseCsvToObjects(csvString, delimiter = ";") {
@@ -54,9 +56,11 @@ class SemrushAPIClient {
             }
         }
     }
-    getDomainRank = getDomainRank_1.getDomainRank;
+    getDomainOverview = getDomainOverview_1.getDomainOverview;
     getPhrase = getPhrase_1.getPhraseAll;
     backlinksOverview = backlinksOverview_1.backlinksOverview;
     getRankDifference = getRankDifference_1.getRankDifference;
+    getSemrushRank = getSemrushRank_1.getSemrushRank;
+    getDomainOrganic = getDomainOrganic_1.getDomainOrganic;
 }
 exports.SemrushAPIClient = SemrushAPIClient;

package/dist/domain/getDomainOrganic.d.ts

@@ -0,0 +1,15 @@
+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 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;
+    database?: Database;
+    outputObj?: boolean;
+    displayPositionsType?: displayPositionType;
+    display_limit?: number;
+}): Promise<string>;
+export {};

package/dist/domain/getDomainOrganic.js

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

package/dist/{domain/getDomainRank.d.ts → overview/getDomainOverview.d.ts}

@@ -1,7 +1,7 @@
 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, outputObj, }: {
+export declare function getDomainOverview(this: SemrushAPIClient, { domain, export_columns, database, display_limit, outputObj, }: {
     domain: string;
     export_columns?: ExportColumns[];
     database?: Database;

package/dist/{domain/getDomainRank.js → overview/getDomainOverview.js}

@@ -1,7 +1,7 @@
 "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, outputObj = true, // Default to true for output object
+exports.getDomainOverview = getDomainOverview;
+async function getDomainOverview({ domain, export_columns = ["Dn", "Or", "Rk", "Ot", "Oc"], database = "us", display_limit = 1000, outputObj = true, // Default to true for output object
  }) {
     const params = {
         type: "domain_ranks",

package/dist/overview/getSemrushRank.d.ts

@@ -0,0 +1,10 @@
+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[];
+    database?: Database;
+    display_limit?: number;
+    outputObj?: boolean;
+}): Promise<string>;
+export {};

package/dist/overview/getSemrushRank.js

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

package/package.json

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