google-finance-quote 1.0.0

package/README.md

@@ -0,0 +1,46 @@
+# google-finance-quote
+Node Google Finance API wrapper for free.
+No API key is required!
+
+## Usage
+### Get Started
+```js
+const Finance = require("google-finance-quote");
+
+const finance = new Finance(); // You can use this: new Finance({ from 'usd', to: 'jpy' });
+// You can use http(s) proxies.
+/*
+const proxy = {
+  host: 'example.com',
+  port: 2000,
+  protocol: 'http'
+}
+const finance = new Finance({ proxy });
+*/
+
+finance
+  .setFrom('usd');
+  .setTo('jpy');
+
+(async () => {
+  console.log(await finance.quote()); // { success: true, rate: 150.94225699999998 }
+})();
+```
+### Class
+<strong>Finance({ from?:string, to?:string, proxy?:object })</strong>
+
+### Functions
+- <strong>.setFrom(from: string)</strong>
+Set the parameter of from.
+
+- <strong>.setTo(to: string)</strong>
+Set the parameter of to.
+
+- <strong>.getParam(): object</strong>
+Returns the current param.
+
+- <strong>.quote(amount?: number): Promise<{ success: boolean, rate: number }></strong>
+Returns the converted amount based on the exchange rate.
+> Note: If the current rate cannot be obtained due to rate limits or network errors, success: false is returned.
+## Get Support
+<a href="https://discord.gg/yKW8wWKCnS"><img src="https://discordapp.com/api/guilds/1005287561582878800/widget.png?style=banner4" alt="Discord Banner"/></a>

package/index.d.ts

@@ -0,0 +1,71 @@
+declare module 'google-finance-quote' {
+  /**
+   * @interface Proxy
+   * @description Interface for proxy parameters.
+   * @property {string} host - Proxy host name.
+   * @property {number | undefined} - Proxy port number.
+   * @property {'http' | 'https'} protocol - Proxy protocol type.
+   */
+  interface Proxy {
+    host: string;
+    port?: number,
+    protocol: 'http' | 'https';
+  }
+
+  /**
+   * @interface FinanceParams
+   * @description Interface for Finance class constructor parameters.
+   * @property {string} from - The original currency unit.
+   * @property {string} to - The desired currency unit.
+   * @property {Proxy | undefined} proxy - Proxy options.
+   */
+  interface FinanceParams {
+    from: string;
+    to: string;
+  }
+
+  /**
+   * @class Finance
+   * @description The Finance class is designed to easily check the exchange rate.
+   * @param {FinanceParams | undefined} p - The parameters, including p.from and p.to.
+   */
+  class Finance {
+    private param: FinanceParams;
+
+    constructor(p?: FinanceParams);
+
+    /**
+     * @function setFrom
+     * @description Set the parameter of from.
+     * @param {string} from - The original currency unit.
+     * @returns {Finance} Returns the instance of Finance for chaining.
+     */
+    setFrom(from: string): Finance;
+
+    /**
+     * @function setTo
+     * @description Set the parameter of to.
+     * @param {string} to - The desired currency unit.
+     * @returns {Finance} Returns the instance of Finance for chaining.
+     */
+    setTo(to: string): Finance;
+
+    /**
+     * @function getParam
+     * @description Returns the current param.
+     * @returns {FinanceParams} Returns the current param.
+     */
+    getParam(): FinanceParams;
+
+    /**
+     * @async
+     * @function quote
+     * @description Returns the current finance rate.
+     * @param {number} [amount=1] - The amount to convert.
+     * @returns {Promise<{ success: boolean; rate: number }>} Returns the converted amount based on the exchange rate.
+     */
+    quote(amount?: number): Promise<{ success: boolean; rate: number }>;
+  }
+
+  export = Finance;
+}

package/index.js

