kencrypto-app
v1.0.0
Published
O **KenCrypto** é uma biblioteca com foco em criptomoedas, onde é possível verificar a cotação atual das criptomoedas e também fazer a conversão de valores a partir de uma integração com a _[CoinMarketCap](https://coinmarketcap.com/api/)_.
Downloads
2
Readme
KenCrypto
O KenCrypto é uma biblioteca com foco em criptomoedas, onde é possível verificar a cotação atual das criptomoedas e também fazer a conversão de valores a partir de uma integração com a CoinMarketCap.
Instalação
Para instalar basta utilizar o comando:
$ yarn add kencrypto-app
Utilização
Obs: Para a utilização da biblioteca, será necessário informar sua api_key, que pode ser obtida gratuitamente após o cadastro no site da CoinMarketCap.
Basta importar a biblioteca em seu projeto da seguinte forma:
import { KenCrypto } from "kencrypto-app";
Depois basta instanciar informando sua api_key obtida através da plataforma da CoinMarketCap :
const kenCrypto = new KenCrypto("insira-sua-chave-como-string");
Métodos
A biblioteca possúi dois métodos atualmente:
- quotes()
- conversion()
Quotes:
É necessário passar um array de strings contendo as siglas das criptomoedas que deseja obter a cotação. A resposta do método retorna uma promisse que pode ser tratada pelo método .then() .
Obs: É possível ser passado mais de uma sigla na lista, porém no plano free da CoinMarketCap só é possível consultar uma moeda por vez.
kenCrypto.quotes(["BTC"]).then((res) => {
//trabalhe sua lógica aqui.
console.log(res);
});
Conversion:
É necessário passar como parâmetros a sigla da criptomoeda para a consulta, o valor a ser convertido e uma lista de moedas destino para a conversão. A resposta do método retorna uma promisse que pode ser tratada pelo método .then() .
Obs: É possível ser passado mais de uma sigla na lista, porém no plano free da CoinMarketCap só é possível converter uma moeda por vez.
kenCrypto.conversion("BTC", 0.102, ["ETH"]).then((res) => {
//trabalhe sua lógica aqui.
console.log(res);
});
Tecnologias Utilizadas
- Axios
- Typescript
Licença
MIT