google-finance-quote
v2.0.3
Published
Node Google Finance API wrapper for free. No API key is required!
Downloads
77
Maintainers
Readme
google-finance-quote
Node Google Finance API wrapper for free. No API key is required!
Note: This results may vary by up to 20 minutes.
Usage
Get Started
const { Finance, symbols } = require("google-finance-quote");
console.log(symbols); // Returns available symbols.
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
Finance({ from?:string, to?:string, proxy?:object })
Functions
.setFrom(from: string) Set the parameter of from.
.setTo(to: string) Set the parameter of to.
.getParam(): object Returns the current param.
.quote(amount?: number): Promise<{ success: boolean, rate: number }> 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.