metalpriceapi-ts

metalpriceapi-ts is the official Node.js TypeScript wrapper for MetalpriceAPI.com. This allows you to quickly integrate our metal price API and foreign exchange rate API into your application. Check https://metalpriceapi.com documentation for more information.

Installation

NPM

$ npm i metalpriceapi-ts

Usage

import MetalpriceAPI from 'metalpriceapi-ts';
const api = new MetalpriceAPI('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();

Link

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']);

Link

fetchHistorical(date, base, currencies)

• date <string> Required. Pass in a string with format YYYY-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('2024-02-05', 'USD', ['XAU', 'XAG', 'XPD', 'XPT']);

Link

convert(from, to, amount, date)

• from <string> Optional. Pass in a base currency, defaults to USD.
• to <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 format YYYY-MM-DD. Otherwise, it will use live exchange rate date if value not passed in.

await api.convert('USD', 'EUR', 100, '2024-02-05');

Link

timeframe(start_date, end_date, base, currencies)

• start_date <string> Required. Specify the start date of your timeframe using the format YYYY-MM-DD.
• end_date <string> Required. Specify the end date of your timeframe using the format YYYY-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('2024-02-05', '2024-02-06', 'USD', ['XAU', 'XAG', 'XPD', 'XPT']);

Link

change(start_date, end_date, base, currencies)

• start_date <string> Required. Specify the start date of your timeframe using the format YYYY-MM-DD.
• end_date <string> Required. Specify the end date of your timeframe using the format YYYY-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('2024-02-05', '2024-02-06', 'USD', ['XAU', 'XAG', 'XPD', 'XPT']);

Link

carat(base, date)

• base <string> Optional. Pass in a base currency, defaults to USD.
• date <string> Optional. Specify date to get Carat for specific date using format YYYY-MM-DD. If not specified, uses live rates.

await api.carat('USD', '2024-02-06');

Link

Official documentation

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.