README
metalpriceapi-nodejs
metalpriceapi-nodejs is the official Node.js wrapper for MetalpriceAPI. This allows you to quickly integrate our API into your application.
Installation
NPM
$ npm i metalpriceapi-nodejs
Usage
const api = require('metalpriceapi-nodejs');
api.setAPIKey('SET_YOUR_API_KEY_HERE');
await api.fetchLive('USD', ['XAU', 'XAG', 'XPD', 'XPT']);
Documentation
setAPIKey(apiKey)
apiKey
<string> API Key
In order to use this library, you must first call this function with an API key.
api.setAPIKey('SET_YOUR_API_KEY_HERE');
fetchSymbols()
await api.fetchSymbols();
fetchLive(base, currencies)
base
<string> Optional. Pass in a base currency, defaults to USD.currencies
<Array<string>> Optional. Pass in an array of currencies to return values for.
await api.fetchLive('USD', ['XAU', 'XAG', 'XPD', 'XPT']);
fetchHistorical(date, base, currencies)
date
<string> Required. Pass in a string with formatYYYY-MM-DD
base
<string> Optional. Pass in a base currency, defaults to USD.currencies
<Array<string>> Optional. Pass in an array of currencies to return values for.
await api.fetchHistorical('2021-04-05', 'USD', ['XAU', 'XAG', 'XPD', 'XPT']);
convert(base, currency, amount, date)
base
<string> Optional. Pass in a base currency, defaults to USD.currency
<string> Required. Specify currency you would like to convert to.amount
<number> Required. The amount to convert.date
<string> Optional. Specify date to use historical midpoint value for conversion with formatYYYY-MM-DD
. Otherwise, it will use live exchange rate date if value not passed in.
await api.convert('USD', 'EUR', 100, '2021-04-05');
timeframe(start_date, end_date, base, currencies)
start_date
<string> Required. Specify the start date of your timeframe using the formatYYYY-MM-DD
.end_date
<string> Required. Specify the end date of your timeframe using the formatYYYY-MM-DD
.base
<string> Optional. Pass in a base currency, defaults to USD.currencies
<Array<string>> Optional. Pass in an array of currencies to return values for.
await api.timeframe('2021-04-05', '2021-04-06', 'USD', ['XAU', 'XAG', 'XPD', 'XPT']);
change(start_date, end_date, base, currencies)
start_date
<string> Required. Specify the start date of your timeframe using the formatYYYY-MM-DD
.end_date
<string> Required. Specify the end date of your timeframe using the formatYYYY-MM-DD
.base
<string> Optional. Pass in a base currency, defaults to USD.currencies
<Array<string>> Optional. Pass in an array of currencies to return values for.
await api.change('2021-04-05', '2021-04-06', 'USD', ['XAU', 'XAG', 'XPD', 'XPT']);
FAQ
How do I get an API Key?
Free API Keys are available here.
I want more information
Checkout our FAQs here.
Support
For support, get in touch using this form.