@@ -0,0 +1,134 @@
+const axios = require('axios');
+const HttpsProxyAgent = require('https-proxy-agent');
+const { API_URL } = require('./lib/config');
+
+/**
+ * @class Finance
+ * @description The Finance class is designed to easily check the exchange rate.
+ * @param {Object} p - The param includes p.from and p.to.
+ * @param {string} p.from - The original currency unit.
+ * @param {string} p.to - The desired currency unit.
+ * @param {object | undefined} p.proxy - Proxy options.
+ */
+class Finance {
+  constructor(p) {
+    if (
+      typeof p === 'object' &&
+      typeof p?.from === 'string' &&
+      typeof p?.to === 'string'
+    ) {
+      this.param = {
+        from: p.from,
+        to: p.to
+      };
+    } else if (typeof p === 'undefined') {
+      this.param = {
+        from: undefined,
+        to: undefined
+      };
+    } else throw new Error('Invalid parameters.');
+
+    this.proxy = {};
+    if (typeof p?.proxy === 'object') {
+      if (
+        typeof p.proxy?.host === 'string' &&
+        (
+          p.proxy.protocol === 'http' ||
+          p.proxy.protocol === 'https'
+        )
+      ) {
+        this.proxy.host = p.proxy.host;
+        if (typeof p.proxy?.port === 'number') this.proxy.port = p.proxy.port;
+        this.proxy.protocol = p.proxy.protocol;
+      }
+    }
+  }
+
+  /**
+   * @function setFrom
+   * @description Set the parameter of from.
+   * @param {string} from - The original currency unit.
+   * @returns {Finance} Returns the instance of Finance for chaining.
+   */
+  setFrom(from) {
+    if (typeof from !== 'string') throw new Error('from must be string.');
+    this.param.from = from;
+    return this;
+  }
+
+  /**
+   * @function setTo
+   * @description Set the parameter of to.
+   * @param {string} to - The desired currency unit.
+   * @returns {Finance} Returns the instance of Finance for chaining.
+   */
+  setTo(to) {
+    if (typeof to !== 'string') throw new Error('to must be string.');
+    this.param.to = to;
+    return this;
+  }
+  
+  /**
+   * @function getParam
+   * @description Returns the current param.
+   * @returns Returns the current param.
+   */
+  getParam() {
+    return this.param;
+  }
+
+  /**
+   * @async
+   * @function quote
+   * @description Returns the current finance.
+   * @param {number} [amount=1] - The amount to convert.
+   * @returns Returns the current finance.
+   */
+  async quote(amount = 1) {
+    const result = { success: false, rate: 0 };
+    try {
+      if (typeof amount !== 'number') throw new Error('amount must be number.');
+      const from = this.param.from?.toUpperCase(), to = this.param.to.toUpperCase();
+      if (typeof from !== 'string' || typeof to !== 'string') throw new Error('from and/or to are invalid.');
+
+      const url = `${API_URL}${from}-${to}`;
+
+      let response;
+      if (this.proxy) {
+        const axiosConfig = {};
+        if (this.proxy.protocol === 'http') {
+          axiosConfig.proxy = {
+            host: this.proxy.host,
+          }
+          if (this.proxy.port) axiosConfig.proxy.port = this.proxy.port;
+        } else if (this.proxy.protocol === 'https') {
+          const proxyUrl = `http://${this.proxy.host}${this.proxy.port ? `:${this.proxy.port}` : ''}`;
+          const agent = new HttpsProxyAgent(proxyUrl);
+          axiosConfig.httpsAgent = agent;
+          axiosConfig.proxy = false;
+        }
+        response = await axios.get(url, axiosConfig);
+      } else {
+        response = await axios.get(url);
+      }
+
+      const html = response.data;
+      const startIndex =
+        html.indexOf(
+          `data-source="${from}" data-target="${to}" data-last-price="`
+        ) +
+        `data-source="${from}" data-target="${to}" data-last-price="`.length;
+      const endIndex = html.indexOf('"', startIndex);
+      const rate = Number(html.substring(startIndex, endIndex));
+      if (isNaN(rate)) throw new Error('Failed to get the current finance.');
+
+      result.success = true;
+      result.rate = rate * amount;
+      return result;
+    } catch {
+      return result;
+    }
+  }
+}
+
+module.exports = Finance;

package/lib/config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  API_URL: 'https://www.google.com/finance/quote/'
+};

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "google-finance-quote",
+  "version": "1.0.0",
+  "description": "Node Google Finance API wrapper for free. No API key is required!",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/otoneko1102/google-finance-quote.git"
+  },
+  "keywords": [
+    "google",
+    "api",
+    "finance",
+    "exchange",
+    "rate",
+    "quote",
+    "wrapper",
+    "free",
+    "proxy"
+  ],
+  "author": "otoneko.",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/otoneko1102/google-finance-quote/issues"
+  },
+  "homepage": "https://github.com/otoneko1102/google-finance-quote#readme",
+  "dependencies": {
+    "axios": "^1.7.7",
+    "https-proxy-agent": "^7.0.5"
+  }
+}