1.0.0 • Published 10 years ago

monero-prices v1.0.0

Weekly downloads
3
License
MIT
Repository
github
Last release
10 years ago

monero-prices

Version (npm) Build Status Code Coverage Code Climate

Wrapper for the API methods of moneropric.es, written in JavaScript.

API Reference

monero-prices.get(currencyCode) ⇒ Promise.<(ExchangeRate|Array.<ExchangeRate>)>

Gets the current price of Monero compared to a specific currency or a list of currencies.

Kind: static method of monero-prices
Returns: Promise.<(ExchangeRate|Array.<ExchangeRate>)> - Current exchange rate(s) of the currency pair(s) specified.

ParamTypeDescription
currencyCodestring | Array.<string>Code of the currency/currencies to compare Monero's price with. If null, then every known currency will be compared.

monero-prices~ExchangeRate : Object

Represents the exchange rate of a currency pair involving Monero.

Kind: inner typedef of monero-prices
Properties

NameTypeDescription
fiatBasednumberFiat-based exchange rate of the currency pair.
xmrBasednumberMonero-based exchange rate of the currency pair.
codestringCode of the currency of which the value is compared to Monero's value.
namestringName of the currency of which the value is compared to Monero's value.