crypto-price.js

crypto-price.js

crypto-price.js es un paquete Node.js que te permite obtener información sobre el precio de las criptomonedas en tiempo real utilizando la API de CoinGecko.

Instalación

Puedes instalar este paquete a través de npm utilizando el siguiente comando:

npm install crypto-price.js

Uso

Para comenzar a utilizar crypto-price.js, simplemente importa el paquete en tu proyecto y llama a las funciones disponibles. Aquí tienes un ejemplo de cómo obtener el precio de Bitcoin (BTC) en dólares estadounidenses (USD):

const cryptoPrice = require('crypto-price.js');

(async () => {
  try {
    const bitcoinPrice = await cryptoPrice.getCryptoPrice('bitcoin');
    console.log('Precio de Bitcoin en USD:', bitcoinPrice);
  } catch (error) {
    console.error(error);
  }
})();

Documentación

getCryptoPrice(coinId, property)

La función getCryptoPrice permite obtener un valor específico de una criptomoneda a partir de su identificador (coinId) y la propiedad (property) en el objeto JSON de la respuesta.

Parámetros

• coinId (string): El identificador de la criptomoneda que deseas consultar. Por ejemplo, "bitcoin" para Bitcoin.
• property (string): La propiedad en el objeto JSON de la respuesta que deseas obtener. Por ejemplo, "market_data.current_price.mxn" para obtener el precio en pesos mexicanos.

Ejemplo:

const cryptoPrice = require('crypto-price.js');

(async () => {
  try {
    const bitcoinMXNPrice = await cryptoPrice.getCryptoPrice('bitcoin', 'market_data.current_price.mxn');
    console.log('Precio de Bitcoin en MXN:', bitcoinMXNPrice);
  } catch (error) {
    console.error(error);
  }
})();

listTopCryptos(limit)

La función listTopCryptos permite listar las principales criptomonedas por capitalización de mercado. Puedes especificar el número máximo de criptomonedas que deseas listar utilizando el parámetro limit.

Parámetros

• limit (number, opcional): El número máximo de criptomonedas que deseas listar. El valor predeterminado es 10.

Ejemplo:

const cryptoPrice = require('crypto-price.js');

(async () => {
  try {
    const topCryptos = await cryptoPrice.listTopCryptos(20); // Listar las 20 principales criptomonedas
    console.log('Principales criptomonedas:', topCryptos);
  } catch (error) {
    console.error(error);
  }
})();

calculateValue(coin, quantity, currency)

La función calculateValue permite calcular el valor total de una cantidad específica de una criptomoneda en una moneda de referencia. Esta función toma tres parámetros:

• coin (string): El nombre de la criptomoneda que deseas calcular.
• quantity (number): La cantidad de la criptomoneda que deseas calcular.
• currency (string): La moneda de referencia en la que deseas calcular el valor. Esta moneda debe estar en minúsculas y puede incluir propiedades anidadas, separadas por puntos. Por ejemplo, "market_data.current_price.mxn" para obtener el precio en pesos mexicanos.

EJEMPLO

const cryptoPrice = require('crypto-price.js');

(async () => {
  try {
    const coin = "bitcoin";
    const quantity = 3;
    const currency = "market_data.current_price.mxn";

    const value = await cryptoPrice.calculateValue(coin, quantity, currency);
    console.log(`El valor de ${quantity} ${coin} en MXN es: ${value.toFixed(2)}`);
  } catch (error) {
    console.error(error);
  }
})();


# Changelog

### 6 de Septiembre (0.2.0 - 0.2.1)

#### 0.2.0
- Se añadio la función `calculateValue`.
- La documentación fue actualizada con los cambios correspondientes.

#### 0.2.1
- Correción de Bugs

### 5 de Septiembre (0.1.1 - 0.1.2)

#### 0.1.1
- Se añadio documentación (**README.md**)

#### 0.1.2
- Se corrigio algunas cosas.

### 4 de Septiembre (0.1.0)

- El npm fue creado y publicado.