semrush-api-client 0.0.1 → 0.0.2

package/README.md

@@ -1,7 +1,63 @@
 # semrush-api
 
+A Node.js/TypeScript client for accessing the SEMrush API easily.
+
+## Installation
+
+```sh
+npm install semrush-api-client
+```
+
+## Usage Example
+
+First, set your SEMrush API key in your environment variables (e.g., in a `.env` file):
 
-## Usage 
 ```
-npm i semrush-api
+SEMRUSH_API_KEY=your_api_key_here
 ```
+
+Then, use the client in your code:
+
+```ts
+import { SemrushAPIClient } from "semrush-api";
+const client = new SemrushAPIClient({
+  api_key: process.env.SEMRUSH_API_KEY!,
+});
+
+// Get domain rank
+client.getDomainRank({ domain: "apple.com" }).then((data) => {
+  console.log(data);
+});
+
+// Get keyword data
+client.getPhrase({ phrase: "apple" }).then((data) => {
+  console.log(data);
+});
+```
+
+## API Methods
+
+### `getDomainRank(options)`
+
+Fetches ranking information for a specified domain.
+
+- `domain` (string): Target domain
+- `export_columns` (string[], optional): Columns to retrieve
+- `database` (string, optional): Database (country code)
+- `display_limit` (number, optional): Number of results
+
+### `getPhrase(options)`
+
+Fetches information for a specified keyword.
+
+- `phrase` (string): Keyword
+- `export_columns` (string[], optional): Columns to retrieve
+- `database` (string, optional): Database (country code)
+
+## Contributing
+
+Contributions are welcome! Feel free to open issues or submit pull requests to improve this project.
+
+## License
+
+See [LICENSE](LICENSE).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "semrush-api-client",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "",
   "main": "index.js",
   "license": "Apache-2.0",

package/dist/client/index.js

@@ -1,29 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SemrushAPIClient = void 0;
-const axios_1 = __importDefault(require("axios"));
-const getDomainRank_1 = require("../domain/getDomainRank");
-const getPhrase_1 = require("../keyword/getPhrase");
-class SemrushAPIClient {
-    client;
-    api_key;
-    BASE_URL = "https://api.semrush.com/";
-    constructor({ api_key }) {
-        this.api_key = api_key;
-        this.client = axios_1.default.create({
-            baseURL: this.BASE_URL,
-            timeout: 5000,
-        });
-    }
-    async get(url, params) {
-        const allParams = { ...params, key: this.api_key };
-        const response = await this.client.get(url, { params: allParams });
-        return response.data;
-    }
-    getDomainRank = getDomainRank_1.getDomainRank;
-    getPhrase = getPhrase_1.getPhraseAll;
-}
-exports.SemrushAPIClient = SemrushAPIClient;

package/dist/domain/getDomainRank.js

@@ -1,13 +0,0 @@
-"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/index.js

@@ -1,22 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const dotenv_1 = __importDefault(require("dotenv"));
-dotenv_1.default.config();
-__exportStar(require("./client"), exports);

package/dist/keyword/getPhrase.js

@@ -1,12 +0,0 @@
-"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/type/general/database.js

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

package/dist/type/general/exportColumns.js

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