metalpriceapi

metalpriceapi is the official Ruby 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

Add to Gemfile.

gem 'metalpriceapi'

Usage

api_key = 'SET_YOUR_API_KEY_HERE'
client = MetalpriceAPI::Client.new(api_key: api_key)

---

Documentation

fetchSymbols()

client.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.

client.fetchLive(base='USD', currencies=['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.

client.fetchHistorical(date='2021-04-05', base='USD', currencies=['XAU', 'XAG', 'XPD', 'XPT'])

Link

---

convert(from_currency, to_currency, amount, date)

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

client.convert(from_currency='USD', to_currency='EUR', amount=100, date='2021-04-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.

client.timeframe(start_date='2021-04-05', end_date='2021-04-06', base='USD', currencies=['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.

client.change(start_date='2021-04-05', end_date='2021-04-06', base='USD', currencies=['XAU', 'XAG', 'XPD', 'XPT'])

Link

carat(start_date, end_date, base, currencies)

• 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.

client.carat(base='USD', date='2021-04-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.