kripod / monero-prices.js

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

monero-prices

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

API Reference

• monero-prices
  • static
    • .get(currencyCode) ⇒ Promise.<(ExchangeRate|Array.<ExchangeRate>)>
  • inner
    • ~ExchangeRate : Object

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.

Param	Type	Description
currencyCode	string | 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

Name	Type	Description
fiatBased	number	Fiat-based exchange rate of the currency pair.
xmrBased	number	Monero-based exchange rate of the currency pair.
code	string	Code of the currency of which the value is compared to Monero's value.
name	string	Name of the currency of which the value is compared to Monero's value.